Prometheus Paperless NGX Exporter

Prometheus metrics exporter for Paperless-NGX, a document management system transforming physical documents into a searchable online archive.

  • Monitoring & Logging
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
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

63/100 Good

Maintained
84last commit 17 days ago
Popular
3878 GitHub stars
Easy to install
150 install platforms, install notes
Light to run
No data
Security check
100no serious findings, CI, tests

Based on 4 of 5 factors.

GitHub stars
78
Open issues
8
Last commit
2026-11-04
Latest release
v0.0.10
License
BSD-3-Clause
Activity
rising

Checked 2 days ago - source: GitHub (hansmi/prometheus-paperless-exporter)

Resources & Compatibility

Requirements not published yet.

First-install notes

  • Set Prometheus scrape timing in global config Use the global YAML (text settings) block as a starting template, and set the scrape interval (how often to collect data) and scrape timeout (how long to wait) before starting Prometheus. If the timeout is longer than the interval, or too short for your exporter, Prometheus may mark the target as unhealthy. source
  • Open the port where your exporter listens The example metrics endpoints use network ports (the numbered addresses where software listens for traffic) 8080, 8081, and 8082, so if your exporter uses similar endpoints, make sure those ports are open and reachable by Prometheus. If the port is blocked, Prometheus cannot fetch the metrics and will show the target as down. source
  • Check if Prometheus sees the exporter After setup, use the Prometheus /api/v1/targets endpoint (a web address that lists the sources it is watching) to see whether the exporter is up and returning data; curl is a command-line tool that can make this request. This helps you tell whether a missing graph is a configuration or reachability problem instead of a broken exporter. source

Fetched 53 days ago - each note links to its source

Alternatives (12)

  • 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…

Checked 40 days ago - source: AlternativeTo

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.

Answers sourced from github.com, github.com, github.com

Community

Collected 48 days ago - public community threads