simono41/prometheus-paperless-exporter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
19 commits 1 branch 4 tags 82 KiB
Go 97.7%
Shell 1.3%
Dockerfile 1%
Find a file
Michael Hanselmann accef42121
Some checks failed
Run tests / test (push) Has been cancelled
Details
Release / release (push) Has been cancelled
Details
Remove scheduled CI runs 
Running on changes is sufficient.
2024-01-06 10:10:18 +01:00
.github Remove scheduled CI runs 2024-01-06 10:10:18 +01:00
contrib Add a docker-compose example for using the exporter 2024-01-06 10:07:20 +01:00
internal Initial commit 2023-07-03 00:16:08 +02:00
.gitignore Initial commit 2023-07-03 00:16:08 +02:00
.goreleaser.yml Initial commit 2023-07-03 00:16:08 +02:00
collector.go Initial commit 2023-07-03 00:16:08 +02:00
collector_test.go Initial commit 2023-07-03 00:16:08 +02:00
correspondent.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
correspondent_test.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
documenttype.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
documenttype_test.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
go.mod Bump github.com/hansmi/paperhooks from 0.0.6 to 0.0.8 2024-01-06 00:36:14 +01:00
go.sum Bump github.com/hansmi/paperhooks from 0.0.6 to 0.0.8 2024-01-06 00:36:14 +01:00
LICENSE Initial commit 2023-07-03 00:16:08 +02:00
log.go Initial commit 2023-07-03 00:16:08 +02:00
log_test.go Initial commit 2023-07-03 00:16:08 +02:00
main.go Initial commit 2023-07-03 00:16:08 +02:00
multicollector.go Initial commit 2023-07-03 00:16:08 +02:00
README.md Add a docker-compose example for using the exporter 2024-01-06 10:07:20 +01:00
storagepath.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
storagepath_test.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
tag.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
tag_test.go Bump github.com/hansmi/paperhooks from 0.0.3 to 0.0.4 2023-07-27 00:14:04 +02:00
task.go Initial commit 2023-07-03 00:16:08 +02:00
task_test.go Initial commit 2023-07-03 00:16:08 +02:00

README.md

Paperless-ngx metrics for Prometheus

Latest release Release workflow CI workflow Go reference

This repository hosts a 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.

An implementation using the API was chosen to provide the same perspective as web browsers.

Usage

prometheus-paperless-exporter listens on TCP port 8081 by default. To listen on another address use the -web.listen-address flag (e.g. -web.listen-address=127.0.0.1:3000).

TLS and HTTP basic authentication is supported through the Prometheus exporter toolkit. A configuration file can be passed to the -web.config flag (documentation).

See the --help output for more flags.

Permissions

Since late 2023 Paperless-ngx supports object permissions. The metrics user requires view permissions on the following types:

  • Admin (for logs)
  • Correspondent
  • Document
  • DocumentType
  • PaperlessTask
  • StoragePath
  • Tag

Installation

Pre-built binaries are provided for all releases:

  • Binary archives (.tar.gz)
  • Debian/Ubuntu (.deb)
  • RHEL/Fedora (.rpm)
  • Microsoft Windows (.zip)

Docker images via GitHub's container registry:

docker pull ghcr.io/hansmi/prometheus-paperless-exporter

With the source being available it's also possible to produce custom builds directly using Go or GoReleaser.

Docker Compose

An example configuration for Docker Compose is available in contrib/docker-compose:

env --chdir contrib/docker-compose docker-compose up