Commit 8c7a085b authored by Dimitrios Giannopoulos's avatar Dimitrios Giannopoulos
Browse files

feat: updated README

parent a8d1b140
Loading
Loading
Loading
Loading
Loading
+19 −18
Original line number Diff line number Diff line
# Openslice Pod Metrics Dashboard (Grafana)
# Openslice Pod Metrics and Logs Dashboard (Grafana)

To visualize Kubernetes pod metrics for Openslice, you have the following options:
A dashboard to visualize Kubernetes pod metrics and logs.

## Option 1: Use Grafana Dashboard ID
## Prerequisites

1. Open your Grafana instance.
2. Go to **"Import"**.
3. Enter dashboard ID `14350`.
4. Select your Prometheus data source.
5. In the **"namespace"** dropdown, select `openslice`.
- **Grafana**  
  A running Grafana instance (v7.0+ recommended).  
- **Prometheus data source**  
  - Must be added in Grafana and scraping your cluster’s metrics (e.g. via kube-prometheus or another Prometheus setup).  
- **Loki data source** 
  - Must be added in Grafana to include pod logs alongside metrics.  
- **Kubernetes metrics exposure**  
  - Metrics-server or Prometheus exporters installed so that Prometheus can scrape pod-level metrics.  

This option includes a dashboard with metrics only.
## Import Dashboard from JSON

## Option 2: Use the Predefined JSON Dashboard

1. Locate the file:  
   `kubernetes/helm/openslice/files/observability/grafana_osl_dashboard.json`
2. In Grafana, go to **"Import"**.
3. Upload or paste the JSON content.
4. This version may need some more work since you may have to configure the Prometheus and Loki data sources.

This option includes a dashboard with both metrics and logs.
1. In your Grafana UI, click **“Import”**.  
2. Under **“Upload JSON file”**, select  
   `kubernetes/helm/openslice/files/observability/grafana_osl_dashboard.json`.  
3. Choose your **Prometheus** data source.  
4. Choose your **Loki** data source.  
5. Click **“Import”**.
6. In the **“namespace”** variable dropdown, select `openslice`.