prometheus/nginx_exporter
1
0
Fork 0
mirror of https://github.com/nginxinc/nginx-prometheus-exporter.git synced 2025-07-31 21:04:21 +03:00
Code Activity

Update links to address markdown lint issues (#1094)

Browse Source 
* Update links to address markdown lint issues

* reduce line length

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Paul Abel
2025-07-02 14:47:18 +01:00
committed by GitHub
parent 8796bafe7b
commit fe5a4595dd
4 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -69,7 +69,7 @@ issue template.
### F5 Contributor License Agreement (CLA) ### F5 Contributor License Agreement (CLA)
F5 requires all external contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) F5 requires all external contributors to agree to the terms of the [F5 CLA](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)
before any of their changes can be incorporated into an F5 Open Source repository. before any of their changes can be incorporated into an F5 Open Source repository.
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and

6
README.md
View File

@ -254,7 +254,7 @@ Flags:
| `nginxplus_server_zone_processing` | Gauge | Client requests that are currently being processed | `server_zone` | | `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_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` | 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_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The [possible values](https://www.nginx.com/resources/wiki/extending/api/http/) are available on the NGINX Wiki), `server_zone` |
| `nginxplus_server_zone_discarded` | Counter | Requests completed without sending a response | `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_received` | Counter | Bytes received from clients | `server_zone` |
| `nginxplus_server_zone_sent` | Counter | Bytes sent to clients | `server_zone` | | `nginxplus_server_zone_sent` | Counter | Bytes sent to clients | `server_zone` |
@ -288,7 +288,7 @@ Flags:
| `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_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_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` | 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_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The [possible values](https://www.nginx.com/resources/wiki/extending/api/http/) are available on the NGINX Wiki), `server`, `upstream` |
| `nginxplus_upstream_server_sent` | Counter | Bytes sent to this server | `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_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_fails` | Counter | Number of unsuccessful attempts to communicate with the server | `server`, `upstream` |
@ -348,7 +348,7 @@ Flags:
| ----------------------------------------- | ------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------------------------------- | ------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `nginxplus_location_zone_requests` | Counter | Total client requests | `location_zone` | | `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` | 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_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The [possible values](https://www.nginx.com/resources/wiki/extending/api/http/) are available on the NGINX Wiki), `location_zone` |
| `nginxplus_location_zone_discarded` | Counter | Requests completed without sending a response | `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_received` | Counter | Bytes received from clients | `location_zone` |
| `nginxplus_location_zone_sent` | Counter | Bytes sent to clients | `location_zone` | | `nginxplus_location_zone_sent` | Counter | Bytes sent to clients | `location_zone` |

4
examples/basic_auth/README.md
View File

@ -4,8 +4,8 @@ This example shows how to run NGINX Prometheus Exporter with web configuration.
configuration `web-config.yml` that enables basic authentication. It is configured to have a single user `alice` with configuration `web-config.yml` that enables basic authentication. It is configured to have a single user `alice` with
password `password`. password `password`.
The full documentation for the web configuration can be found See the full documentation of the
[here](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md). [web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details.
<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

4
examples/tls/README.md
View File

@ -4,8 +4,8 @@ This example shows how to run NGINX Prometheus Exporter with web configuration.
configuration `web-config.yml` that enables TLS and specifies the path to the TLS certificate and key files. configuration `web-config.yml` that enables TLS and specifies the path to the TLS certificate and key files.
Additionally, there are two example TLS files `server.crt` and `server.key` that are used in the configuration. Additionally, there are two example TLS files `server.crt` and `server.key` that are used in the configuration.
The full documentation for the web configuration can be found See the full documentation of the
[here](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md). [web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details.
<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->