基于OpenTelemetry实现可观测性-Part 3 导出器

gdansk-gab9c3fd6d_640.jpg

在上一篇博客中,我谈到了如何用OpenTelemetry收集遥测数据,基于使用特定语言的API。这包括手工探测和自动探测。这很好!......但收集遥测数据只是解决方案的一部分。你需要把这些遥测数据传送到某个地方,并给它添加一些元数据。这就是SDK开始发挥作用的地方。

追踪器提供者(Tracer provider)

SDK中关键部分就是追踪器提供者。追踪器负责将从API中得到的遥测数据与剩下的环节进行打通。在Go语言中,TracerProvider是只有一个Tracer方法的接口,签名如下:

Tracer(instrumentationName string, opts ...TracerOption) Tracer

Tracer方法返回一个只支持实现Tracer接口的对象,Tracer接口有一个Start方法,我们已经使用它进行探测:

Start(ctx context.Context, spanName string, opts ...SpanStartOption) (context.Context, Span)

这是我们在调用创建跨度时使用的跟踪器提供程序:

import "go.opentelemetry.io/otel" 
// ... 
ctx, span := otel.Tracer(telemetry.TelemetryLibrary).Start(ctx, "get_product_price")

otel.Tracer 查找全局跟踪器提供程序以启动 Tracer。正如您所看到的,是跟踪器提供程序为我们提供了这种连接。但是,在使用跟踪器提供程序之前,您需要先设置它。

注: 我在上面和之前的博文中提到了 "全局 "追踪器提供者的想法。利用全局追踪器提供者是一个更容易处理的方法,因为当我们调用otel.Tracer时,API会对全局追踪器提供者进行查找。不过,如果这不能满足你的要求,你可以自由地将追踪器提供者传递给消费者,这样就可以直接引用它,而不是全局查询。

资源(Resource)

追踪器提供商处理的其中一些元数据是资源。这是对产生遥测数据的进程或服务的描述。可以把它看作是描述服务本身的元数据。下面是我为购物车服务创建的资源对象:

import (
    "go.opentelemetry.io/otel/sdk/resource"
    semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
)

// ...

res, err := resource.New(
    ctx,
    resource.WithAttributes(
        semconv.ServiceNameKey.String("cart"),
        semconv.ServiceVersionKey.String("v1.0.0"),
    ),
)

服务资源的关键部分之一是被添加的属性。OpenTelemetry为资源属性键和值定义了一套标准,你可以在OTel的资源语义约定文档中找到它们。例如,你通常希望至少定义服务名称和版本信息,正如你在那个例子中看到的那样。但是,您可以指定的内容还有很多,这取决于资源本身。它是否在云中运行?语义惯例为不同的云提供商定义了不同的属性。在Kubernetes中运行?有SemConv指南涵盖Kubernetes中的资源

对于我的服务,跨度中将会有以下资源数据:

Resource labels: -> service.name: STRING(cart) -> service.version: STRING(v1.0.0)

导出器(Exporter)

现在我们已经创建了资源对象,我们需要为遥测数据定义一个目的地。目的的可以是大量导出器,但在我的例子中,我将使用 OpenTelemetry Collector(在下一篇博文中详细介绍),并且它可以具有 HTTP 或 gRPC 连接。我选择使用 gRPC 并设置连接和 OTLP 导出器:

import (
    "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
    "google.golang.org/grpc"
)

// ...

hostIP := os.Getenv("HOST_IP")
if hostIP == "" {
    return nil, fmt.Errorf("unexpected no host IP address for receiver")
}
receiverAddress := fmt.Sprintf("%s:%d", hostIP, 4317)

conn, err := grpc.DialContext(
    ctx,
    receiverAddress,
    grpc.WithTransportCredentials(insecure.NewCredentials()),
    grpc.WithBlock(),
)
if err != nil {
    return nil, fmt.Errorf("error creating client connection to collector: %w", err)
}

otlpTraceExporter, err := otlptracegrpc.New(
    ctx,
    otlptracegrpc.WithGRPCConn(conn),
)

_Note: 在我的例子中,因为这是一个演示应用程序,我使用的是与收集器的不安全连接,但在生产中你应该使用具有正确的身份认证的连接

关于导出器,有很多种类可供你使用,例如: 控制台输出(从stdout查看),Jaeger(直接向那里发送数据),Prometheus,还有其他的。使用OTLP输出器并将数据发送到OTel收集器的好处是,你可以分叉数据,处理它,并有更多的控制权(我们将在下一篇文章中看到)。由于这种灵活性,这个例子将只使用OTLP输出器,我们可以在采集器中随意处理遥测数据(输出到stdout,发送至Jaeger等)。在下一篇文章中会有更多这方面的内容!

集成所有内容

现在我们有了资源(产生遥测数据的东西)和输出者(遥测数据的去处),我们通过追踪器提供者把它们放在一起:

tp := trace.NewTracerProvider(
    trace.WithSampler(trace.AlwaysSample()),
    trace.WithResource(res),
    trace.WithSpanProcessor(trace.NewBatchSpanProcessor(otlpTraceExporter)),
)

当追踪器提供者被创建时,我们需要将其设置为全局追踪器提供者:

import (
    "go.opentelemetry.io/otel"
)

// ...

otel.SetTracerProvider(tp)

接下来我们需要设置传播(propagation)。在后续博文中,我将深入讨论传播和baggage,但现在只需要知道传播是我们跨多个服务和进程中使用 OTel 跟踪的方式。这就是将“分布式”置于“分布式追踪”中的原因。

import (
    "go.opentelemetry.io/otel/propagation"
)

// ...

otel.SetTextMapPropagator(
    propagation.NewCompositeTextMapPropagator(
        propagation.TraceContext{},
        propagation.Baggage{}),
)

最后,我们需要调用 TracerProvider.Shutdown 来清理和关闭跨度处理器(在我们的例子中,我们使用的是批处理跨度处理器,它把已完成的跨度发送给导出器):

defer func() {
    if err := tp.Shutdown(context.Background()); err != nil {
        fmt.Printf("Error shutting down tracer provider: %v", err)
        os.Exit(1)
    }
}()

注: 我们不只是运行 defer tp.Shutdown(context.Background()) ,因为我们还需要进行错误处理。

Python追踪器提供者(Python tracer provider)

本案例中大部分服务使用Go编写,但是使用Python写了一个服务(价格服务)。为了完整性,以下代码是使用Python创建一个类似的追踪器提供者:

from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.resources import Resource, SERVICE_NAME, SERVICE_VERSION
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor

resource = Resource(attributes={
    SERVICE_NAME: "price",
    SERVICE_VERSION: "v1.0.0"
})
tracer_provider = TracerProvider(resource=resource)

host_ip = os.environ.get("HOST_IP")
if host_ip is None:
    print("Must pass in environment var HOST_IP")
    sys.exit(1)

tracer_provider.add_span_processor(span_processor=BatchSpanProcessor(
    OTLPSpanExporter(endpoint=f"{host_ip}:4317", insecure=True)
))
trace.set_tracer_provider(tracer_provider)

以上的资源、跨度处理器以及设置全局追踪器提供者的实现都与Go语言的类似。

总结

这很棒!现在我们已经获取了 API 生成的遥测数据,并将其从被观测进程传送到导出器,并向其添加了一些元数据(资源)!接下来,我们将了解如何使用 OpenTelemetry Collector 处理这些数据。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,200评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,526评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,321评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,601评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,446评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,345评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,753评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,405评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,712评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,743评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,529评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,369评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,770评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,026评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,301评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,732评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,927评论 2 336

推荐阅读更多精彩内容