From 6b7aeb09fe4930e1eedc2323d02fa1a2fe924bf3 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 25 Jan 2024 11:00:10 +0000 Subject: [PATCH 1/2] Bump DavidAnson/markdownlint-cli2-action from 14.0.0 to 15.0.0 Bumps [DavidAnson/markdownlint-cli2-action](https://github.com/davidanson/markdownlint-cli2-action) from 14.0.0 to 15.0.0. - [Release notes](https://github.com/davidanson/markdownlint-cli2-action/releases) - [Commits](https://github.com/davidanson/markdownlint-cli2-action/compare/455b6612a7b7a80f28be9e019b70abdd11696e4e...510b996878fc0d1a46c8a04ec86b06dbfba09de7) --- updated-dependencies: - dependency-name: DavidAnson/markdownlint-cli2-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/lint.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index cbf136d69..4014acfad 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -55,7 +55,7 @@ jobs: - name: Checkout Repository uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 - - uses: DavidAnson/markdownlint-cli2-action@455b6612a7b7a80f28be9e019b70abdd11696e4e # v14.0.0 + - uses: DavidAnson/markdownlint-cli2-action@510b996878fc0d1a46c8a04ec86b06dbfba09de7 # v15.0.0 with: config: .markdownlint-cli2.yaml globs: "**/*.md" From 17f97c70472cd42ec4ce2d5e120b7acd47fcbb84 Mon Sep 17 00:00:00 2001 From: Paul Abel Date: Thu, 25 Jan 2024 11:07:01 +0000 Subject: [PATCH 2/2] address markdown lint issues --- README.md | 358 +++++++++++++++++++++++++++--------------------------- 1 file changed, 179 insertions(+), 179 deletions(-) diff --git a/README.md b/README.md index c204e6fb7..76b829cdc 100644 --- a/README.md +++ b/README.md @@ -137,245 +137,245 @@ Flags: ### Common metrics -Name | Type | Description | Labels -----|----|----|----| -`nginx_exporter_build_info` | Gauge | Shows the exporter build information. | `branch`, `goarch`, `goos`, `goversion`, `revision`, `tags` and `version` | -`promhttp_metric_handler_requests_total` | Counter | Total number of scrapes by HTTP status code. | `code` (the HTTP status code) | -`promhttp_metric_handler_requests_in_flight` | Gauge | Current number of scrapes being served. | [] | -`go_*` | Multiple | Go runtime metrics. | [] | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginx_exporter_build_info` | Gauge | Shows the exporter build information. | `branch`, `goarch`, `goos`, `goversion`, `revision`, `tags` and `version` | +| `promhttp_metric_handler_requests_total` | Counter | Total number of scrapes by HTTP status code. | `code` (the HTTP status code) | +| `promhttp_metric_handler_requests_in_flight` | Gauge | Current number of scrapes being served. | [] | +| `go_*` | Multiple | Go runtime metrics. | [] | ### Metrics for NGINX OSS -Name | Type | Description | Labels -----|----|----|----| -`nginx_up` | Gauge | Shows the status of the last metric scrape: `1` for a successful scrape and `0` for a failed one | [] | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginx_up` | Gauge | Shows the status of the last metric scrape: `1` for a successful scrape and `0` for a failed one | [] | #### [Stub status metrics](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html) -Name | Type | Description | Labels -----|----|----|----| -`nginx_connections_accepted` | Counter | Accepted client connections. | [] | -`nginx_connections_active` | Gauge | Active client connections. | [] | -`nginx_connections_handled` | Counter | Handled client connections. | [] | -`nginx_connections_reading` | Gauge | Connections where NGINX is reading the request header. | [] | -`nginx_connections_waiting` | Gauge | Idle client connections. | [] | -`nginx_connections_writing` | Gauge | Connections where NGINX is writing the response back to the client. | [] | -`nginx_http_requests_total` | Counter | Total http requests. | [] | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginx_connections_accepted` | Counter | Accepted client connections. | [] | +| `nginx_connections_active` | Gauge | Active client connections. | [] | +| `nginx_connections_handled` | Counter | Handled client connections. | [] | +| `nginx_connections_reading` | Gauge | Connections where NGINX is reading the request header. | [] | +| `nginx_connections_waiting` | Gauge | Idle client connections. | [] | +| `nginx_connections_writing` | Gauge | Connections where NGINX is writing the response back to the client. | [] | +| `nginx_http_requests_total` | Counter | Total http requests. | [] | ### Metrics for NGINX Plus -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_up` | Gauge | Shows the status of the last metric scrape: `1` for a successful scrape and `0` for a failed one | [] | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_up` | Gauge | Shows the status of the last metric scrape: `1` for a successful scrape and `0` for a failed one | [] | #### [Connections](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_connections) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_connections_accepted` | Counter | Accepted client connections | [] | -`nginxplus_connections_active` | Gauge | Active client connections | [] | -`nginxplus_connections_dropped` | Counter | Dropped client connections dropped | [] | -`nginxplus_connections_idle` | Gauge | Idle client connections | [] | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_connections_accepted` | Counter | Accepted client connections | [] | +| `nginxplus_connections_active` | Gauge | Active client connections | [] | +| `nginxplus_connections_dropped` | Counter | Dropped client connections dropped | [] | +| `nginxplus_connections_idle` | Gauge | Idle client connections | [] | #### [HTTP](https://nginx.org/en/docs/http/ngx_http_api_module.html#http_) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_http_requests_total` | Counter | Total http requests | [] | -`nginxplus_http_requests_current` | Gauge | Current http requests | [] | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_http_requests_total` | Counter | Total http requests | [] | +| `nginxplus_http_requests_current` | Gauge | Current http requests | [] | #### [SSL](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_ssl_object) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_ssl_handshakes` | Counter | Successful SSL handshakes | [] | -`nginxplus_ssl_handshakes_failed` | Counter | Failed SSL handshakes | [] | -`nginxplus_ssl_session_reuses` | Counter | Session reuses during SSL handshake | [] | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_ssl_handshakes` | Counter | Successful SSL handshakes | [] | +| `nginxplus_ssl_handshakes_failed` | Counter | Failed SSL handshakes | [] | +| `nginxplus_ssl_session_reuses` | Counter | Session reuses during SSL handshake | [] | #### [HTTP Server Zones](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_http_server_zone) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_server_zone_processing` | Gauge | Client requests that are currently being processed | `server_zone` | -`nginxplus_server_zone_requests` | Counter | Total client requests | `server_zone` | -`nginxplus_server_zone_responses` | Counter | Total responses sent to clients | `code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `server_zone` | -`nginxplus_server_zone_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The possible values are [here](https://www.nginx.com/resources/wiki/extending/api/http/)), `server_zone` | -`nginxplus_server_zone_discarded` | Counter | Requests completed without sending a response | `server_zone` | -`nginxplus_server_zone_received` | Counter | Bytes received from clients | `server_zone` | -`nginxplus_server_zone_sent` | Counter | Bytes sent to clients | `server_zone` | -`nginxplus_server_ssl_handshakes` | Counter | Successful SSL handshakes | `server_zone` | -`nginxplus_server_ssl_handshakes_failed` | Counter | Failed SSL handshakes | `server_zone` | -`nginxplus_server_ssl_session_reuses` | Counter | Session reuses during SSL handshake | `server_zone` | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_server_zone_processing` | Gauge | Client requests that are currently being processed | `server_zone` | +| `nginxplus_server_zone_requests` | Counter | Total client requests | `server_zone` | +| `nginxplus_server_zone_responses` | Counter | Total responses sent to clients | `code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `server_zone` | +| `nginxplus_server_zone_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The possible values are [here](https://www.nginx.com/resources/wiki/extending/api/http/)), `server_zone` | +| `nginxplus_server_zone_discarded` | Counter | Requests completed without sending a response | `server_zone` | +| `nginxplus_server_zone_received` | Counter | Bytes received from clients | `server_zone` | +| `nginxplus_server_zone_sent` | Counter | Bytes sent to clients | `server_zone` | +| `nginxplus_server_ssl_handshakes` | Counter | Successful SSL handshakes | `server_zone` | +| `nginxplus_server_ssl_handshakes_failed` | Counter | Failed SSL handshakes | `server_zone` | +| `nginxplus_server_ssl_session_reuses` | Counter | Session reuses during SSL handshake | `server_zone` | #### [Stream Server Zones](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_stream_server_zone) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_stream_server_zone_processing` | Gauge | Client connections that are currently being processed | `server_zone` | -`nginxplus_stream_server_zone_connections` | Counter | Total connections | `server_zone` | -`nginxplus_stream_server_zone_sessions` | Counter | Total sessions completed | `code` (the response status code. The values are: `2xx`, `4xx`, and `5xx`), `server_zone` | -`nginxplus_stream_server_zone_discarded` | Counter | Connections completed without creating a session | `server_zone` | -`nginxplus_stream_server_zone_received` | Counter | Bytes received from clients | `server_zone` | -`nginxplus_stream_server_zone_sent` | Counter | Bytes sent to clients | `server_zone` | -`nginxplus_stream_server_ssl_handshakes` | Counter | Successful SSL handshakes | `server_zone` | -`nginxplus_stream_server_ssl_handshakes_failed` | Counter | Failed SSL handshakes | `server_zone` | -`nginxplus_stream_server_ssl_session_reuses` | Counter | Session reuses during SSL handshake | `server_zone` | +| Name | Type | Description | Labels | +| ----|----|----|----| +| `nginxplus_stream_server_zone_processing` | Gauge | Client connections that are currently being processed | `server_zone` | +| `nginxplus_stream_server_zone_connections` | Counter | Total connections | `server_zone` | +| `nginxplus_stream_server_zone_sessions` | Counter | Total sessions completed | `code` (the response status code. The values are: `2xx`, `4xx`, and `5xx`), `server_zone` | +| `nginxplus_stream_server_zone_discarded` | Counter | Connections completed without creating a session | `server_zone` | +| `nginxplus_stream_server_zone_received` | Counter | Bytes received from clients | `server_zone` | +| `nginxplus_stream_server_zone_sent` | Counter | Bytes sent to clients | `server_zone` | +| `nginxplus_stream_server_ssl_handshakes` | Counter | Successful SSL handshakes | `server_zone` | +| `nginxplus_stream_server_ssl_handshakes_failed` | Counter | Failed SSL handshakes | `server_zone` | +| `nginxplus_stream_server_ssl_session_reuses` | Counter | Session reuses during SSL handshake | `server_zone` | #### [HTTP Upstreams](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_http_upstream) > Note: for the `state` metric, the string values are converted to float64 using the following rule: `"up"` -> `1.0`, > `"draining"` -> `2.0`, `"down"` -> `3.0`, `"unavail"` –> `4.0`, `"checking"` –> `5.0`, `"unhealthy"` -> `6.0`. -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_upstream_server_state` | Gauge | Current state | `server`, `upstream` | -`nginxplus_upstream_server_active` | Gauge | Active connections | `server`, `upstream` | -`nginxplus_upstream_server_limit` | Gauge | Limit for connections which corresponds to the max_conns parameter of the upstream server. Zero value means there is no limit | `server`, `upstream` | -`nginxplus_upstream_server_requests` | Counter | Total client requests | `server`, `upstream` | -`nginxplus_upstream_server_responses` | Counter | Total responses sent to clients | `code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `server`, `upstream` | -`nginxplus_upstream_server_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The possible values are [here](https://www.nginx.com/resources/wiki/extending/api/http/)), `server`, `upstream` | -`nginxplus_upstream_server_sent` | Counter | Bytes sent to this server | `server`, `upstream` | -`nginxplus_upstream_server_received` | Counter | Bytes received to this server | `server`, `upstream` | -`nginxplus_upstream_server_fails` | Counter | Number of unsuccessful attempts to communicate with the server | `server`, `upstream` | -`nginxplus_upstream_server_unavail` | Counter | How many times the server became unavailable for client requests (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails threshold | `server`, `upstream` | -`nginxplus_upstream_server_header_time` | Gauge | Average time to get the response header from the server | `server`, `upstream` | -`nginxplus_upstream_server_response_time` | Gauge | Average time to get the full response from the server | `server`, `upstream` | -`nginxplus_upstream_server_health_checks_checks` | Counter | Total health check requests | `server`, `upstream` | -`nginxplus_upstream_server_health_checks_fails` | Counter | Failed health checks | `server`, `upstream` | -`nginxplus_upstream_server_health_checks_unhealthy` | Counter | How many times the server became unhealthy (state 'unhealthy') | `server`, `upstream` | -`nginxplus_upstream_server_ssl_handshakes` | Counter | Successful SSL handshakes | `server`, `upstream` | -`nginxplus_upstream_server_ssl_handshakes_failed` | Counter | Failed SSL handshakes | `server`, `upstream` | -`nginxplus_upstream_server_ssl_session_reuses` | Counter | Session reuses during SSL handshake | `server`, `upstream` | -`nginxplus_upstream_keepalives` | Gauge | Idle keepalive connections | `upstream` | -`nginxplus_upstream_zombies` | Gauge | Servers removed from the group but still processing active client requests | `upstream` | +| Name | Type | Description | Labels | +| ----|----|----|----| +| `nginxplus_upstream_server_state` | Gauge | Current state | `server`, `upstream` | +| `nginxplus_upstream_server_active` | Gauge | Active connections | `server`, `upstream` | +| `nginxplus_upstream_server_limit` | Gauge | Limit for connections which corresponds to the max_conns parameter of the upstream server. Zero value means there is no limit | `server`, `upstream` | +| `nginxplus_upstream_server_requests` | Counter | Total client requests | `server`, `upstream` | +| `nginxplus_upstream_server_responses` | Counter | Total responses sent to clients | `code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `server`, `upstream` | +| `nginxplus_upstream_server_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The possible values are [here](https://www.nginx.com/resources/wiki/extending/api/http/)), `server`, `upstream` | +| nginxplus_upstream_server_sent` | Counter | Bytes sent to this server | `server`, `upstream` | +| `nginxplus_upstream_server_received` | Counter | Bytes received to this server | `server`, `upstream` | +| `nginxplus_upstream_server_fails` | Counter | Number of unsuccessful attempts to communicate with the server | `server`, `upstream` | +| `nginxplus_upstream_server_unavail` | Counter | How many times the server became unavailable for client requests (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails threshold | `server`, `upstream` | +| `nginxplus_upstream_server_header_time` | Gauge | Average time to get the response header from the server | `server`, `upstream` | +| `nginxplus_upstream_server_response_time` | Gauge | Average time to get the full response from the server | `server`, `upstream` | +| `nginxplus_upstream_server_health_checks_checks` | Counter | Total health check requests | `server`, `upstream` | +| `nginxplus_upstream_server_health_checks_fails` | Counter | Failed health checks | `server`, `upstream` | +| `nginxplus_upstream_server_health_checks_unhealthy` | Counter | How many times the server became unhealthy (state 'unhealthy') | `server`, `upstream` | +| `nginxplus_upstream_server_ssl_handshakes` | Counter | Successful SSL handshakes | `server`, `upstream` | +| `nginxplus_upstream_server_ssl_handshakes_failed` | Counter | Failed SSL handshakes | `server`, `upstream` | +| `nginxplus_upstream_server_ssl_session_reuses` | Counter | Session reuses during SSL handshake | `server`, `upstream` | +| `nginxplus_upstream_keepalives` | Gauge | Idle keepalive connections | `upstream` | +| `nginxplus_upstream_zombies` | Gauge | Servers removed from the group but still processing active client requests | `upstream` | #### [Stream Upstreams](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_stream_upstream) > Note: for the `state` metric, the string values are converted to float64 using the following rule: `"up"` -> `1.0`, > `"down"` -> `3.0`, `"unavail"` –> `4.0`, `"checking"` –> `5.0`, `"unhealthy"` -> `6.0`. -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_stream_upstream_server_state` | Gauge | Current state | `server`, `upstream` | -`nginxplus_stream_upstream_server_active` | Gauge | Active connections | `server` , `upstream` | -`nginxplus_stream_upstream_server_limit` | Gauge | Limit for connections which corresponds to the max_conns parameter of the upstream server. Zero value means there is no limit | `server` , `upstream` | -`nginxplus_stream_upstream_server_connections` | Counter | Total number of client connections forwarded to this server | `server`, `upstream` | -`nginxplus_stream_upstream_server_connect_time` | Gauge | Average time to connect to the upstream server | `server`, `upstream` -`nginxplus_stream_upstream_server_first_byte_time` | Gauge | Average time to receive the first byte of data | `server`, `upstream` | -`nginxplus_stream_upstream_server_response_time` | Gauge | Average time to receive the last byte of data | `server`, `upstream` | -`nginxplus_stream_upstream_server_sent` | Counter | Bytes sent to this server | `server`, `upstream` | -`nginxplus_stream_upstream_server_received` | Counter | Bytes received from this server | `server`, `upstream` | -`nginxplus_stream_upstream_server_fails` | Counter | Number of unsuccessful attempts to communicate with the server | `server`, `upstream` | -`nginxplus_stream_upstream_server_unavail` | Counter | How many times the server became unavailable for client connections (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails threshold | `server`, `upstream` | -`nginxplus_stream_upstream_server_health_checks_checks` | Counter | Total health check requests | `server`, `upstream` | -`nginxplus_stream_upstream_server_health_checks_fails` | Counter | Failed health checks | `server`, `upstream` | -`nginxplus_stream_upstream_server_health_checks_unhealthy` | Counter | How many times the server became unhealthy (state 'unhealthy') | `server`, `upstream` | -`nginxplus_stream_upstream_server_ssl_handshakes` | Counter | Successful SSL handshakes | `server`, `upstream` | -`nginxplus_stream_upstream_server_ssl_handshakes_failed` | Counter | Failed SSL handshakes | `server`, `upstream` | -`nginxplus_stream_upstream_server_ssl_session_reuses` | Counter | Session reuses during SSL handshake | `server`, `upstream` | -`nginxplus_stream_upstream_zombies` | Gauge | Servers removed from the group but still processing active client connections | `upstream`| +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_stream_upstream_server_state` | Gauge | Current state | `server`, `upstream` | +| `nginxplus_stream_upstream_server_active` | Gauge | Active connections | `server` , `upstream` | +| `nginxplus_stream_upstream_server_limit` | Gauge | Limit for connections which corresponds to the max_conns parameter of the upstream server. Zero value means there is no limit | `server` , `upstream` | +| `nginxplus_stream_upstream_server_connections` | Counter | Total number of client connections forwarded to this server | `server`, `upstream` | +| `nginxplus_stream_upstream_server_connect_time` | Gauge | Average time to connect to the upstream server | `server`, `upstream` | +| `nginxplus_stream_upstream_server_first_byte_time` | Gauge | Average time to receive the first byte of data | `server`, `upstream` | +| `nginxplus_stream_upstream_server_response_time` | Gauge | Average time to receive the last byte of data | `server`, `upstream` | +| `nginxplus_stream_upstream_server_sent` | Counter | Bytes sent to this server | `server`, `upstream` | +| `nginxplus_stream_upstream_server_received` | Counter | Bytes received from this server | `server`, `upstream` | +| `nginxplus_stream_upstream_server_fails` | Counter | Number of unsuccessful attempts to communicate with the server | `server`, `upstream` | +| `nginxplus_stream_upstream_server_unavail` | Counter | How many times the server became unavailable for client connections (state 'unavail') due to the number of unsuccessful attempts reaching the max_fails threshold | `server`, `upstream` | +| `nginxplus_stream_upstream_server_health_checks_checks` | Counter | Total health check requests | `server`, `upstream` | +| `nginxplus_stream_upstream_server_health_checks_fails` | Counter | Failed health checks | `server`, `upstream` | +| `nginxplus_stream_upstream_server_health_checks_unhealthy` | Counter | How many times the server became unhealthy (state 'unhealthy') | `server`, `upstream` | +| `nginxplus_stream_upstream_server_ssl_handshakes` | Counter | Successful SSL handshakes | `server`, `upstream` | +| `nginxplus_stream_upstream_server_ssl_handshakes_failed` | Counter | Failed SSL handshakes | `server`, `upstream` | +| `nginxplus_stream_upstream_server_ssl_session_reuses` | Counter | Session reuses during SSL handshake | `server`, `upstream` | +| `nginxplus_stream_upstream_zombies` | Gauge | Servers removed from the group but still processing active client connections | `upstream`| #### [Stream Zone Sync](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_stream_zone_sync) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_stream_zone_sync_zone_records_pending` | Gauge | The number of records that need to be sent to the cluster | `zone` | -`nginxplus_stream_zone_sync_zone_records_total` | Gauge | The total number of records stored in the shared memory zone | `zone` | -`nginxplus_stream_zone_sync_zone_bytes_in` | Counter | Bytes received by this node | [] | -`nginxplus_stream_zone_sync_zone_bytes_out` | Counter | Bytes sent by this node | [] | -`nginxplus_stream_zone_sync_zone_msgs_in` | Counter | Total messages received by this node | [] | -`nginxplus_stream_zone_sync_zone_msgs_out` | Counter | Total messages sent by this node | [] | -`nginxplus_stream_zone_sync_zone_nodes_online` | Gauge | Number of peers this node is connected to | [] | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_stream_zone_sync_zone_records_pending` | Gauge | The number of records that need to be sent to the cluster | `zone` | +| `nginxplus_stream_zone_sync_zone_records_total` | Gauge | The total number of records stored in the shared memory zone | `zone` | +| `nginxplus_stream_zone_sync_zone_bytes_in` | Counter | Bytes received by this node | [] | +| `nginxplus_stream_zone_sync_zone_bytes_out` | Counter | Bytes sent by this node | [] | +| `nginxplus_stream_zone_sync_zone_msgs_in` | Counter | Total messages received by this node | [] | +| `nginxplus_stream_zone_sync_zone_msgs_out` | Counter | Total messages sent by this node | [] | +| `nginxplus_stream_zone_sync_zone_nodes_online` | Gauge | Number of peers this node is connected to | [] | #### [Location Zones](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_http_location_zone) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_location_zone_requests` | Counter | Total client requests | `location_zone` | -`nginxplus_location_zone_responses` | Counter | Total responses sent to clients | `code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `location_zone` | -`nginxplus_location_zone_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The possible values are [here](https://www.nginx.com/resources/wiki/extending/api/http/)), `location_zone` | -`nginxplus_location_zone_discarded` | Counter | Requests completed without sending a response | `location_zone` | -`nginxplus_location_zone_received` | Counter | Bytes received from clients | `location_zone` | -`nginxplus_location_zone_sent` | Counter | Bytes sent to clients | `location_zone` | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_location_zone_requests` | Counter | Total client requests | `location_zone` | +| `nginxplus_location_zone_responses` | Counter | Total responses sent to clients | `code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `location_zone` | +| `nginxplus_location_zone_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The possible values are [here](https://www.nginx.com/resources/wiki/extending/api/http/)), `location_zone` | +| `nginxplus_location_zone_discarded` | Counter | Requests completed without sending a response | `location_zone` | +| `nginxplus_location_zone_received` | Counter | Bytes received from clients | `location_zone` | +| `nginxplus_location_zone_sent` | Counter | Bytes sent to clients | `location_zone` | #### [Resolver](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_resolver_zone) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_resolver_name` | Counter | Total requests to resolve names to addresses | `resolver` | -`nginxplus_resolver_srv` | Counter | Total requests to resolve SRV records | `resolver` | -`nginxplus_resolver_addr` | Counter | Total requests to resolve addresses to names | `resolver` | -`nginxplus_resolver_noerror` | Counter | Total number of successful responses | `resolver` | -`nginxplus_resolver_formerr` | Counter | Total number of FORMERR responses | `resolver` | -`nginxplus_resolver_servfail` | Counter | Total number of SERVFAIL responses | `resolver` | -`nginxplus_resolver_nxdomain` | Counter | Total number of NXDOMAIN responses | `resolver` | -`nginxplus_resolver_notimp` | Counter | Total number of NOTIMP responses | `resolver` | -`nginxplus_resolver_refused` | Counter | Total number of REFUSED responses | `resolver` | -`nginxplus_resolver_timedout` | Counter | Total number of timed out request | `resolver` | -`nginxplus_resolver_unknown` | Counter | Total requests completed with an unknown error | `resolver`| +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_resolver_name` | Counter | Total requests to resolve names to addresses | `resolver` | +| `nginxplus_resolver_srv` | Counter | Total requests to resolve SRV records | `resolver` | +| `nginxplus_resolver_addr` | Counter | Total requests to resolve addresses to names | `resolver` | +| `nginxplus_resolver_noerror` | Counter | Total number of successful responses | `resolver` | +| `nginxplus_resolver_formerr` | Counter | Total number of FORMERR responses | `resolver` | +| `nginxplus_resolver_servfail` | Counter | Total number of SERVFAIL responses | `resolver` | +| `nginxplus_resolver_nxdomain` | Counter | Total number of NXDOMAIN responses | `resolver` | +| `nginxplus_resolver_notimp` | Counter | Total number of NOTIMP responses | `resolver` | +| `nginxplus_resolver_refused` | Counter | Total number of REFUSED responses | `resolver` | +| `nginxplus_resolver_timedout` | Counter | Total number of timed out request | `resolver` | +| `nginxplus_resolver_unknown` | Counter | Total requests completed with an unknown error | `resolver`| #### [HTTP Requests Rate Limiting](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_http_limit_req_zone) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_limit_request_passed` | Counter | Total number of requests that were neither limited nor accounted as limited | `zone` | -`nginxplus_limit_request_rejected` | Counter | Total number of requests that were rejected | `zone` | -`nginxplus_limit_request_delayed` | Counter | Total number of requests that were delayed | `zone` | -`nginxplus_limit_request_rejected_dry_run` | Counter | Total number of requests accounted as rejected in the dry run mode | `zone` | -`nginxplus_limit_request_delayed_dry_run` | Counter | Total number of requests accounted as delayed in the dry run mode | `zone` | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_limit_request_passed` | Counter | Total number of requests that were neither limited nor accounted as limited | `zone` | +| `nginxplus_limit_request_rejected` | Counter | Total number of requests that were rejected | `zone` | +| `nginxplus_limit_request_delayed` | Counter | Total number of requests that were delayed | `zone` | +| `nginxplus_limit_request_rejected_dry_run` | Counter | Total number of requests accounted as rejected in the dry run mode | `zone` | +| `nginxplus_limit_request_delayed_dry_run` | Counter | Total number of requests accounted as delayed in the dry run mode | `zone` | #### [HTTP Connections Limiting](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_http_limit_conn_zone) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_limit_connection_passed` | Counter | Total number of connections that were neither limited nor accounted as limited | `zone` | -`nginxplus_limit_connection_rejected` | Counter | Total number of connections that were rejected | `zone` | -`nginxplus_limit_connection_rejected_dry_run` | Counter | Total number of connections accounted as rejected in the dry run mode | `zone` | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_limit_connection_passed` | Counter | Total number of connections that were neither limited nor accounted as limited | `zone` | +| `nginxplus_limit_connection_rejected` | Counter | Total number of connections that were rejected | `zone` | +| `nginxplus_limit_connection_rejected_dry_run` | Counter | Total number of connections accounted as rejected in the dry run mode | `zone` | #### [Stream Connections Limiting](https://nginx.org/en/docs/http/ngx_http_api_module.html#def_nginx_stream_limit_conn_zone) -Name | Type | Description | Labels -----|----|----|----| -`nginxplus_stream_limit_connection_passed` | Counter | Total number of connections that were neither limited nor accounted as limited | `zone` | -`nginxplus_stream_limit_connection_rejected` | Counter | Total number of connections that were rejected | `zone` | -`nginxplus_stream_limit_connection_rejected_dry_run` | Counter | Total number of connections accounted as rejected in the dry run mode | `zone` | +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_stream_limit_connection_passed` | Counter | Total number of connections that were neither limited nor accounted as limited | `zone` | +| `nginxplus_stream_limit_connection_rejected` | Counter | Total number of connections that were rejected | `zone` | +| `nginxplus_stream_limit_connection_rejected_dry_run` | Counter | Total number of connections accounted as rejected in the dry run mode | `zone` | #### [Cache](https://nginx.org/en/docs/http/ngx_http_api_module.html#http_caches_http_cache_zone_name) -Name | Type | Description | Labels -----|----|----|---- -`nginxplus_cache_size` | Gauge | Total size of the cache | `cache` -`nginxplus_cache_max_size` | Gauge | Maximum size of the cache | `cache` -`nginxplus_cache_cold` | Gauge | Is the cache considered cold | `cache` -`nginxplus_cache_hit_responses` | Counter | Total number of cache hits | `cache` -`nginxplus_cache_hit_bytes` | Counter | Total number of bytes returned from cache hits | `cache` -`nginxplus_cache_stale_responses` | Counter | Total number of stale cache hits | `cache` -`nginxplus_cache_stale_bytes` | Counter | Total number of bytes returned from stale cache hits | `cache` -`nginxplus_cache_updating_responses` | Counter | Total number of cache hits while cache is updating | `cache` -`nginxplus_cache_updating_bytes` | Counter | Total number of bytes returned from cache while cache is updating | `cache` -`nginxplus_cache_revalidated_responses` | Counter | Total number of cache revalidations | `cache` -`nginxplus_cache_revalidated_bytes` | Counter | Total number of bytes returned from cache revalidations | `cache` -`nginxplus_cache_miss_responses` | Counter | Total number of cache misses | `cache` -`nginxplus_cache_miss_bytes` | Counter | Total number of bytes returned from cache misses | `cache` -`nginxplus_cache_expired_responses` | Counter | Total number of cache hits with expired TTL | `cache` -`nginxplus_cache_expired_bytes` | Counter | Total number of bytes returned from cache hits with expired TTL | `cache` -`nginxplus_cache_expired_responses_written` | Counter | Total number of cache hits with expired TTL written to cache | `cache` -`nginxplus_cache_expired_bytes_written` | Counter | Total number of bytes written to cache from cache hits with expired TTL | `cache` -`nginxplus_cache_bypass_responses` | Counter | Total number of cache bypasses | `cache` -`nginxplus_cache_bypass_bytes` | Counter | Total number of bytes returned from cache bypasses | `cache` -`nginxplus_cache_bypass_responses_written` | Counter | Total number of cache bypasses written to cache | `cache` -`nginxplus_cache_bypass_bytes_written` | Counter | Total number of bytes written to cache from cache bypasses | `cache` +| Name | Type | Description | Labels | +|----|----|----|----| +| `nginxplus_cache_size` | Gauge | Total size of the cache | `cache` | +| `nginxplus_cache_max_size` | Gauge | Maximum size of the cache | `cache` | +| `nginxplus_cache_cold` | Gauge | Is the cache considered cold | `cache` | +| `nginxplus_cache_hit_responses` | Counter | Total number of cache hits | `cache` | +| `nginxplus_cache_hit_bytes` | Counter | Total number of bytes returned from cache hits | `cache` | +| `nginxplus_cache_stale_responses` | Counter | Total number of stale cache hits | `cache` | +| `nginxplus_cache_stale_bytes` | Counter | Total number of bytes returned from stale cache hits | `cache` | +| `nginxplus_cache_updating_responses` | Counter | Total number of cache hits while cache is updating | `cache` | +| `nginxplus_cache_updating_bytes` | Counter | Total number of bytes returned from cache while cache is updating | `cache` | +| `nginxplus_cache_revalidated_responses` | Counter | Total number of cache revalidations | `cache` | +| `nginxplus_cache_revalidated_bytes` | Counter | Total number of bytes returned from cache revalidations | `cache` | +| `nginxplus_cache_miss_responses` | Counter | Total number of cache misses | `cache` | +| `nginxplus_cache_miss_bytes` | Counter | Total number of bytes returned from cache misses | `cache` | +| `nginxplus_cache_expired_responses` | Counter | Total number of cache hits with expired TTL | `cache` | +| `nginxplus_cache_expired_bytes` | Counter | Total number of bytes returned from cache hits with expired TTL | `cache` | +| `nginxplus_cache_expired_responses_written` | Counter | Total number of cache hits with expired TTL written to cache | `cache` | +| `nginxplus_cache_expired_bytes_written` | Counter | Total number of bytes written to cache from cache hits with expired TTL | `cache` | +| `nginxplus_cache_bypass_responses` | Counter | Total number of cache bypasses | `cache` | +| `nginxplus_cache_bypass_bytes` | Counter | Total number of bytes returned from cache bypasses | `cache` | +| `nginxplus_cache_bypass_responses_written` | Counter | Total number of cache bypasses written to cache | `cache` | +| `nginxplus_cache_bypass_bytes_written` | Counter | Total number of bytes written to cache from cache bypasses | `cache` | #### [Worker](hhttps://nginx.org/en/docs/http/ngx_http_api_module.html#workers) -Name | Type | Description | Labels -----|-------|----|------------| -`nginxplus_worker_connection_accepted` | Counter | The total number of accepted client connections | `id`, `pid` | -`nginxplus_worker_connection_dropped` | Counter | The total number of accepted client connections | `id`, `pid` | -`nginxplus_worker_connection_active` | Gauge | The current number of active client connections | `id`, `pid` | -`nginxplus_worker_connection_idle` | Gauge | The current number of idle client connection | `id`, `pid` | -`nginxplus_worker_http_requests_total` | Counter | The total number of client requests received by the worker process | `id`, `pid` | -`nginxplus_worker_http_requests_current` | Gauge | The current number of client requests that are currently being processed by the worker process | `id`, `pid` | +| Name | Type | Description | Labels | +|----|-------|----|------------| +| `nginxplus_worker_connection_accepted` | Counter | The total number of accepted client connections | `id`, `pid` | +| `nginxplus_worker_connection_dropped` | Counter | The total number of accepted client connections | `id`, `pid` | +| `nginxplus_worker_connection_active` | Gauge | The current number of active client connections | `id`, `pid` | +| `nginxplus_worker_connection_idle` | Gauge | The current number of idle client connection | `id`, `pid` | +| `nginxplus_worker_http_requests_total` | Counter | The total number of client requests received by the worker process | `id`, `pid` | +| `nginxplus_worker_http_requests_current` | Gauge | The current number of client requests that are currently being processed by the worker process | `id`, `pid` | Connect to the `/metrics` page of the running exporter to see the complete list of metrics along with their descriptions. Note: to see server zones related metrics you must configure [status