#OpenTelemetry 可观测性

// src/plugins/otel.ts
import { opentelemetryPlugin } from "vextjs-opentelemetry/vextjs";
export default opentelemetryPlugin({ serviceName: "my-app" });

// src/plugins/otel.ts
import { opentelemetryPlugin } from "vextjs-opentelemetry/vextjs";

export default opentelemetryPlugin({ serviceName: "my-app" });

// src/plugins/otel.ts
export default opentelemetryPlugin({
  serviceName: "my-app",
  otlpEndpoint: "http://localhost:4318",
});

import express from "express";
import { createExpressMiddleware } from "vextjs-opentelemetry/express";
import { getOtelStatus } from "vextjs-opentelemetry";

const app = express();

app.use(createExpressMiddleware({
  serviceName: "my-express-app",
  tracing: {
    ignorePaths: ["/health", "/_otel/status"],
    spanNameResolver: (ctx) => `${ctx.method} ${ctx.route ?? ctx.path}`,
  },
  metrics: {
    customLabels: (ctx) => ({ "http.path": ctx.route ?? ctx.path }),
  },
}));

app.get("/_otel/status", (_req, res) => res.json(getOtelStatus()));

import Koa from "koa";
import { createKoaMiddleware } from "vextjs-opentelemetry/koa";
import { getOtelStatus } from "vextjs-opentelemetry";

const app = new Koa();

app.use(createKoaMiddleware({
  serviceName: "my-koa-app",
  tracing: {
    ignorePaths: ["/health", "/_otel/status"],
    spanNameResolver: (ctx) => `${ctx.method} ${ctx.route ?? ctx.path}`,
  },
}));

app.use(async (ctx, next) => {
  if (ctx.path === "/_otel/status") { ctx.body = getOtelStatus(); return; }
  await next();
});

import { createEggMiddleware } from 'vextjs-opentelemetry/egg';

export default createEggMiddleware({
  serviceName: 'my-service',

  tracing: {
    ignorePaths: [/^\/favicon/, /^\/_/, '/health'],
    spanNameResolver: (ctx) => `${ctx.method} ${ctx.route ?? ctx.path}`,
  },

  metrics: {
    customLabels: (ctx) => ({ 'http.path': ctx.route ?? ctx.path }),
  },

  // 业务字段注入（span 创建前，各服务自行扩展）
  onCtxInit: (ctx) => {
    ctx.user_id = ctx.state?.userId ?? ctx.state?.user?.id ?? '';
    ctx.feature_flag = ctx.get('x-feature-flag') || '';
  },

  // 自定义 access log（请求完成后，finally 块）
  onRequestDone: (ctx, info) => {
    ctx.logger.info(`${info.method} ${ctx.status} ${info.route} ${info.latencyMs}ms`);
  },
});

declare module 'egg' {
  interface Context {
    trace_id: string;
    span_name: string;
    endpoint: string;
    latency_ms: number;
    user_id: string;       // 由 onCtxInit 注入
    feature_flag: string;  // 由 onCtxInit 注入
  }
}

// config/config.default.ts
config.middleware = ['otel', /* 其他中间件 */];

// app/router.ts
import { getOtelStatus } from 'vextjs-opentelemetry';

router.get('/_otel/status', async (ctx) => {
  ctx.body = getOtelStatus(); // 无参，自动读取环境变量
});

// app/extend/context.ts
import { createWithSpan } from 'vextjs-opentelemetry';
export default { withSpan: createWithSpan('my-service') };

// app/controller/userController.ts
export default class UserController extends Controller {
  async findById() {
    const { ctx } = this;
    const user = await ctx.withSpan('db.user.findById', async (span) => {
      span.setAttribute('user.id', ctx.params.id);
      return ctx.service.user.findById(ctx.params.id);
    });
    ctx.body = user;
  }
}

import { Hono } from "hono";
import { createHonoMiddleware } from "vextjs-opentelemetry/hono";
import { getOtelStatus } from "vextjs-opentelemetry";

const app = new Hono();
app.use(createHonoMiddleware({ serviceName: "my-hono-app" }));
app.get("/_otel/status", (c) => c.json(getOtelStatus()));

import Fastify from "fastify";
import { createFastifyPlugin } from "vextjs-opentelemetry/fastify";
import { getOtelStatus } from "vextjs-opentelemetry";

const fastify = Fastify();
await fastify.register(createFastifyPlugin({ serviceName: "my-fastify-app" }));
fastify.get("/_otel/status", () => getOtelStatus());

import {
  createStructuredLogFormatter,
  createOtelLogBridge,
} from 'vextjs-opentelemetry/log';

// Schema B 桥接：延迟求值，SDK 初始化前返回 null（noop）
const bridge = createOtelLogBridge(() => (globalThis as any)._otelLogger);

// Schema A 格式化器
const formatter = createStructuredLogFormatter({
  serviceName: 'my-service',
  getTraceFields: (meta: any) => ({
    trace_id:   meta.ctx?.trace_id   ?? '',
    span:        meta.ctx?.span_name  ?? '',   // ctx.span_name 由 createEggMiddleware 注入
    endpoint:    meta.ctx?.endpoint   ?? '',
    latency_ms:  meta.ctx?.latency_ms ?? 0,
    user_id:     meta.ctx?.user_id    ?? '',
  }),
  getCustomFields: (meta: any) => ({
    'feature.flag': meta.ctx?.feature_flag ?? '',
  }),
});

// logger 配置
config.logger = {
  formatter(meta: any) {
    // Schema B — OTel LogRecord（trace_id/span_id 从 AsyncLocalStorage 自动注入）
    bridge.emit(meta.level ?? 'info', meta.message ?? '', {
      ...(meta.ctx?.endpoint  ? { endpoint:  meta.ctx.endpoint  } : {}),
      ...(meta.ctx?.user_id   ? { 'user.id': meta.ctx.user_id   } : {}),
    });
    // Schema A — 落地日志 JSON
    return formatter(meta);
  },
};

// src/plugins/otel.ts（otlpEndpoint 仅用于状态显示）
export default opentelemetryPlugin({
  serviceName: "my-app",
  otlpEndpoint: "http://otel-collector.internal:4318",  // 与 package.json 保持一致
  otlpHeaders: { "api-key": "YOUR_KEY" },
});

// src/config/default.ts
export default {
  otel: {
    serviceName: "my-app",
    enabled: true,
    endpoint: "http://otel-collector:4318",
  },
};

opentelemetryPlugin({
  // ── 基础 ───────────────────────────────────────────
  serviceName: "my-app",           // 服务名称
  enabled: true,                    // false 时完全 no-op

  // ── 状态显示（不控制实际导出，仅影响 /_otel/status 响应）──────────
  otlpEndpoint: "http://collector:4318",  // 建议与 package.json vext.otel.endpoint 一致
  otlpHeaders: { "api-key": "KEY" },      // 同上

  // ── 状态检查 ───────────────────────────────────────
  statusEndpoint: "/_otel/status",  // 自定义路径，false 禁用

  // ── 追踪 ───────────────────────────────────────────
  tracing: {
    enabled: true,
    ignorePaths: ["/health", "/_otel/status", /^\/internal\//],  // 忽略的路径
    spanNameResolver: (req) => `${req.method} ${req.route ?? req.path}`,  // Span 名称
    extraAttributes: (req) => ({    // 自定义 Span 属性
      "user.id": req.headers["x-user-id"] ?? "",
      "tenant.id": req.headers["x-tenant-id"] ?? "",
    }),
  },

  // ── 指标 ───────────────────────────────────────────
  metrics: {
    enabled: true,
    durationBuckets: [5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000],
    customLabels: (req) => ({       // 自定义指标标签（避免高基数！）
      "tenant.id": req.headers["x-tenant-id"] ?? "default",
    }),
  },
});

// src/config/default.ts
export default {
  otel: {
    serviceName: "my-app",
    enabled: true,
    endpoint: "http://collector:4318",
    headers: { "api-key": "KEY" },    sampling: { ratio: 1.0 },       // 采样率 0.0~1.0，默认全量  },
};

// src/config/test.ts
export default {
  otel: { enabled: false },
};

// src/instrumentation.ts（自定义，替代内置版本）
import { NodeSDK } from "@opentelemetry/sdk-node";
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";

const sdk = new NodeSDK({
  instrumentations: getNodeAutoInstrumentations({
    // 禁用 fs 检测（日志噪音大）
    "@opentelemetry/instrumentation-fs": { enabled: false },
    // 禁用 dns 检测
    "@opentelemetry/instrumentation-dns": { enabled: false },
  }),
});
sdk.start();
export {};

import { defineRoutes } from "vextjs";

export default defineRoutes((app) => {
  app.post("/payments", async (req, res) => {
    // ① 最简：完全不接触 span（仅追踪生命周期）
    const result = await req.app.otel!.withSpan(
      "payment.process",
      () => processPayment(req.body.id),
    );

    // ② 带静态初始属性
    const result = await req.app.otel!.withSpan(
      "payment.process",
      () => processPayment(req.body.id),
      { attributes: { "payment.provider": "stripe", "payment.currency": "USD" } },
    );

    // ③ 动态属性（依赖执行结果时，通过回调参数访问 span）
    const result = await req.app.otel!.withSpan("payment.process", async (span) => {
      const res = await processPayment(req.body.id);
      span.setAttribute("payment.result", res.status);
      return res;
    });

    res.json(result);
  });
});

import { createWithSpan } from "vextjs-opentelemetry";

// 应用启动时初始化（绑定 tracer 名称，通常与 serviceName 一致）
const withSpan = createWithSpan("payment");

// Express / Koa / Hono / Fastify 路由中使用
router.post("/charge", async (req, res) => {
  const result = await withSpan("payment.charge", async (span) => {
    span.setAttribute("payment.amount", req.body.amount);
    return await chargeService.run(req.body);
  });
  res.json(result);
});

// app/controller/paymentController.ts
export default class PaymentController extends Controller {
  async charge() {
    const { ctx } = this;
    // ctx.withSpan 由 app/extend/context.ts 注入，直接调用
    const result = await ctx.withSpan("payment.charge", async (span) => {
      span.setAttribute("payment.amount", ctx.request.body.amount);
      return ctx.service.payment.charge(ctx.request.body);
    });
    ctx.body = result;
  }
}

import { SpanStatusCode } from "@opentelemetry/api";
import { defineRoutes } from "vextjs";

export default defineRoutes((app) => {
  app.get("/users/:id", { validate: { param: { id: "string" } } }, async (req, res) => {
    const span = req.app.otel!.tracer.startSpan("db.user.findById", {
      attributes: { "db.system": "mongodb", "user.id": req.valid("param").id },
    });
    try {
      const user = await app.services.user.findById(req.valid("param").id);
      span.setStatus({ code: SpanStatusCode.OK });
      res.json(user);
    } catch (err) {
      span.recordException(err as Error);
      span.setStatus({ code: SpanStatusCode.ERROR, message: (err as Error).message });
      throw err;
    } finally {
      span.end();
    }
  });
});

import { definePlugin } from "vextjs";

export default definePlugin({
  name: "business-metrics",
  dependencies: ["opentelemetry"],
  setup(app) {
    const meter = app.otel!.meter;
    app.extend("businessMetrics", {
      orderCreated: meter.createCounter("business.order.created"),
      orderAmount: meter.createHistogram("business.order.amount", { unit: "cents" }),
    });
  },
});

// src/instrumentation.ts
import { NodeSDK } from "@opentelemetry/sdk-node";
import { TraceIdRatioBasedSampler } from "@opentelemetry/sdk-trace-node";

const sdk = new NodeSDK({
  sampler: new TraceIdRatioBasedSampler(0.1),
  // ... 自定义配置
});
sdk.start();
export {};

// src/config/default.ts
import os from "node:os";

let getActiveSpan: (() => unknown) | undefined;
try {
  const api = await import("@opentelemetry/api");
  getActiveSpan = api.trace.getActiveSpan.bind(api.trace);
} catch {}

export default {
  logger: {
    level: "info",
    mixin() {
      const fields: Record<string, unknown> = {
        // Resource 级字段（每条日志都有）
        service_name: "my-app",
        env: process.env.NODE_ENV ?? "development",
        host: os.hostname(),
      };

      // Span 级字段（请求上下文中有值时注入）
      if (getActiveSpan) {
        const span = getActiveSpan() as
          | { isRecording?: () => boolean; name?: string }
          | undefined;
        if (span?.isRecording?.()) {
          fields.span = span.name; // "GET", "mongodb.find", "redis.GET" 等
        }
      }

      return fields;
    },
  },
};

// VextJS —— src/config/test.ts
export default { otel: { enabled: false } };

// 非 VextJS —— 测试入口不调用 initOtel()，或传入 endpoint: "none"
initOtel({ serviceName: "my-app", endpoint: "none" });