prometheus

    接口

    插件会增加 /apisix/prometheus/metrics 这个接口。

    指标默认会通过独立的服务地址暴露。 默认情况下，这个地址是 127.0.0.1:9091。你可以在 conf/config.yaml 里面修改它，比如：

    假设环境变量 INTRANET_IP 是 172.1.1.1，现在 APISIX 会在 172.1.1.1:9092 上暴露指标。

    在 2.6 版本之前，指标会直接暴露到数据面的端口上，你可能需要通过 来保护它。

    如果你依然想要这样的行为，你可以这么配置：

    1. plugin_attr:  prometheus:    enable_export_server: false

    prometheus 插件可以使用空 {} 开启。 注意，多个路由/服务可以设置为相同的名称，因此当设置 prefer_name 为 true 时，注意规范命名否则容易引起误解。

    例子如下:

    你可以使用 APISIX Dashboard 通过 web 界面来完成上面的操作。

    先增加一个 Route：

    然后在 route 页面中添加 prometheus 插件：

    如何提取指标数据

    我们可以从指定的 url 中提取指标数据 /apisix/prometheus/metrics:

    1. curl -i http://127.0.0.1:9091/apisix/prometheus/metrics

    把该 uri 地址配置到 prometheus 中去,就会自动完成指标数据提取.

    例子如下:

    我们也可以在 prometheus 控制台中去检查状态:

    prometheus - 图3

    我们可以在 conf/config.yaml 的 plugin_attr 修改默认的 uri

    配置示例:

    插件导出的指标可以在 Grafana 进行图形化绘制显示。

    下载 Grafana dashboard 元数据 并导入到 Grafana 中。

    你可以到 下载 Grafana 元数据.

    prometheus - 图6

    prometheus - 图8

    可有的指标

    • Bandwidth: 流经 APISIX 的总带宽(可分出口带宽和入口带宽)，可以统计到每个服务的带宽总和。具有的维度：

    • etcd reachability: APISIX 连接 etcd 的可用性，用 0 和 1 来表示，1 表示可用，0 表示不可用。

    • Connections: 各种的 Nginx 连接指标，如 active（正处理的活动连接数），reading（nginx 读取到客户端的 Header 信息数），writing（nginx 返回给客户端的 Header 信息数），已建立的连接数。

    • Batch process entries: 批处理未发送数据计数器，当你使用了批处理发送插件，比如：sys logger, http logger, sls logger, tcp logger, udp logger and zipkin, 那么你将会在此指标中看到批处理当前尚未发送的数据的数量。

    • Latency: 每个服务的请求用时和 APISIX 处理耗时的直方图。具有的维度：

    这里是 APISIX 的原始的指标数据集:

    禁用插件

    1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/hello",    "plugins": {},    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:80": 1        }    }}'