开放遥测跨度未显示在 GCP Cloud Trace 中

Question

我正在 Google Cloud Platform 的 Cloud Run 中检测 Node.js 服务。

我遇到了自定义跨度未显示在跟踪中的问题。

跨度（您在 GCP 中免费获得）显示正确嵌套 - 如果没有配置，它们不会自动嵌套，这表明下面的配置正在工作：

我知道跟踪正在工作，因为 HTTP/ TCP tracing.ts：

import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import {
  SimpleSpanProcessor,
} from "@opentelemetry/sdk-trace-base";
import { TraceExporter } from "@google-cloud/opentelemetry-cloud-trace-exporter";
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
import { registerInstrumentations } from "@opentelemetry/instrumentation";
import { ExpressInstrumentation } from "@opentelemetry/instrumentation-express";
import * as opentelemetry from "@opentelemetry/api";
import { AsyncHooksContextManager } from "@opentelemetry/context-async-hooks";
import { SemanticResourceAttributes } from "@opentelemetry/semantic-conventions";
import { Resource } from "@opentelemetry/resources"

export const provider = new NodeTracerProvider({
  resource: new Resource({
    [SemanticResourceAttributes.SERVICE_NAME]: "my-service-name",
  })
});

// this *should* work automatically in GCP??
provider.addSpanProcessor(new SimpleSpanProcessor(new TraceExporter({
  resourceFilter: /^service\./
})));

provider.register();

opentelemetry.trace.setGlobalTracerProvider(provider);

const contextManager = new AsyncHooksContextManager();
contextManager.enable();
opentelemetry.context.setGlobalContextManager(contextManager);

export const tracer = opentelemetry.trace.getTracer("basic");

// this works (spans are correctly associated with parents)
registerInstrumentations({
  instrumentations: [
    getNodeAutoInstrumentations({
      "@opentelemetry/instrumentation-http": {},
      "@opentelemetry/instrumentation-express": {},
    }),
  ],
});

不显示的跨度是那些在代码中发出的跨度，如以下经过编辑的生产代码：

import { tracer } from "../tracing";

// ...

export const doWork = async (
  req: Request,
  res: Response
) => {

  // ... but this does *NOT* work: these spans appear nowhere
  // start span
  const span = tracer.startSpan("doWork");
  const ctx = opentelemetry.trace.setSpan(opentelemetry.context.active(), span);
  opentelemetry.propagation.extract(ctx, req.headers);

  try {
    // ... do work here with ctx to emit child spans

    res.status(200).send("ok");
  } catch (e) {
    res.status(500).send("error");
  }

  span.end();
};

我不清楚为什么这些跨度没有显示在任何地方。

部署 Cloud Run 实例的服务帐户具有 roles/cloudtrace.agent 角色：

- members:
  - serviceAccount:<my service account name>@<project id>.iam.gserviceaccount.com
  role: roles/cloudtrace.agent    

我不确定是否需要添加其他权限（或者可能需要将它们添加到哪个实体） 。

到目前为止，我已经尝试

• 使用 Open-Telemetry OTLPTraceExporter进行部署，使用或不使用 Provider 配置（没有区别），
• 导出 GCP 中的跨度（仍然没有显示任何内容）
• 以使用 Stackdriver trace-agent code> （与 webpack 不兼容）
• 使用 OTLPTraceExporter 和 Open-Telemetry 收集器在本地运行所有这些（一切都按预期工作 - 跟踪所有显示）
• 使用GCP 中的 ConsoleSpanExporter （跨度在日志中正确显示）

我真的很茫然。

Answer 1

根据 GCP 文档中的检查，仅限 Google Compute Engine和 GKE 均受此服务支持。

不过，您可以参考 Github 中的 Cloud Run 支持，如果您正在 Cloud Run 和 Stackoverflow 上运行 OpenTelemetry 讨论。

Answer 2

对我来说，这是几件事的结合：

使用 BatchSpanProcessor 对我来说是成功的，即使没有正确调用 shutdown 也是如此。

即，像这样：

 provider.addSpanProcessor(new BatchSpanProcessor(new TraceExporter()));

但是，并非所有跨度都会在 GCP 上进行采样，因此我需要在 NodeTracerProvider 中添加一个 AlwaysOnSampler：

export const provider = new NodeTracerProvider({
  sampler: new AlwaysOnSampler(), //https://github.com/open-telemetry/opentelemetry-js/issues/3057
  resource: new Resource({
    [SemanticResourceAttributes.SERVICE_NAME]: processName,
  }),
});

我目前不确定为什么所有在本地运行时会对跟踪进行采样，但在 GCP 上运行时仅对一部分进行采样。