# Prometheus Paperless NGX Exporter

Prometheus Paperless NGX Exporter is a self-hosted monitoring & logging app. Prometheus metrics exporter for Paperless-NGX, a document management system transforming physical documents into a searchable online archive. It is open source and self-hosted, installable on Proxmox and Unraid.

Canonical page: https://ourlocalhost.com/app/6437/prometheus-paperless-ngx-exporter

## Description

Prometheus metrics exporter for Paperless-NGX, a document management system transforming physical documents into a searchable online archive. The exporter relies on Paperless' REST API.

## Platform availability

Available on 2 of 10 platforms: Unraid, Proxmox.

## Health score

63/100 (Good), based on 4 of 5 factors.
- Maintained: 84 (last commit 17 days ago)
- Popular: 38 (78 GitHub stars)
- Easy to install: 15 (0 install platforms, install notes)
- Security check: 100 (no serious findings, CI, tests)

## Links

- GitHub: https://github.com/hansmi/prometheus-paperless-exporter
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=prometheus-paperless-ngx-exporter
- Unraid: https://ca.unraid.net/apps?q=Prometheus-Paperless-NGX-Exporter&app=991mw8

## Common questions

### Does this exporter automatically copy Paperless-ngx documents to a folder?

No. It is a Prometheus metrics exporter that relies on Paperless' REST API.

### What Prometheus timing settings can make the exporter unhealthy?

Set the scrape interval and scrape timeout before starting Prometheus. If the timeout is longer than the interval or too short for the exporter, Prometheus may mark the target as unhealthy.

### What port setting can cause the exporter to appear down?

Make sure the port where the exporter listens is open and reachable by Prometheus. If the port is blocked, Prometheus cannot fetch the metrics and will show the target as down.

## Alternatives

- Amazon CloudWatch: Amazon CloudWatch is a monitoring service for AWS cloud resources and the applications running on AWS.
- Better Stack: AI-driven monitoring platform providing incident management, real-time logs, uptime, traces, error tracking, infrastructure analytics, and…
- Datadog: Datadog Agent is an on-host monitoring agent that collects metrics, logs, and traces from hosts, containers, and Kubernetes clusters and se…
- DeepFlow: Unify your cloud-native monitoring with zero-code eBPF, advanced profiling, and 10x storage efficiency.
- Grafana Loki: Grafana Loki is an open-source log aggregation system.
- Graylog: Graylog is a centralized log management platform built on open standards for capturing, storing, and analyzing terabytes of machine data in…
- InfluxDB: InfluxDB is an open source time series database with no external dependencies.
- Kibana: Kibana is the data visualization layer for querying, analyzing, and managing data stored in Elasticsearch.
- New Relic: Pinpoint and solve performance issues in your Ruby, Java, .NET, PHP and Python apps with real user, application and server monitoring.
- Prometheus: Prometheus is a systems and service monitoring system.
- Splunk: Splunk is a self-hosted platform for collecting, indexing, searching, and analyzing log and security data, helping homelabbers and operatio…
- VictoriaMetrics: VictoriaMetrics is a fast, cost-effective, and scalable open-source time-series database that stores long-term monitoring metrics, accepts…

---
Source: Our Local Host (https://ourlocalhost.com/app/6437/prometheus-paperless-ngx-exporter), the self-hosted and open-source app directory.
