GraphQL 中的 opentracing 实现-JavaScript中文网-JavaScript教程资源分享门户

GraphQL 作为一种 API 查询语言，为前端与后端之间的数据传输提供了灵活的方式，而 Opentracing 作为一个开放标准，可以帮助我们实现数据流追踪和分析，提升程序的可观察性和调试效率。在 GraphQL 的实现中，Opentracing 也发挥着非常重要的作用。本文将介绍 GraphQL 中的 Opentracing 实现和应用，以及如何结合示例代码进行学习和指导。

Opentracing 是什么？

Opentracing 是一个开放标准，旨在为分布式跨进程、跨服务的请求追踪和可观察性提供一种标准化格式和 API。它可以让我们实现从发起请求到处理响应的完整链路追踪和监控，包括对请求状态、耗时、错误情况的记录和分析。Opentracing 的标准化格式和 API 集成了多种开源和商业解决方案，包括 Jaeger、Zipkin、Datadog 等常见的跟踪和监控系统。

GraphQL 中的 Opentracing 实现

GraphQL 是一种用于构建 API 的语言和规范，其核心思想是定义数据模型和数据交互方式，将查询和变更的请求和响应都统一成可解析的 JSON 格式。GraphQL 对于数据的封装和类型定义提供了很高的灵活性和可定制性，但同时也会增加一些负担和复杂性，比如如何实现请求的追踪和监控。

Opentracing 可以很好地解决这个问题。Graphql 中的 Opentracing 实现通常基于 TracingResolverWrapper 和 ExecutionContext等 GraphQL 内部 API，通过对请求处理过程的包装和记录，将链路追踪信息集成到 GraphQL 的上下文参数中，并传递给后续的 resolver 中。这样就可以实现从请求开始到响应结束的完整链路记录和跟踪，各个 resolver 中的错误和耗时信息也可以被捕获和分析。

示例代码

以下是一个基于 Apollo Server 和 Jaeger 的 GraphQL 追踪和监控示例代码：

// javascriptcn.com 代码示例
const { ApolloServer } = require("apollo-server");
const { TracingResolverWrapper } = require("opentracing-graphql-tools");

const opentracing = require("opentracing");
const jaeger = require("jaeger-client");

// 初始化 Jaeger Tracer
const config = {
  serviceName: "graphql",
  sampler: { type: "const", param: 1 },
  reporter: { logSpans: true },
};
const options = {
  logger: {
    info: function logInfo(msg) {
      console.log("INFO ", msg);
    },
    error: function logError(msg) {
      console.log("ERROR", msg);
    },
  },
};
const tracer = jaeger.initTracer(config, options);

// resolver 包装函数
const tracingWrapper = (resolver, parent, args, context, info) => {
  // 创建 span 并设置标签
  const span = tracer.startSpan("graphql.resolver", {
    tags: {
      operationName: info.operation.name.value,
      fieldName: info.fieldName,
    },
  });
  // 将当前 span 放入上下文中
  opentracing.setGlobalTracer(tracer);
  opentracing.scopeManager().activate(span, true);
  // 执行 resolver
  let result = resolver(parent, args, context, info);
  // 结束 span 并记录耗时
  span.finish();
  return result;
};

// 定义 Schema
const typeDefs = `
  type Query {
    hello(name: String): String
  }
`;

// 定义 Resolver
const resolvers = {
  Query: {
    hello: tracingWrapper(
      (parent, args, context, info) => {
        const name = args.name || "World";
        return `Hello, ${name}!`;
      },
      null,
      null,
      null,
      "Query.hello"
    ),
  },
};

// 创建 Apollo Server
const server = new ApolloServer({
  typeDefs,
  resolvers: TracingResolverWrapper(resolvers),
  context: ({ req }) => {
    // 从请求头中读取 trace id 和 span id
    const parentSpanContext = tracer.extract(
      opentracing.FORMAT_HTTP_HEADERS,
      req.headers
    );
    const options = {};
    if (parentSpanContext) {
      options.childOf = parentSpanContext;
    }
    // 创建新 span 并设置 http headers
    const span = tracer.startSpan("graphql.query", options);
    tracer.inject(span, opentracing.FORMAT_HTTP_HEADERS, req.headers);
    // 将当前 span 放入上下文中
    opentracing.setGlobalTracer(tracer);
    opentracing.scopeManager().activate(span, true);
    return { span };
  },
});

// 挂载 Apollo Server 到 Express
server.listen().then(({ url }) => {
  console.log(`🚀 Server ready at ${url}`);
});

这份代码演示了如何使用 TracingResolverWrapper 和 ExecutionContext 中的信息进行追踪和监控。在定义 Resolver 的时候，我们可以使用 tracingWrapper 对每个 Resolver 进行一个 span 的包装，并在 Resolver 执行完毕后记录耗时和结束 span，这样我们就可以得到每个 Resolver 执行的耗时和错误情况。在创建 Apollo Server 的时候，我们还使用了 TracingResolverWrapper 来对整个 Schema 进行一次包装，这样我们就可以统一处理所有 Resolver 的链路追踪信息，并放入上下文中传递给后续的 Resolver。同时，我们也定义了一个 context 函数，在每次请求开始的时候创建一个新的 span，并将其放入上下文中传递给 Resolver。这样我们就可以得到整个请求的链路追踪信息，并在 Jaeger 的监控面板中进行可视化分析。

总结

Opentracing 是一个非常实用的开放标准，可以帮助我们实现分布式系统的链路追踪和监控。在 GraphQL 中，Opentracing 的实现可以让我们更加方便地追踪和监控请求和响应的整个链路，包括各个 Resolver 的耗时和错误情况。通过结合示例代码的学习和指导，我们可以深入了解 GraphQL 中 Opentracing 的实现和应用，进一步提高程序的可观察性和调试效率。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/652ccbd77d4982a6ebe5d135