How to monitor status of your navidrome instance
Currently, navidrome supports monitoring and alerting using Prometheus/OpenMetrics standard. Example Grafana dashboard:
You need to set
ND_PROMETHEUS_ENABLED to enable Prometheus metrics endpoint.
ND_PROMETHEUS_METRICSPATH is highly recommended if your Navidrome
instance is publicly available.
Minimal docker compose example file with metrics enabled:
version: '3' services: navidrome: image: deluan/navidrome user: 1000:1000 # should be owner of volumes ports: - "4533:4533" environment: ND_PROMETHEUS_ENABLED: "true" ND_PROMETHEUS_METRICSPATH: "/metrics_SOME_SECRET_KEY" volumes: - "./data:/data" - "./music:/music"
prometheus.yml config to parse this instance:
global: scrape_interval: 10s scrape_configs: - job_name: 'navidrome' metrics_path: /metrics_SOME_SECRET_KEY scheme: http static_configs: - targets: ['YOUR_IP_HERE:4533']
Grafana dashboard available here: #18038.
Simple to install but fully fledged Grafana docker compose configuration can be found here.
Was this page helpful?
Glad to hear it! Please tell us how we can make it even better.
Sorry to hear that. Please tell us how we can improve.
Last modified February 8, 2023: doc: Add monitoring page (#106) (9cc3dff)