Merge pull request #76 from AET-DevOps26/feature/grafana

Feature/grafana

Author: timn21

.github/workflows/deploy-azure.yml

@@ -118,4 +118,7 @@ jobs:
 
       - name: Summary
         if: success()
-        run: echo "Deployed to http://${{ steps.tf.outputs.public_ip }}:8081" >> "$GITHUB_STEP_SUMMARY"
+        run: |
+          echo "App: http://${{ steps.tf.outputs.public_ip }}:8081" >> "$GITHUB_STEP_SUMMARY"
+          echo "Prometheus: http://${{ steps.tf.outputs.public_ip }}:9090" >> "$GITHUB_STEP_SUMMARY"
+          echo "Grafana: http://${{ steps.tf.outputs.public_ip }}:3000" >> "$GITHUB_STEP_SUMMARY"

README.md

@@ -133,16 +133,22 @@ Open http://localhost:8081
 
 Drop `--build` on subsequent starts if nothing has changed. To stop: `docker compose down`.
 
-#### Monitoring (Prometheus)
+#### Monitoring (Prometheus + Grafana)
 
-`docker compose up` also starts a Prometheus instance that scrapes metrics from all
-backend services. The Spring services expose metrics at `/actuator/prometheus` (via
-Spring Boot Actuator + Micrometer) and `gen-ai` exposes them at `/metrics`.
+`docker compose up` also starts Prometheus and Grafana. Prometheus scrapes metrics
+from all backend services. The Spring services expose metrics at
+`/actuator/prometheus` (via Spring Boot Actuator + Micrometer) and `gen-ai` exposes
+them at `/metrics`.
 
 Open the Prometheus UI at http://localhost:9090 — check http://localhost:9090/targets
 to confirm every service is `UP`. The scrape configuration lives in
 [`monitoring/prometheus.yml`](monitoring/prometheus.yml).
 
+Open Grafana at http://localhost:3000 and log in with `admin` / `bytebite` unless
+you override `GRAFANA_ADMIN_USER` and `GRAFANA_ADMIN_PASSWORD`. Grafana is
+provisioned with the Prometheus datasource and a `ByteBite / ByteBite Overview`
+dashboard from [`monitoring/grafana`](monitoring/grafana).
+
 ---
 
 ### Kubernetes
@@ -160,6 +166,12 @@ helm uninstall bytebite --namespace team-bytebite  # To take down later
 
 Open http://localhost:80
 
+The local Helm values also expose monitoring services when supported by your
+local cluster:
+
+- Prometheus: http://localhost:9090
+- Grafana: http://localhost:3000 (`admin` / `bytebite`)
+
 #### Kubernetes Deployment to the AET cluster
 
 Prerequisite: The `team-bytebite` namespace must exist in the cluster.
@@ -180,3 +192,5 @@ helm uninstall bytebite --namespace team-bytebite  # To take down later
 ```
 
 The app is available at https://team-bytebite.stud.k8s.aet.cit.tum.de
+Grafana is available at https://team-bytebite.stud.k8s.aet.cit.tum.de/grafana
+when `monitoring.enabled` and `monitoring.grafana.ingress.enabled` are true.

compose.yaml

@@ -134,7 +134,25 @@ services:
       - grocery-service
       - gen-ai
 
+  grafana:
+    image: grafana/grafana:11.2.2
+    container_name: bytebite-grafana
+    environment:
+      GF_SECURITY_ADMIN_USER: ${GRAFANA_ADMIN_USER:-admin}
+      GF_SECURITY_ADMIN_PASSWORD: ${GRAFANA_ADMIN_PASSWORD:-bytebite}
+      GF_USERS_DEFAULT_THEME: light
+      GF_METRICS_ENABLED: "true"
+    volumes:
+      - grafana-data:/var/lib/grafana
+      - ./monitoring/grafana/provisioning:/etc/grafana/provisioning:ro
+      - ./monitoring/grafana/dashboards:/var/lib/grafana/dashboards:ro
+    ports:
+      - "3000:3000"
+    depends_on:
+      - prometheus
+
 volumes:
   user-db-data:
   grocery-db-data:
   prometheus-data:
+  grafana-data:

helm/bytebite/README.md

@@ -1,6 +1,7 @@
 # ByteBite Helm Chart
 
-Deploys the ByteBite application (client, api-gateway, user-service, grocery-service, gen-ai) to Kubernetes.
+Deploys the ByteBite application (client, api-gateway, user-service, grocery-service, gen-ai)
+and the optional monitoring stack (Prometheus + Grafana) to Kubernetes.
 
 ## Prerequisites
 
@@ -29,6 +30,11 @@ helm uninstall bytebite --namespace team-bytebite
 | `ingress.tls` | Enable TLS via cert-manager | `true` |
 | `genai.logosKey` | Logos API key for the default gen-ai provider | `""` |
 | `genai.openaiApiKey` | OpenAI API key for the selectable OpenAI provider | `""` |
+| `monitoring.enabled` | Deploy Prometheus and Grafana | `true` |
+| `monitoring.grafana.adminUser` | Grafana admin username | `admin` |
+| `monitoring.grafana.adminPassword` | Grafana admin password | `bytebite` |
+| `monitoring.grafana.ingress.enabled` | Expose Grafana under the main ingress host | `true` |
+| `monitoring.grafana.ingress.path` | Grafana ingress path | `/grafana` |
 | `client.image.tag` | Client image tag | `latest` |
 | `apiGateway.image.tag` | API gateway image tag | `latest` |
 | `userService.image.tag` | User service image tag | `latest` |