Sfoglia il codice sorgente

prometheus docs updates

John Anderson 6 anni fa
parent
commit
b745401817
2 ha cambiato i file con 5 aggiunte e 5 eliminazioni
  1. 1 1
      CHANGELOG.md
  2. 4 4
      docs/additional-features/prometheus-metrics.md

+ 1 - 1
CHANGELOG.md

@@ -89,7 +89,7 @@ single button.
 NetBox now supports exposing native Prometheus metrics from the application. [Prometheus](https://prometheus.io/) is a
 popular time series metric platform used for monitoring. NetBox exposes metrics at the `/metrics` HTTP endpoint, e.g.
 `https://netbox.local/metrics`. Metric exposition can be toggled with the `METRICS_ENABLED` configuration setting.
-Metrics are exposed by default.
+Metrics are not exposed by default.
 
 NetBox makes use of the [django-prometheus](https://github.com/korfuri/django-prometheus) library to export a number of
 different types of metrics, including:

+ 4 - 4
docs/additional-features/prometheus-metrics.md

@@ -2,7 +2,7 @@
 
 NetBox supports optionally exposing native Prometheus metrics from the application. [Prometheus](https://prometheus.io/) is a popular time series metric platform used for monitoring.
 
-NetBox exposes metrics at the `/metrics` HTTP endpoint, e.g. `https://netbox.local/metrics`. Metric exposition can be toggled with the `METRICS_ENABLED` configuration setting. Metrics are exposed by default.
+NetBox exposes metrics at the `/metrics` HTTP endpoint, e.g. `https://netbox.local/metrics`. Metric exposition can be toggled with the `METRICS_ENABLED` configuration setting. Metrics are not exposed by default.
 
 ## Metric Types
 
@@ -23,11 +23,11 @@ For the exhaustive list of exposed metrics, visit the `/metrics` endpoint on you
 
 ## Multi Processing Notes
 
-When deploying NetBox in a multiprocess mannor--such as using Gunicorn as recomented in the installation docs--the Prometheus client library requires the use of shared directory
-to collect metrics from all processes. This can be any arbitrary directory to which the processes have read/write access. This directory is then made available by use of the
+When deploying NetBox in a multiprocess mannor--such as using Gunicorn as recomented in the installation docs--the Prometheus client library requires the use of a shared directory
+to collect metrics from all the worker processes. This can be any arbitrary directory to which the processes have read/write access. This directory is then made available by use of the
 `prometheus_multiproc_dir` environment variable.
 
-This can be setup by first creating a shared directory and then adding this line to the `[program:netbox]` section of the supervisor config file.
+This can be setup by first creating a shared directory and then adding this line (with the appropriate directory) to the `[program:netbox]` section of the supervisor config file.
 
 ```
 environment=prometheus_multiproc_dir=/tmp/prometheus_metrics