试用 Deno 2.2 中实现的 OpenTelemetry 集成

flowchart LR
  OC[Otel Collector]
  PM[Prometheus Metric<br>Database]
  TT[Tempo<br>Trace Database]
  LL[Loki<br>Logs Database]
  G[Grafana]
  OC --> PM
  OC --> TT
  OC --> LL
  G -.-> PM
  G -.-> TT
  G -.-> LL

使用 docker run 可以轻松启动。

docker run --name lgtm -p 3000:3000 -p 4317:4317 -p 4318:4318 --rm -ti \
    -v "$PWD"/lgtm/grafana:/data/grafana \
    -v "$PWD"/lgtm/prometheus:/data/prometheus \
    -v "$PWD"/lgtm/loki:/data/loki \
    -e GF_PATHS_DATA=/data/grafana \
    docker.io/grafana/otel-lgtm:0.8.1

如下所示，将启动 gRPC 与 HTTP 的端点以及 Grafana。

The OpenTelemetry collector and the Grafana LGTM stack are up and running. (created /tmp/ready)
Open ports:
 - 4317: OpenTelemetry GRPC endpoint
 - 4318: OpenTelemetry HTTP endpoint
 - 3000: Grafana. User: admin, password: admin

在多个服务协同中试用追踪：服务实现

如下，以 REST API 服务 (A) 再调用另一 REST API 服务 (B) 的构成来尝试追踪。

flowchart LR
  client --> SA[Service A<br>port:3001] --> SB[Service B<br>port:9000]

Service A 的代码。在端口 3001 启动，并将调用 Service B 的结果返回给客户端。

service_a.ts

Deno.serve({ port: 3001 }, async (req) => {
  console.log("Service A Received request for", req.url);
  const res = await fetch("http://localhost:9000");
  const text = await res.text();
  console.log("Service A Received response from Service B", text);
  return new Response(`Service A got: ${text}`);
});

Service B 的代码。在端口 9000 启动，并向客户端（此处为 Service A）返回简单消息。

service_b.ts

Deno.serve({ port: 9000 }, (req) => {
  console.log("Service B Received request for", req.url);
  return new Response("Hello world");
});

启动 Service A。通过将环境变量 OTEL_DENO 设为 true 来启用 Otel，并通过 OTEL_SERVICE_NAME 指定服务名来使追踪结果更易于查看。这里将其服务名设置为 svc-a。

OTEL_DENO=true OTEL_SERVICE_NAME=svc-a deno run --unstable-otel --allow-net service_a.ts

Information

Deno 的 OpenTelemetry 集成 API 仍处于不稳定状态，未来可能会有所改变，因此需要指定 --unstable-otel 标志。

同样地，也启动 Service B。服务名设置为 svc-b。

OTEL_DENO=true OTEL_SERVICE_NAME=svc-b deno run --unstable-otel --allow-net service_b.ts

在多个服务协同中试用追踪：在 Grafana 中可视化

到此已完成服务协同的准备，接下来我们调用 Service A 并在 Grafana 中观察追踪情况。

访问 localhost:3000 将显示 Grafana 的界面。

从菜单中选择 Explore。默认数据源为 Prometheus，因此请选择 Tempo。

将显示 Tempo 的查询界面。

使用 curl 调用 Service A。

curl - http://localhost:3001

点击刷新按钮后，在 Tempo 的查询界面中显示了调用的 Trace ID、时间、服务名、HTTP 方法及响应时间。

Trace ID 似乎是由 Deno 的 Otel Exporter 端分配的。点击此 Trace ID 后，将显示追踪信息的详细内容。执行顺序显示为 svc-a → svc-b。

展开 Node graph 后，可视化调用关系。

在查询界面的 Service Graph 中，服务之间的关系也得到了可视化。

Trace ID 好像被嵌入到了请求头中。在 Service B 中添加了显示请求头的代码。

service_b.ts

Deno.serve({ port: 9000}, (req) => {
  // 显示请求头
  for (const [key, value] of req.headers.entries()) {
    console.log(key, value);
  }
  console.log("Service B Received request for", req.url);
  return new Response("Hello world");
});

Trace ID 是以键 traceparent 设置的。

accept */*
accept-encoding gzip,br
accept-language *
host localhost:9000
traceparent 00-34ea2fccfa0ce81bc8855043682b2810-895a8a6b4e02df52-01
user-agent Deno/2.2.8

看起来只需启用 Otel 而无需改动应用代码，就可以实现分布式追踪了呢。