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

Documented grafana monitoring setup for backend #82

Merged
merged 1 commit into from
Nov 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions Docs/GrafanaMonitoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Integrating Spring Boot with Grafana Dashboard

This guide highlights the key steps for integrating a Spring Boot application with a Grafana dashboard.

This document only gives a brief overview of what was done at every step to intgrate this technology into our project. For a more comprehensive guide refer to the [Scribe Guide](https://scribehow.com/shared/Integrate_Spring_Boot_with_Grafana_Dashboard__F-HZZjkBSiCKE3c9VD_42w).

## Steps to Integrate

1. **Connect to Grafana Cloud**:
- Navigate to your Grafana Cloud instance
- Select application in the sidebar to connect your Spring-Boot app.

2. **Install Grafana Alloy**:
- Create an authentication token for Alloy.
- Configure and test the Alloy connection.

3. **Update Your Codebase**:
- Add dependencies: `spring-boot-starter-actuator` and `micrometer-registry-prometheus`.
- Configure `application.properties` to expose all endpoints.
- Update the Alloy configuration file with the correct Spring Boot endpoint.

4. **Restart Alloy**:
- Restart the Alloy service to apply changes.

5. **Install and View Dashboards**:
- Install relevant dashboards and monitor your application using "Spring Boot Statistics."
Loading