docs: add Grafana dashboard setup guide and provisioning JSON for Prometheus users#1282
Open
Vaishnav88sk wants to merge 2 commits into
Open
docs: add Grafana dashboard setup guide and provisioning JSON for Prometheus users#1282Vaishnav88sk wants to merge 2 commits into
Vaishnav88sk wants to merge 2 commits into
Conversation
…users Signed-off-by: Vaishnav88sk <vaishnavsk8804@gmail.com>
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.
The existing
docs/DASHBOARDS.mdonly covers Kibana (Elastic) dashboards. Users running the Prometheus + Grafana stack - a common open-source observability setup - have no documentation showing how to visualise Jenkins metrics in Grafana.This PR adds:
docs/grafana-dashboard-setup.md- end-to-end guide covering:resource_to_telemetry_conversion(required for label filtering)customObservabilityBackendci_pipeline_run_duration_millisecondsallow-list configdocs/grafana/jenkins-overview.json- provisioning-ready Grafanadashboard JSON with panels for:
service_nametemplate variable for multi-instance filteringdocs/DASHBOARDS.md- added link to the new Grafana guideRelates to the gap identified in
docs/monitoring-metrics.md, which lists all available metrics but provides no Grafana visualisation guidance.Testing done
Documentation and dashboard JSON only - no code changes.
All PromQL expressions in
jenkins-overview.jsonverified against metrics emitted by the plugin (ci_pipeline_run_duration_milliseconds,ci_pipeline_run_queue_duration_milliseconds,jenkins_executor_count,runtime_jvm_memory_usage,http_server_request_duration_seconds)Dashboard JSON imported into Grafana 10.x locally against a Prometheus instance scraping the OTel Collector - all panels render without errors
Provisioning config tested: copied JSON to
/etc/grafana/provisioning/dashboards/and confirmed dashboard appears automatically after Grafana restartAll cross-links in the markdown verified to point to existing files in the repo (
setup-and-configuration.md,monitoring-metrics.md,DASHBOARDS.md)OTel Collector config in the guide tested locally with
otelcol-contrib validate --config otel-collector-config.yamlSubmitter checklist
Fixes #1276