文档 Grafana Tempo API 指标摘要 API

指标摘要 API

本文档解释了如何在 Tempo 中使用指标摘要 API。该 API 返回过去一小时内发送到 Tempo 的类型为 kind=server 的 Span 的 RED 指标（Span 计数、错误 Span 计数和延迟信息），并按用户指定的属性分组。

弃用并推荐使用 TraceQL 指标

考虑到 TraceQL 指标的发布，指标摘要 API 现已冗余。因此，弃用此 API 是为了减轻维护负担。

TraceQL 指标查询比指标摘要 API 提供的功能强大得多。TraceQL 指标可以查看任意时间窗口（而不仅仅是过去一小时），返回时间序列信息（而不仅仅是过去一小时的单个瞬时值），并且可以查看所有 Span（而不仅仅是 kind=server）。

举例来说，如果您使用指标摘要 API 按属性 resource.cloud.region 进行聚合，您可以通过几个 TraceQL 查询获得相同的结果：

按 resource.cloud.region 的请求速率

复制

{ } | rate() by (resource.cloud.region)

按 resource.cloud.region 的错误率

复制

{ status=error } | rate() by (resource.cloud.region)

按 resource.cloud.region 的第 50、90 和 99 百分位延迟（例如 p99、p90 和 p50）

复制

{ } | quantile_over_time(duration, .99, .9, .5) by (resource.cloud.region)

如果您想比在 Explore 的代码模式下手动输入这些查询更快，可以使用 Grafana Trace Drilldown，这是一种无需查询即可导航存储在 Tempo 中的追踪数据的体验，其底层由 TraceQL 指标查询提供支持。

激活指标摘要

要启用（已弃用的）指标摘要 API，必须在 metrics generator 中开启本地块处理器。请注意，如果启用该功能，generator 将会消耗更多资源，包括磁盘空间。

yaml 复制

overrides:
  defaults:
    metrics_generator:
      processors: [..., 'local-blocks']

在 Grafana 和 Grafana Cloud 中，默认禁用指标摘要 API。要在 Grafana Cloud 中启用它，请联系 Grafana 支持团队。

请求

要向此 API 发送请求，请使用 query-frontend 上的以下端点：

复制

GET http://<tempo>/api/metrics/summary

查询参数

所有查询参数必须进行 URL 编码，以保留查询中非 URL 安全的字符，例如 &。

示例

bash 复制

curl "$URL/api/metrics/summary" --data-urlencode 'q={resource.service.name="checkout-service"}' --data-urlencode 'groupBy=name'

响应

Tempo 响应是一个在 tempo.proto 中定义的 SpanMetricsSummary 对象，相关部分粘贴如下：

复制

message SpanMetricsSummaryResponse {
  repeated SpanMetricsSummary summaries = 1;
}

message SpanMetricsSummary {
  uint64 spanCount = 1;
  uint64 errorSpanCount = 2;
  TraceQLStatic static = 3;
  uint64 p99 = 4;
  uint64 p95 = 5;
  uint64 p90 = 6;
  uint64 p50 = 7;
}

message TraceQLStatic {
  int32 type = 1;
  int64 n = 2;
  double f = 3;
  string s = 4;
  bool b = 5;
  uint64 d = 6;
  int32 status = 7;
  int32 kind = 8;
}

响应遵循 标准 protobuf->JSON 映射规则以 JSON 格式返回。

示例

JavaScript 复制

{
   "summaries": [
       {
           "spanCount": "20",
           "series" : [
               {
                   "key": ".attr1",
                   "value": {
                       "type": 5,
                       "s": "foo"
                   },
               },
               ...
           ],
           "p99": "68719476736",
           "p95": "1073741824",
           "p90": "1017990479",
           "p50": "664499239"
       },