Skip to content

docs: add getting started guide for Prometheus metrics#5505

Merged
ispeakc0de merged 3 commits into
litmuschaos:masterfrom
akhilmukkara:docs/prometheus-metrics-getting-started
May 8, 2026
Merged

docs: add getting started guide for Prometheus metrics#5505
ispeakc0de merged 3 commits into
litmuschaos:masterfrom
akhilmukkara:docs/prometheus-metrics-getting-started

Conversation

@akhilmukkara

@akhilmukkara akhilmukkara commented May 7, 2026

Copy link
Copy Markdown
Contributor

Proposed changes

Adds a getting started guide for setting up Prometheus scraping and Grafana visualization for the LitmusChaos GraphQL server metrics.

Types of changes

What types of changes does your code introduce to Litmus? Put an x in the boxes that apply

  • New feature (non-breaking change which adds functionality)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices applies)

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the commit for DCO to be passed.
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have added necessary documentation (if appropriate)

Dependency

#5495

Special notes for your reviewer:

@akhilmukkara akhilmukkara force-pushed the docs/prometheus-metrics-getting-started branch from 7e815fa to 54c8f5a Compare May 7, 2026 16:04
@ispeakc0de ispeakc0de requested a review from Copilot May 8, 2026 12:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a “getting started” guide to help users scrape LitmusChaos GraphQL server Prometheus metrics and visualize them via the included Grafana dashboard.

Changes:

  • Add a new Prometheus + Grafana setup walkthrough for the GraphQL server metrics endpoint.
  • Include example Kubernetes Service and ServiceMonitor manifests for scraping /metrics.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread chaoscenter/graphql/server/pkg/metrics/getting-started.md
Comment thread chaoscenter/graphql/server/pkg/metrics/getting-started.md
Comment thread chaoscenter/graphql/server/pkg/metrics/getting-started.md
Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>
Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>
Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>
@akhilmukkara akhilmukkara force-pushed the docs/prometheus-metrics-getting-started branch from e7324da to 0c4b587 Compare May 8, 2026 16:20
@ispeakc0de ispeakc0de merged commit 7fb683f into litmuschaos:master May 8, 2026
21 checks passed
Calvinaud pushed a commit to Calvinaud/litmus that referenced this pull request Jun 9, 2026
)

* docs: add getting started guide for Prometheus metrics

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>

* fix: update deployment name and selector in getting started guide

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>

* fix: update ExperimentStatus value description in README

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>

---------

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>
Signed-off-by: Calvin Audier <calvin.audier@amadeus.com>
pcandido pushed a commit to pcandido/litmus that referenced this pull request Jun 24, 2026
)

* docs: add getting started guide for Prometheus metrics

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>

* fix: update deployment name and selector in getting started guide

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>

* fix: update ExperimentStatus value description in README

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>

---------

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>
Signed-off-by: Paulo Cândido <paulo.candido@ifood.com.br>
shovan-mondal pushed a commit to shovan-mondal/litmus that referenced this pull request Jun 24, 2026
)

* docs: add getting started guide for Prometheus metrics

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>

* fix: update deployment name and selector in getting started guide

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>

* fix: update ExperimentStatus value description in README

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>

---------

Signed-off-by: Akhil Mukkara <akhil.mukkara@gmail.com>
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.

3 participants