Skip to content

Prometheus metrics endpoint path documentation #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davpsh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Prometheus metrics endpoint path documentation #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,12 +280,13 @@ The Prometheus module collects metrics from other modules and exposes an HTTP en

The following flags allow you to configure the Prometheus module:

| Flag | Environment variable | Description | Default |
|--------------------------------------------------------------------------------|------------------------------------------------------------------------------|---------------------------------------------------|-----------|
| <span class="badge badge--secondary">--prometheus-collect-interval</span> | <span class="badge badge--secondary">PROMETHEUS_COLLECT_INTERVAL</span> | Set the interval for collecting modules' metrics. | 1s |
| <span class="badge badge--secondary">--prometheus-namespace</span> | <span class="badge badge--secondary">PROMETHEUS_NAMESPACE</span> | Set the namespace of modules' metrics. | gotenberg |
| <span class="badge badge--secondary">--prometheus-disable-collect</span> | <span class="badge badge--secondary">PROMETHEUS_DISABLE_COLLECT</span> | Disable the collect of metrics. | false |
| <span class="badge badge--secondary">--prometheus-disable-route-logging</span> | <span class="badge badge--secondary">PROMETHEUS_DISABLE_ROUTE_LOGGING</span> | Disable the route logging. | false |
| Flag | Environment variable | Description | Default |
|--------------------------------------------------------------------------------|------------------------------------------------------------------------------|---------------------------------------------------|---------------------|
| <span class="badge badge--secondary">--prometheus-metrics-path</span> | <span class="badge badge--secondary">PROMETHEUS_METRICS_PATH</span> | Set the metrics endpoint path. | /prometheus/metrics |
| <span class="badge badge--secondary">--prometheus-collect-interval</span> | <span class="badge badge--secondary">PROMETHEUS_COLLECT_INTERVAL</span> | Set the interval for collecting modules' metrics. | 1s |
| <span class="badge badge--secondary">--prometheus-namespace</span> | <span class="badge badge--secondary">PROMETHEUS_NAMESPACE</span> | Set the namespace of modules' metrics. | gotenberg |
| <span class="badge badge--secondary">--prometheus-disable-collect</span> | <span class="badge badge--secondary">PROMETHEUS_DISABLE_COLLECT</span> | Disable the collect of metrics. | false |
| <span class="badge badge--secondary">--prometheus-disable-route-logging</span> | <span class="badge badge--secondary">PROMETHEUS_DISABLE_ROUTE_LOGGING</span> | Disable the route logging. | false |

## Logging

Expand Down