2019-10-31 09:27:28 +08:00
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
-->
2020-06-19 12:03:55 +08:00
[Chinese ](../zh-cn/plugins/prometheus.md )
2019-06-05 17:18:22 +08:00
# prometheus
This plugin exposes metrics in Prometheus Exposition format.
## Attributes
none.
## How to enable it
2019-06-05 17:36:58 +08:00
`prometheus` plugin can be enable with empty table, because it doesn't have
any options yet.
2019-06-05 17:18:22 +08:00
For example:
2019-06-05 17:36:58 +08:00
```shell
2020-03-05 14:48:27 +08:00
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
2019-06-05 17:18:22 +08:00
{
"uri": "/hello",
2019-06-13 17:25:39 +08:00
"plugins": {
2019-06-05 17:18:22 +08:00
"prometheus":{}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:80": 1
}
}
}'
```
2019-09-23 06:13:06 +08:00
You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/` , to complete the above operation through the web interface, first add a route:
![](../images/plugin/prometheus-1.png)
Then add prometheus plugin:
![](../images/plugin/prometheus-2.png)
2019-06-05 17:18:22 +08:00
## How to fetch the metric data
2019-06-13 12:01:36 +08:00
We fetch the metric data from the specified url `/apisix/prometheus/metrics` .
2020-02-28 14:11:07 +08:00
```
curl -i http://127.0.0.1:9080/apisix/prometheus/metrics
```
2019-06-05 17:18:22 +08:00
2019-06-05 17:36:58 +08:00
Puts this uri address into prometheus, and it will automatically fetch
these metric data.
2019-06-05 17:18:22 +08:00
For example like this:
```yaml
scrape_configs:
- job_name: 'apisix'
2019-06-13 12:01:36 +08:00
metrics_path: '/apisix/prometheus/metrics'
2019-06-05 17:18:22 +08:00
static_configs:
- targets: ['127.0.0.1:9080']
```
And we can check the status at prometheus console:
2019-07-14 09:32:22 +08:00
![](../../doc/images/plugin/prometheus01.png)
2019-06-05 17:18:22 +08:00
2019-07-14 09:32:22 +08:00
![](../../doc/images/plugin/prometheus02.png)
2019-06-05 17:18:22 +08:00
2019-06-05 17:23:19 +08:00
### Grafana dashboard
2020-01-14 09:59:25 +08:00
Metrics exported by the plugin can be graphed in Grafana using a drop in dashboard.
2019-06-05 17:23:19 +08:00
2020-02-11 12:57:58 +08:00
You can goto [Grafana meta ](https://grafana.com/grafana/dashboards/11719 ) for `Grafana` meta data.
2019-06-05 17:23:19 +08:00
2020-01-14 09:59:25 +08:00
![](../../doc/images/plugin/grafana_1.png)
![](../../doc/images/plugin/grafana_2.png)
![](../../doc/images/plugin/grafana_3.png)
2019-06-05 17:23:19 +08:00
### Available metrics
* `Status codes` : HTTP status codes returned by upstream services. These are available per service and across all services.
* `Bandwidth` : Total Bandwidth (egress/ingress) flowing through apisix. This metric is available per service and as a sum across all services.
* `etcd reachability` : A gauge type with a value of 0 or 1, representing if etcd can be reached by a apisix or not.
* `Connections` : Various Nginx connection metrics like active, reading, writing, and number of accepted connections.
2019-06-05 17:18:22 +08:00
Here is the original metric data of apisix:
```
2019-06-13 12:01:36 +08:00
$ curl http://127.0.0.2:9080/apisix/prometheus/metrics
2019-06-05 17:18:22 +08:00
# HELP apisix_bandwidth Total bandwidth in bytes consumed per service in Apisix
# TYPE apisix_bandwidth counter
apisix_bandwidth{type="egress",service="127.0.0.2"} 183
apisix_bandwidth{type="egress",service="bar.com"} 183
apisix_bandwidth{type="egress",service="foo.com"} 2379
apisix_bandwidth{type="ingress",service="127.0.0.2"} 83
apisix_bandwidth{type="ingress",service="bar.com"} 76
apisix_bandwidth{type="ingress",service="foo.com"} 988
# HELP apisix_etcd_reachable Config server etcd reachable from Apisix, 0 is unreachable
# TYPE apisix_etcd_reachable gauge
apisix_etcd_reachable 1
# HELP apisix_http_status HTTP status codes per service in Apisix
# TYPE apisix_http_status counter
apisix_http_status{code="200",service="127.0.0.2"} 1
apisix_http_status{code="200",service="bar.com"} 1
apisix_http_status{code="200",service="foo.com"} 13
# HELP apisix_nginx_http_current_connections Number of HTTP connections
# TYPE apisix_nginx_http_current_connections gauge
apisix_nginx_http_current_connections{state="accepted"} 11994
apisix_nginx_http_current_connections{state="active"} 2
apisix_nginx_http_current_connections{state="handled"} 11994
apisix_nginx_http_current_connections{state="reading"} 0
apisix_nginx_http_current_connections{state="total"} 1191780
apisix_nginx_http_current_connections{state="waiting"} 1
apisix_nginx_http_current_connections{state="writing"} 1
# HELP apisix_nginx_metric_errors_total Number of nginx-lua-prometheus errors
# TYPE apisix_nginx_metric_errors_total counter
apisix_nginx_metric_errors_total 0
```