Skip to content

add-custom-labels-to-prom-scrape-job-section - #859

Merged
Dnhem merged 5 commits into
mainfrom
add-custom-labels-to-prom-scrape-job-section
Nov 19, 2026
Merged

Dnhem merged 5 commits into
mainfrom
add-custom-labels-to-prom-scrape-job-section

Conversation

@Dnhem

@Dnhem Dnhem commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

Affected Components

  • Content & Marketing
  • Pricing
  • Test
  • [ x] Docs
  • Learn
  • Other

Notes for the Reviewer

New Dependency Submission

Screenshots

@Dnhem
Dnhem requested review from braxtonj and hlenke November 18, 2026 19:25
@mintlify

mintlify Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Nov 19, 2026, 8:40 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Needs changes · The new section is accurate; align the sample's job name and placeholders with the checkly job from Set up so readers edit that job instead of adding a second one.

The claims hold: the v2 exporter emits no account label (the label table on this page and the exporter source agree), Prometheus attaches static_configs[].labels to every series it scrapes from that target, and https://app.checklyhq.com/accounts/<account_id>/checks/<check_id> is the app's check overview route.

CI. preview-checks failed: 1 of the 5 Checkly checks against the preview failed. The job log does not name the failing check, and the PR only adds prose to one page, so I could not tie it to this change. If it is "Docs no console errors", #860 fixes that failure on previews; re-run the job once it lands. All other checks pass.

Conflicts and overlap. Mergeable; main has not changed this file since the merge base. Draft #830 also edits this page (agent terminology) on other lines, so no conflict is expected.

Inline: 1 important, 1 wording.

What I checked
  • Read the full diff (integrations/observability/prometheus.mdx, +17) from merge base 84c88b6e and the whole page at the PR head.
  • gh pr checks 859, the failed job log (run 44380833211) and its annotations; the log shows 1 failed, 4 passed, 5 total without naming the check.
  • gh pr view (mergeable), git log <base>..origin/main on the file (no changes), open PRs touching the file (#830 draft, #860 unrelated file).
  • scripts/pr_impact.py: no cross-file findings.
  • No account label: the page's Labels table, and the Prometheus v2 exporter module in the monorepo (origin/main@7ae0b41b4d), which builds no account label for any series.
  • Static labels: Prometheus configuration docs, <static_config>: "Labels assigned to all metrics scraped from the targets." https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config
  • App URL: the webapp router nests the check overview route (checks/:checkId) under /accounts/:accountId.
  • No end-to-end test against local Checkly: the section describes Prometheus scrape configuration, not Checkly behavior.

Dnhem and others added 2 commits November 19, 2026 09:27
Co-authored-by: Hannes Lenke <hannes@lenke.at>
Co-authored-by: Hannes Lenke <hannes@lenke.at>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ready to merge · Both items from the previous review are applied, and the section now edits the existing checkly job instead of adding a second one.

This review covers the 3 commits since 762f6e23 (no merge of main in between).

  • Job name and placeholders: the sample now uses job_name: checkly and <your account ID>, matching Set up, with a comment to keep the rest of the job. Fixed.
  • Scope of the label: the paragraph now says the label lands on every series from the target, including heartbeat and private location metrics, and the "This helps when" sentence moved up front; the duplicate paragraph after the YAML is gone. Fixed.

CI. preview-checks still fails with 1 failed, 4 passed, 5 total, and the log does not name the check. The PR changes only prose on one page, so this is not caused by it; #860 (the console-error filter for previews) is still open. Re-run the job once it lands. All other checks pass.

Conflicts and overlap. Mergeable. Draft #830 edits other lines of this page.

No inline comments.

What I checked
  • git diff 762f6e23 64b3ec30 (one file, integrations/observability/prometheus.mdx) and the whole page at the PR head; git log --merges on that range is empty.
  • The previous review's two inline comments against the new text: both applied as suggested.
  • "Every series it scrapes from that target, including heartbeat and private location metrics": Prometheus <static_config> labels are "assigned to all metrics scraped from the targets" (https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config), and the page serves check, heartbeat and private location metrics from the same endpoint.
  • gh pr checks 859; failed run 44489508441 log: the Checkly test session reports 1 of 5 checks failed without naming it.
  • gh pr view 859: MERGEABLE, state UNSTABLE from the failing check. Merge base 84c88b6e.
  • No end-to-end test: the change is Prometheus scrape configuration, not Checkly behavior.

@Dnhem
Dnhem merged commit 4475e99 into main Nov 19, 2026
6 of 7 checks passed
@Dnhem
Dnhem deleted the add-custom-labels-to-prom-scrape-job-section branch November 19, 2026 14:04

This branch was successfully deployed

1 active deployment
staging — 64b3ec30 Deployed Nov 19, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants