RUN-4816: Document native Prometheus execution metrics - #1939
Merged
Conversation
Adds an Execution Metrics Reference page covering rundeck_executions_total, rundeck_execution_duration_seconds_*, rundeck_executions_running, rundeck_system_info, and rundeck_execution_mode_active — the native Micrometer execution metrics added in Rundeck 6.0, replacing the need for the third-party rundeck_exporter for execution-level stats. Also documents the opt-in job_id/job_name dimension and its cardinality tradeoff, and adds the new rundeck.metrics.execution.job.dimension.enabled property to the monitoring configuration reference. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new documentation reference page for Rundeck 6.0 native (Micrometer) Prometheus execution metrics, and wires it into the existing monitoring docs and navigation so users can discover metric names, labels, and example PromQL queries.
Changes:
- Added an “Execution Metrics Reference” page documenting execution counters/timers/gauges and the optional
job_id/job_namelabel dimension. - Linked the new reference from the monitoring overview and from the monitoring configuration property reference.
- Added the new page to the Administration → Monitoring sidebar section.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/administration/monitoring/monitoring.md | Adds an Execution Metrics subsection and links to the new reference page. |
| docs/administration/monitoring/execution-metrics.md | New reference page describing execution metrics, label behavior, and example PromQL queries. |
| docs/administration/monitoring/configuration.md | Documents the new rundeck.metrics.execution.job.dimension.enabled configuration property and links to the reference. |
| docs/.vuepress/sidebar-menus/administration.ts | Adds the new execution-metrics page to the Administration sidebar navigation. |
Suppressed comments (1)
docs/administration/monitoring/execution-metrics.md:64
- This query is labeled “Average execution duration by project”, but as written it returns one series per full label set (including
statusand optional job labels). Aggregate byprojectso the result matches the description.
rate(rundeck_execution_duration_seconds_sum[5m])
/
rate(rundeck_execution_duration_seconds_count[5m])
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Use Prometheus series names (underscores, _total suffix) instead of Micrometer dotted names in the monitoring.md Execution Metrics bullets, matching the linked reference page - Fix rundeck_executions_running tag description: it carries project (+ optional job tags) only, not status, since in-flight executions have no final status yet - Aggregate by project in the "Average execution duration by project" query so the result matches its label Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
fdevans
approved these changes
Aug 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
rundeck_executions_total,rundeck_execution_duration_seconds_*,rundeck_executions_running,rundeck_system_info, andrundeck_execution_mode_active— the native Micrometer execution metrics added in Rundeck 6.0job_id/job_namedimension and cleanup behavior on job deletionrundeck.metrics.execution.job.dimension.enabledto the monitoring configuration referenceRelated to RUN-4816 (rundeck/rundeck PR #10486).
Test plan
npm run docs:buildpasses with no dead-link warningsnpm run docs:devat/administration/monitoring/execution-metrics.md🤖 Generated with Claude Code