From b7454018179ba793598d1f752ed06c85eef8f639 Mon Sep 17 00:00:00 2001 From: John Anderson Date: Thu, 20 Jun 2019 00:04:44 -0400 Subject: [PATCH] prometheus docs updates --- CHANGELOG.md | 2 +- docs/additional-features/prometheus-metrics.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 57093ad74..75e522ec8 100644 --- a/CHANGELOG.md +++ b/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: diff --git a/docs/additional-features/prometheus-metrics.md b/docs/additional-features/prometheus-metrics.md index 840b7b51e..0aa944b74 100644 --- a/docs/additional-features/prometheus-metrics.md +++ b/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