Skip to content

Document extra scrape metrics. #2891

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
vaxvms wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document extra scrape metrics. #2891

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
9 changes: 9 additions & 0 deletions docs/concepts/jobs_instances.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ the following time series:
* `scrape_series_added{job="<job-name>", instance="<instance-id>"}`:
the approximate number of new series in this scrape. *New in v2.10*

if you enable [`extra-scrape-metrics` feature](/docs/prometheus/latest/feature_flags/#extra-scrape-metrics), you will also get:
Copy link
Member

@krajorama krajorama Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are already documented below.
I think a more important change would be to document that they should be enabled by configuration and that the feature flag is being phased out . See prometheus/prometheus#17606


* `scrape_timeout_seconds{job="<job-name>", instance="<instance-id>"}`:
the configured scrape timeout for a target.
* `scrape_sample_limit{job="<job-name>", instance="<instance-id>"}`:
the configured sample limit for a target.
* `scrape_body_size_bytes{job="<job-name>", instance="<instance-id>"}`:
the uncompressed size of the most recent scrape response, if successful.

The `up` time series is useful for instance availability monitoring.

With the [`extra-scrape-metrics` feature flag](/docs/prometheus/latest/feature_flags/#extra-scrape-metrics) several additional metrics are available:
Expand Down