使用OpenTelemetry将GraphOS路由跟踪和指标发送到APM工具

深入了解您图性能和稳定性

自托管GraphOS路由器仅限于GraphOS企业版计划。其他计划类型使用GraphOS管理的云路由。查看定价页面以了解详情。

💡 提示

如果您是企业客户，想了解更多关于这个主题的内容，请尝试学习企业最佳实践：Supergraph 可观测性中的课程。 .

应用性能监控 (APM) 工具对于许多组织至关重要，直接了解您的图性能是系统稳定性和性能的整体可观测性的一部分重要内容。GraphOS 路由器以及子图并无不同。虽然您可能已经用 APM 工具对现有的子图进行了功能实现，但为了清楚地了解您图的运行状况，您可能还需要连接路由器。

幸运的是，有办法将这两款软件连接在一起： OpenTelemetry。我们之前讨论过利用 OpenTelemetry 连接到 Prometheus，同样的方法也适用于此用例。

使用 OpenTelemetry 有两种方法可以将路由器连接到您的 APM：

使用 OpenTelemetry 收集器
直接连接

在我们的示例中，我们将连接到 New Relic，但这也适用于任何支持 OpenTelemetry 作为输入选项的 APM，例如 Honeycomb 或 Dynatrace。

使用 OpenTelemetry 收集器（推荐）

我们建议使用 OpenTelemetry 收集器将 router度量标准发送到您的 APM 工具，以下是一些原因：

收集器提供了当运行多个 router 实例时的集中式报告器。
收集器使您能够将指标处理并发送到除 APM 工具以外的多个位置，例如本地 Prometheus 实例。

您需要一个 OpenTelemetry 收集器的实例来将其导出到您的 APM 工具。基本配置需要 OpenTelemetry 协议 (OTLP) 接收器（用于路由器）和导出器（用于转发到您的 APM 工具）。

此外，我们建议添加批处理 处理器以启用每个导出器上的批量请求。

以下是一个针对 New Relic 的示例收集器配置

collector-config.yaml

1
receivers:
2
  otlp:
3
    protocols:
4
      grpc:
5
      http:
6
        cors:
7
          allowed_origins:
8
            - http://*
9
            - https://*
10

11
exporters:
12
  otlp:
13
    endpoint: ${OTEL_EXPORTER_OTLP_ENDPOINT}
14
    headers:
15
      api-key: ${NEW_RELIC_LICENSE_KEY}
16

17
processors:
18
  batch:
19

20
service:
21
  pipelines:
22
    traces:
23
      receivers: [otlp]
24
      exporters: [otlp]
25
      processors: [batch]
26
    metrics:
27
      receivers: [otlp]
28
      exporters: [otlp]
29
      processors: [batch]

然后，路由器需要直接连接到收集器实例。下面是一个示例路由器配置：

router.yaml

1
cors:
2
  allow_any_origin: true
3
supergraph:
4
  listen: 0.0.0.0:4000
5
telemetry:
6
  metrics:
7
    otlp:
8
      endpoint: http://COLLECTOR_ADDRESS:4317
9
  tracing:
10
    trace_config:
11
      service_name: 'router'
12
      service_namespace: 'apollo'
13
    otlp:
14
      endpoint: http://COLLECTOR_ADDRESS:4317

有关配置选项的更多信息，请参阅关于使用OpenTelemetryCollector 捕获指标和捕获跟踪的文档。

直接连接

您不必使用OpenTelemetryCollector，也可以配置您的GraphOS Router实例直接将数据发送到您的APM工具。为此，您需要修改路由器的YAML配置文件，将导出设置为使用标题（在这种情况下，元数据），以及跟踪/指标以传递令牌。

下面是连接到New Relic的示例路由器配置：

router.yaml

1
cors:
2
  allow_any_origin: true
3
supergraph:
4
  listen: 0.0.0.0:4000
5
telemetry:
6
  metrics:
7
    otlp:
8
      endpoint: https://otlp.nr-data.net
9
      grpc:
10
        metadata:
11
          'api-key': ['${env.NEW_RELIC_LICENSE_KEY}']
12
  tracing:
13
    trace_config:
14
      service_name: 'router'
15
      service_namespace: 'apollo'
16
    otlp:
17
      endpoint: https://otlp.nr-data.net
18
      grpc:
19
        metadata:
20
          'api-key': ['${env.NEW_RELIC_LICENSE_KEY}']

此配置使用 NEW_RELIC_LICENSE_KEY环境变量，通过路由器的 variable expansion feature^{变量扩展功能}来传递密钥，从而避免在配置中包含敏感令牌。

下步

主页