跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

更新日志

Cloudflare 的最新更新与改进。

返回所有文章

Workers 追踪:新增 spanContext()、setStatus() 和 updateName() API

Workers 中的自定义 span 现在额外支持 OpenTelemetry span API 中的三个方法。

  • span.spanContext() 返回 span 的 traceId、spanId 和 traceFlags。这些 ID 与 Workers Observability 和导出的追踪数据中的 trace ID 和 span ID 一致,因此您可以记录它们或将其返回给客户端,以便将请求与其追踪关联起来。
  • span.setStatus(status) 将 span 状态设置为 "unset"、"ok" 或 "error",并可为错误提供可选消息。span 状态会包含在导出到 OpenTelemetry 目标的追踪数据中。Workers Observability 仪表板目前尚不显示该状态。
  • span.updateName(name) 在 span 启动后对其重命名,例如在您得知请求匹配了哪个路由之后。您也可以重命名由 tracing.getActiveSpan() 返回的调用根 span。
src/index.jsjs
import { tracing } from "cloudflare:workers";

export default {
	async fetch(request, env) {
		const root = tracing.getActiveSpan();
		const route = router.match(request);
		root?.updateName(`${request.method} ${route.pattern}`);

		return tracing.startActiveSpan("handle", async (span) => {
			try {
				const response = await route.handler(request, env);
				span.setStatus({ code: "ok" });
				return response;
			} catch (err) {
				span.recordException(err);
				span.setStatus({ code: "error", message: "Route handler failed" });
				return Response.json(
					{ error: "Internal error", traceId: root?.spanContext().traceId },
					{ status: 500 },
				);
			} finally {
				span.end();
			}
		});
	},
};
src/index.tsts
import { tracing } from "cloudflare:workers";

export default {
	async fetch(request: Request, env: Env): Promise<Response> {
		const root = tracing.getActiveSpan();
		const route = router.match(request);
		root?.updateName(`${request.method} ${route.pattern}`);

		return tracing.startActiveSpan("handle", async (span) => {
			try {
				const response = await route.handler(request, env);
				span.setStatus({ code: "ok" });
				return response;
			} catch (err) {
				span.recordException(err as Error);
				span.setStatus({ code: "error", message: "Route handler failed" });
				return Response.json(
					{ error: "Internal error", traceId: root?.spanContext().traceId },
					{ status: 500 },
				);
			} finally {
				span.end();
			}
		});
	},
};

有关详细信息,请参阅自定义 span 文档。