Adds Prometheus/Grafana monitoring infrastructure

Author: cimnine

README.md

@@ -79,8 +79,11 @@ The default credentials are:
 ## Documentation
 
 Please refer [to our wiki on Github][netbox-docker-wiki] for further information on how to use this Netbox Docker image properly.
-It covers advanced topics such as using secret files, deployment to Kubernetes as well as NAPALM and LDAP configuration.
+You'll learn how to read the integrated metrics using [Prometheus][prometheus] and [Grafana][grafana].
+It also covers advanced topics such as using secret files, deployment to Kubernetes as well as NAPALM and LDAP configuration.
 
+[prometheus]: https://prometheus.io/
+[grafana]: https://grafana.com/grafana/
 [netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/
 
 ## Getting Help

docker-compose.yml

@@ -18,6 +18,9 @@ services:
     - netbox-nginx-config:/etc/netbox-nginx:z
     - netbox-static-files:/opt/netbox/netbox/static:z
     - netbox-media-files:/opt/netbox/netbox/media:z
+    - type: tmpfs
+      target: /tmp/metrics
+      read_only: false
   netbox-worker:
     <<: *netbox
     depends_on:
@@ -27,6 +30,8 @@ services:
     - /opt/netbox/netbox/manage.py
     command:
     - rqworker
+
+  # nginx
   nginx:
     command: nginx -c /etc/netbox-nginx/nginx.conf
     image: nginx:1.19-alpine
@@ -37,27 +42,85 @@ services:
     volumes:
     - netbox-static-files:/opt/netbox/netbox/static:ro
     - netbox-nginx-config:/etc/netbox-nginx/:ro
+
+  nginx-exporter:
+    image: nginx/nginx-prometheus-exporter
+    depends_on:
+    - nginx
+    command:
+    - -nginx.scrape-uri
+    - http://nginx:8081/stub_status
+
+  # postgres
   postgres:
     image: postgres:12-alpine
     env_file: env/postgres.env
     volumes:
     - netbox-postgres-data:/var/lib/postgresql/data
-  redis:
+
+  postgres-exporter:
+    image: wrouesnel/postgres_exporter:v0.8.0
+    depends_on:
+    - postgres
+    env_file: env/postgres-exporter.env
+
+  # redis
+  redis: &redis
     image: redis:6-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
     - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
-    env_file: env/redis.env
+    env_file: env/redis-worker.env
     volumes:
     - netbox-redis-data:/data
   redis-cache:
     image: redis:6-alpine
     command:
     - sh
     - -c # this is to evaluate the $REDIS_PASSWORD from the env
-    - redis-server --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
+    - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD ## $$ because of docker-compose
     env_file: env/redis-cache.env
+
+  redis-worker-exporter:
+    image: oliver006/redis_exporter
+    depends_on:
+    - redis
+    env_file: env/redis-worker-exporter.env
+  redis-cache-exporter:
+    image: oliver006/redis_exporter
+    depends_on:
+    - redis-cache
+    env_file: env/redis-cache-exporter.env
+
+  # prometheus
+  prometheus:
+    image: prom/prometheus:v2.22.0
+    depends_on:
+    - postgres-exporter
+    - redis-cache-exporter
+    - redis-worker-exporter
+    - nginx-exporter
+    - netbox
+    ports:
+    - 9090
+    volumes:
+    - ./monitoring/prometheus/:/etc/prometheus/
+    - prometheus-data:/prometheus/data
+
+  # grafana
+  grafana:
+    image: grafana/grafana:7.2.1
+    depends_on:
+    - prometheus
+    ports:
+    - 3000
+    volumes:
+    - ./monitoring/grafana/plugins/:/var/lib/grafana/plugins/:z,ro
+    - ./monitoring/grafana/provisioning/:/etc/grafana/provisioning/:z,ro
+    - ./monitoring/grafana/dashboards/:/etc/grafana/dashboards/:z,ro
+    - grafana-data:/var/lib/grafana
+
 volumes:
   netbox-static-files:
     driver: local
@@ -69,3 +132,7 @@ volumes:
     driver: local
   netbox-redis-data:
     driver: local
+  prometheus-data:
+    driver: local
+  grafana-data:
+    driver: local

docker/gunicorn_config.py

@@ -6,3 +6,4 @@
 accesslog = '-'
 capture_output = False
 loglevel = 'info'
+raw_env = 'prometheus_multiproc_dir=/tmp/metrics'

docker/nginx.conf

@@ -32,4 +32,13 @@ http {
             add_header P3P 'CP="ALL DSP COR PSAa PSDa OUR NOR ONL UNI COM NAV"';
         }
     }
+
+    server {
+        listen      8081;
+        access_log  off;
+
+        location = /stub_status {
+            stub_status;
+        }
+    }
 }

env/grafana.env

@@ -0,0 +1,3 @@
+GF_SECURITY_ADMIN_USER=admin
+GF_SECURITY_ADMIN_PASSWORD=admin
+GF_SECURITY_SECRET_KEY=oew5RCBGGBba0MdsEKrj

env/netbox.env

@@ -14,11 +14,12 @@ EMAIL_USE_SSL=false
 EMAIL_USE_TLS=false
 EMAIL_SSL_CERTFILE=
 EMAIL_SSL_KEYFILE=
+MAX_PAGE_SIZE=1000
 MEDIA_ROOT=/opt/netbox/netbox/media
+METRICS_ENABLED=true
 NAPALM_USERNAME=
 NAPALM_PASSWORD=
 NAPALM_TIMEOUT=10
-MAX_PAGE_SIZE=1000
 REDIS_HOST=redis
 REDIS_PASSWORD=H733Kdjndks81
 REDIS_DATABASE=0
@@ -27,6 +28,7 @@ REDIS_CACHE_HOST=redis-cache
 REDIS_CACHE_PASSWORD=t4Ph722qJ5QHeQ1qfu36
 REDIS_CACHE_DATABASE=1
 REDIS_CACHE_SSL=false
+RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases
 SECRET_KEY=r8OwDznj!!dci#P9ghmRfdu1Ysxm0AiPeDCQhKE+N_rClfWNj
 SKIP_STARTUP_SCRIPTS=false
 SKIP_SUPERUSER=false
@@ -35,4 +37,3 @@ SUPERUSER_EMAIL=admin@example.com
 SUPERUSER_PASSWORD=admin
 SUPERUSER_API_TOKEN=0123456789abcdef0123456789abcdef01234567
 WEBHOOKS_ENABLED=true
-RELEASE_CHECK_URL=https://api.github.com/repos/netbox-community/netbox/releases

env/postgres-exporter.env

@@ -0,0 +1,4 @@
+DATA_SOURCE_URI=postgres?sslmode=disable
+DATA_SOURCE_USER=netbox
+DATA_SOURCE_PASS=J5brHrAXFLQSif0K
+PG_EXPORTER_AUTO_DISCOVER_DATABASES=true

env/redis-cache-exporter.env

@@ -0,0 +1,2 @@
+REDIS_ADDR=redis://redis-cache:6379
+REDIS_PASSWORD=t4Ph722qJ5QHeQ1qfu36

env/redis-worker-exporter.env

@@ -0,0 +1,2 @@
+REDIS_ADDR=redis://redis:6379
+REDIS_PASSWORD=H733Kdjndks81