当前位置:首页 > 技术 > 正文内容

基于 OpenTelemetry 的 React 应用全链路追踪实战:从埋点到 SigNoz 可视化

访客 技术 2026年7月25日 2

在云原生架构中,前端应用的性能监控与故障排查往往面临跨服务追踪的难题。OpenTelemetry 作为 CNCF 孵化的标准化观测方案,为 React 应用提供了从浏览器到后端服务的完整链路追踪能力。本文将演示如何在 Kubernetes 环境中部署 SigNoz 作为观测后端,并完成 React 应用的埋点接入。

观测方案架构概览

OpenTelemetry 通过统一的 API 层解耦了数据采集与后端存储。React 应用借助 @opentelemetry/sdk-trace-web 生成符合 OTLP 格式的链路数据,经由 HTTP 协议上报至 SigNoz 的采集端点,最终在可视化界面呈现调用链路与性能指标。

SigNoz 区别于传统 ELK 方案的核心优势在于原生支持 OpenTelemetry 协议,无需额外的格式转换层,降低了架构复杂度与数据延迟。

Kubernetes 环境部署 SigNoz

以下基于 DigitalOcean 托管集群(版本 1.24.13)完成一键化部署:

helm repo add signoz https://charts.signoz.io

helm upgrade --install observability signoz/signoz \
  --namespace monitoring --create-namespace \
  --set otelCollector.config.receivers.otlp.protocols.http.cors.allowed_origins='https://demo.react-observability.io' \
  --set otelCollector.config.receivers.otlp.protocols.http.include_metadata=true

关键配置说明:cors.allowed_origins 需匹配 React 应用的访问域名,避免浏览器跨域拦截。

验证服务状态:

kubectl get pods -n monitoring -l app.kubernetes.io/name=signoz

NAME                                                READY   STATUS
signoz-otel-collector-7d4f9b2c8a-3k5p9              1/1     Running
signoz-query-service-0                              1/1     Running
signoz-frontend-9c7e5d2f1a-8m4n2                    1/1     Running

配置公网采集入口

使用 Traefik 暴露 OTLP HTTP 接收端(默认端口 4318):

apiVersion: traefik.containo.us/v1alpha1
kind: IngressRoute
metadata:
  name: otlp-ingest
  namespace: monitoring
spec:
  entryPoints:
    - websecure
  routes:
    - match: Host(`telemetry.react-observability.io`)
      kind: Rule
      services:
        - name: signoz-otel-collector
          port: 4318

React 应用埋点实现

创建追踪初始化模块 src/telemetry/tracer.ts

import { 
  context, 
  trace, 
  Span, 
  SpanStatusCode,
  Tracer 
} from '@opentelemetry/api';
import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
import { Resource } from '@opentelemetry/resources';
import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
import { ZoneContextManager } from '@opentelemetry/context-zone';
import { FetchInstrumentation } from '@opentelemetry/instrumentation-fetch';
import { registerInstrumentations } from '@opentelemetry/instrumentation';

const SERVICE_IDENTIFIER = 'react-dashboard-ui';

const resourceAttributes = new Resource({
  'service.name': SERVICE_IDENTIFIER,
  'deployment.environment': 'production'
});

const traceProvider = new WebTracerProvider({
  resource: resourceAttributes
});

const exporterConfig = {
  url: 'https://telemetry.react-observability.io/v1/traces',
  timeoutMillis: 30000
};

const spanExporter = new OTLPTraceExporter(exporterConfig);

traceProvider.addSpanProcessor(new BatchSpanProcessor(spanExporter));
traceProvider.register({ contextManager: new ZoneContextManager() });

const rootTracer = traceProvider.getTracer(SERVICE_IDENTIFIER);

// 用于服务端渲染场景下的上下文透传
let propagatedContext: Span | null = null;

(window as any).establishTraceContext = (
  traceId: string,
  spanId: string,
  flags: number
) => {
  propagatedContext = rootTracer.startSpan('server-boundary');
  const ctx = propagatedContext.spanContext();
  Object.assign(ctx, { traceId, spanId, traceFlags: flags });
};

registerInstrumentations({
  instrumentations: [
    new FetchInstrumentation({
      propagateTraceHeaderCorsUrls: [new RegExp('.*?')],
      clearTimingResources: true,
      applyCustomAttributesOnSpan: (
        activeSpan: Span,
        request: RequestInit,
        response: Response | Error
      ) => {
        const attrs = (activeSpan as any).attributes || {};
        
        if (attrs.component === 'fetch') {
          activeSpan.updateName(`${attrs['http.method']} ${attrs['http.url']}`);
        }
        
        if (response instanceof Error) {
          activeSpan.setStatus({
            code: SpanStatusCode.ERROR,
            message: response.message
          });
          activeSpan.recordException(response);
        }
      }
    })
  ]
});

export function wrapWithTrace<T extends (...args: unknown[]) => unknown>(
  operationName: string,
  targetFn: T
): ReturnType<T> {
  let currentSpan: Span;
  
  if (propagatedContext) {
    const parentCtx = trace.setSpan(context.active(), propagatedContext);
    currentSpan = rootTracer.startSpan(operationName, undefined, parentCtx);
    propagatedContext = null;
  } else {
    currentSpan = rootTracer.startSpan(operationName);
  }

  return context.with(
    trace.setSpan(context.active(), currentSpan),
    () => {
      try {
        const output = targetFn() as ReturnType<T>;
        currentSpan.end();
        return output;
      } catch (thrownError) {
        currentSpan.setStatus({ code: SpanStatusCode.ERROR });
        currentSpan.end();
        throw thrownError;
      }
    }
  );
}

组件层集成示例

封装可复用的追踪按钮组件 src/components/TrackedAction/index.tsx

import { Button, ButtonProps } from '@mui/material';
import { wrapWithTrace } from '../../telemetry/tracer';

interface TrackedButtonProps extends Omit<ButtonProps, 'onClick'> {
  actionName: string;
  handler: () => void;
}

export const TrackedButton = ({
  actionName,
  handler,
  children,
  ...restProps
}: TrackedButtonProps) => {
  const instrumentedHandler = () => 
    wrapWithTrace(`UI interaction: ${actionName}`, handler);

  return (
    <Button {...restProps} onClick={instrumentedHandler}>
      {children}
    </Button>
  );
};

验证端到端链路

访问演示站点触发 Fetch Links 操作后,SigNoz 面板将呈现以下观测数据:

  • 服务依赖拓扑图,展示前端到后端 API 的调用关系
  • P95/P99 延迟分位数,识别长尾请求
  • 错误率趋势与异常堆栈关联
  • TraceID 贯穿的完整请求生命周期

通过对比不同时间段的火焰图,可快速定位性能退化节点,例如某次部署后数据库查询层耗时突增的场景。

进阶优化方向

当前实现采用 BatchSpanProcessor 降低网络开销,生产环境建议进一步配置:

  • 采样策略:基于尾延迟的概率采样或特定路由的强制采样
  • 资源属性:注入 Git 提交版本、构建时间戳等部署元信息
  • 错误边界:结合 React Error Boundary 实现组件级异常捕获与上报
  • RUM 指标:扩展 WebVitals 采集,关联 LCP/FID 与业务链路

SigNoz 的查询引擎支持 PromQL 风格的指标聚合,可通过自定义仪表盘构建业务专属的可观测视图。

标签: OpenTelemetry

相关文章

Linux crontab 详解

1) crontab 是什么cron 是 Linux 的定时任务守护进程;crontab 是用来编辑/查看“按时间周期执行命令”的表(cron table)。常见两类:用户 crontab:每个用户一份(crontab -e 编辑)系统级 crontab / cron.d:可指定执行用户(/etc/crontab、/etc/cron.d/*)2) crontab 时间...

富文本里可以允许的 HTML 属性

一、所有标签默认允许的安全属性(极少)class        (可选)id           (通常建议禁用)title️ 注意:id 容易被滥用做锚点注入,很多系统直接禁用class 允许的话最好只允许固定前缀(如 editor-*)二、a 标签允许属性<a href="" t...

Mac 安装 Node.js 指南

方法一:通过官网安装包(最简单,适合初学者)如果你只是想快速安装并开始使用,这是最直接的方法。访问 Node.js 官网。页面会显示两个版本:LTS (Recommended For Most Users):长期支持版,最稳定。建议选这个。Current:最新特性版,包含最新功能但可能不够稳定。下载 .pkg 安装包并运行。按照安装向导点击“下一步”即可完成。方法二:使用 Homebrew 安装(...

Dom\HTML_NO_DEFAULT_NS 的副作用:自动加闭合标签

在使用Dom\HTMLDocument时,Dom\HTML_NO_DEFAULT_NS 将禁止在解析过程中设置元素的命名空间, 此设置是为了与DOMDocument向后兼容而存在的。当使用它时,已知的一个副作用就是:自动加闭合标签例如 </img> 为什么会这样?当你使用:Dom\HTML_NO_DEFAULT_NS文档会变成 无命名空间模式,此时内部更接近 XML...

Laravel 事件和监听器创建

在 Laravel 中,使用 Artisan 命令创建 Events(事件) 和 Listeners(监听器) 是非常高效的。你可以通过以下几种方式来实现:1. 手动创建单个 Event如果你只想创建一个事件类,可以使用 make:event 命令:Bashphp artisan make:event UserRegistered执行后,文件将生成在 app/Even...

自定义域名解析神器 dnsmasq

什么是 dnsmasq?dnsmasq 是一个轻量级、功能强大的网络服务工具,专为小型和中等规模网络设计。它是一个综合的网络基础设施解决方案[1]。dnsmasq 能做什么?功能说明应用场景DNS 转发与缓存将 DNS 查询转发到上游服务器(ISP、Google DNS 等),并在本地缓存结果加快 DNS 查询速度,减少外部 DNS 流量本地 DNS解析本地网络设备的主机名,无需编辑&n...

发表评论

访客

◎欢迎参与讨论,请在这里发表您的看法和观点。