Skip to content
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.

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

Add Grafana dashboard and installation steps #1620

Merged
merged 8 commits into from
Mar 8, 2024

Conversation

sjberman
Copy link
Contributor

@sjberman sjberman commented Feb 27, 2024

Problem: As a user, I want to know how to easily install prometheus and grafana to visualize my NGF metrics.

Solution: Add basic installation steps for both prometheus and grafana, and provide a sample dashboard (based on the nginx-prometheus-exporter dashboard)

Screenshot 2024-02-29 at 8 48 39 AM

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

Added sample Grafana dashboard

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 27, 2024
@kate-osborn
Copy link
Contributor

@sjberman good stuff! Can you add a screenshot of the dashboard to the PR description?

@sjberman sjberman marked this pull request as ready for review February 28, 2024 22:33
@sjberman sjberman requested review from a team as code owners February 28, 2024 22:33
Copy link
Member

@ciarams87 ciarams87 left a comment

Choose a reason for hiding this comment

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

🚀

Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

LGTM, made a bunch of edit suggestions.

site/content/how-to/monitoring/prometheus.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/prometheus.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/prometheus.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/prometheus.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/prometheus.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/prometheus.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/prometheus.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/prometheus.md Outdated Show resolved Hide resolved
Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

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

🚀 🚀

Problem: As a user, I want to know how to easily install prometheus and grafana to visualize my NGF metrics.

Solution: Add basic installation steps for both prometheus and grafana, and provide a sample dashboard (based on the nginx-prometheus-exporter dashboard)
@sjberman sjberman enabled auto-merge (squash) March 8, 2024 16:25
@sjberman sjberman merged commit 5216f00 into nginxinc:main Mar 8, 2024
36 checks passed
@sjberman sjberman deleted the docs/prom-grafana branch March 8, 2024 16:39
amimimor pushed a commit to amimimor/nginx-gateway-fabric that referenced this pull request Apr 3, 2024
Problem: As a user, I want to know how to easily install prometheus and grafana to visualize my NGF metrics.

Solution: Add basic installation steps for both prometheus and grafana, and provide a sample dashboard (based on the nginx-prometheus-exporter dashboard)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation release-notes
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants