跳到主要内容
版本:3.9.x

数据面指标参考

API7 网关通过数据面的 Prometheus 端点导出节点、HTTP 流量、AI 和流式代理指标。可用的序列取决于已安装的补丁、已配置的插件和实际流量:节点指标描述正在运行的网关,而请求指标会在相应功能处理流量后出现。

下列指标名称使用默认的 apisix_ 前缀。你可以通过 plugin_attr.prometheus.metric_prefix 更改前缀,并通过 prometheus 插件配置添加或移除部分请求标签。

节点指标

以下指标描述网关进程及其配置连接。它们不要求路由上运行 prometheus 插件。

指标类型内置标签说明
apisix_nginx_http_current_connectionsGaugestategateway_group_idinstance_id按状态统计当前 NGINX 连接数。
apisix_http_requests_totalGaugegateway_group_idinstance_id网关启动后处理的请求数。尽管名称以 _total 结尾,已发布的实现仍将该指标族导出为 Gauge。
apisix_etcd_reachableGaugegateway_group_idinstance_id网关能否连接 DP Manager:1 表示可连接,0 表示不可连接。
apisix_prometheus_disableGaugegateway_group_idinstance_id是否已禁用流量指标采集:1 表示已禁用,0 表示已启用。
apisix_node_infoGaugehostnamegateway_group_idinstance_id标识上报指标的网关实例。
apisix_etcd_modify_indexesGaugekeygateway_group_idinstance_id按资源键记录配置修订版本。
apisix_shared_dict_capacity_bytesGaugenamegateway_group_idinstance_id各 NGINX 共享字典的配置容量。
apisix_shared_dict_free_space_bytesGaugenamegateway_group_idinstance_id各 NGINX 共享字典的可用空间。

使用 instance_id 对两种采集路径中的数据面实例进行分组。该标签属于导出的序列;Prometheus 只会在抓取目标时添加自己的 instance 标签。

HTTP 流量指标

prometheus 插件处理请求时会记录以下指标族。通常使用全局规则为所有 HTTP 流量启用该插件。

指标类型内置标签
apisix_http_statusCountercoderouteroute_idmatched_urimatched_hostserviceservice_idconsumernodegateway_group_idinstance_idportal_idapi_product_idrequest_typerequest_llm_modelllm_modelmcp_request_typemcp_tool_nameresponse_source
apisix_http_latencyHistogramtyperouteroute_idserviceservice_idconsumernodegateway_group_idinstance_idportal_idapi_product_idrequest_typerequest_llm_modelllm_modelmcp_request_typemcp_tool_name
apisix_bandwidthCountertyperouteroute_idserviceservice_idconsumernodegateway_group_idinstance_idportal_idapi_product_idrequest_typerequest_llm_modelllm_modelmcp_request_typemcp_tool_name

该表展示最新补丁中的标签结构。apisix_http_statusresponse_source 标签从 3.9.10 及更高版本开始提供。这三个指标族的 mcp_request_typemcp_tool_name 标签从 3.9.14 及更高版本开始提供。

apisix_http_latency 以毫秒为单位记录数据,其 type 标签可以是 requestupstreamapisixapisix_bandwidthtype 标签可以是 ingressegress

如果 ADC 同步删除了 prometheus 全局规则,且没有路由级 prometheus 配置替代它,节点指标仍可能存在,但受影响路由上的 HTTP 流量指标将停止更新。请在 ADC 管理的声明式配置中包含该全局规则。

AI 指标

大多数 AI 指标族会在相关 AI 插件处理请求且 prometheus 插件也在该请求上运行时生成,并使用与 HTTP 流量指标相同的资源上下文。如果移除 prometheus 全局规则且未在受影响的路由上启用该插件,LLM 延迟、Token、分布和 AI 缓存指标族将停止更新。apisix_llm_active_connectionsai-proxy 直接更新,不依赖该全局规则。

指标类型附加标签或行为
apisix_llm_latencyHistogram截至 3.9.13 版本,该指标族没有 type 标签,并记录 llm_time_to_first_token;对于流式流量,该值为 TTFT。3.9.14 及更高版本将完整响应延迟记录为 type="total",将流式 TTFT 记录为 type="ttft"
apisix_llm_prompt_tokensCounter统计提供商报告的提示 Token 数。
apisix_llm_completion_tokensCounter统计提供商报告的补全 Token 数。
apisix_llm_active_connectionsGauge跟踪活跃的 AI 请求。从 3.9.8 版本开始,使用 ai-proxy-multi 回退重试时,失败实例的序列可能会一直高于实际活跃数量,直到配置的过期机制移除该序列或指标存储被重置。
apisix_llm_prompt_tokens_distHistogram每个请求的提示 Token 数分布。从 3.9.14 及更高版本开始提供。
apisix_llm_completion_tokens_distHistogram每个请求的补全 Token 数分布。从 3.9.14 及更高版本开始提供。
apisix_ai_cache_hits_totalCounter添加 layer 标签以标识提供响应的缓存层。从 3.9.16 及更高版本开始提供。
apisix_ai_cache_misses_totalCounter统计缓存未命中次数。从 3.9.16 及更高版本开始提供。
apisix_ai_cache_bypasses_totalCounter统计绕过缓存的请求数。从 3.9.16 及更高版本开始提供。
apisix_ai_cache_embedding_latencyHistogram以毫秒为单位记录嵌入调用延迟。从 3.9.16 及更高版本开始提供。

这些指标族的内置资源标签包括 routeroute_idserviceservice_idconsumernodegateway_group_idinstance_idportal_idapi_product_idrequest_typerequest_llm_modelllm_model。Token、活跃连接和缓存指标族还包含 matched_urimatched_hostapisix_llm_latency 不包含这两个标签。

流式代理指标

在需要测量会话的每条流式代理路由上启用 prometheus 插件。API7 控制面会将流式代理插件列表下发至网关,因此托管部署无需在本地编辑 stream_pluginsapisix_stream_connection_totalapisix_stream_status 由插件的流式代理日志阶段记录。apisix_stream_active_connectionsapisix_stream_bandwidth 还要求网关运行时包含 stream-metrics 模块。

指标类型内置标签可用版本
apisix_stream_connection_totalCounterroute所有 3.9.x 版本
apisix_stream_active_connectionsGaugelisten_addrgateway_group_idinstance_id3.9.19 及更高版本
apisix_stream_statusCountercodelisten_addrnodegateway_group_idinstance_id3.9.19 及更高版本
apisix_stream_bandwidthCounterlisten_addrtypesidegateway_group_idinstance_id3.9.19 及更高版本

apisix_stream_connection_total 按匹配的流式代理路由区分。其他流式代理指标族按监听地址区分,因为它们可能在路由匹配前或直接由 NGINX stream 子系统更新。

支撑子系统的指标

部分指标在主导出器之外注册,因此不会继承常见的数据面标签:

指标类型内置标签出现场景
apisix_nginx_metric_errors_totalCounter每个指标注册表都会导出内部库错误计数器。
apisix_batch_process_entriesGaugenameroute_idserver_addr日志记录插件或其他插件使用批处理器。

网关会初始化两个使用相同前缀的指标注册表,因此在当前发布版本中直接抓取时,apisix_nginx_metric_errors_total 会出现两次。Prometheus 会拒绝整个抓取,将目标标记为失败,并且不会采集任何网关指标。在重复暴露问题修复前,请使用 DP Manager 远程写入路径。

已配置的 xRPC 协议可以注册其他协议专用指标族。对于特定部署中启用的可选插件和模块,请以实时端点为准。

相关页面