From 0822e6b53881f6365192440c8fb9cda68047d71b Mon Sep 17 00:00:00 2001
From: Itay-Tsabary-Starkware
 <106665835+Itay-Tsabary-Starkware@users.noreply.github.com>
Date: Tue, 4 Mar 2025 14:27:10 +0200
Subject: [PATCH] chore(deployment): modify local grafana deployment (#4649)

---
 .gitignore                                    |  1 +
 deployments/monitoring/README.md              | 33 +++++++++++++++----
 .../local/config/prometheus/prometheus.yml    |  2 +-
 3 files changed, 28 insertions(+), 8 deletions(-)

diff --git a/.gitignore b/.gitignore
index f6293a125d5..1a9a95969ee 100644
--- a/.gitignore
+++ b/.gitignore
@@ -32,6 +32,7 @@ __pycache__/
 
 # Python artifacts.
 scripts/__pycache__
+monitoring_venv/
 
 # Papyrus p2p sync test artifacts.
 scripts/papyrus/p2p_sync_e2e_test/data_client/
diff --git a/deployments/monitoring/README.md b/deployments/monitoring/README.md
index 8541b056989..b227298716d 100644
--- a/deployments/monitoring/README.md
+++ b/deployments/monitoring/README.md
@@ -1,26 +1,45 @@
 # Local Monitoring Stack
 
-## Requirements:
+### Requirements:
 - Python3
-- docker >= 27.3.1 - https://docs.docker.com/engine/install/ubuntu/
+- docker >= 27.3.1 - (installation guide https://docs.docker.com/engine/install/ubuntu/)
 
-## Deploy:
+### Setup:
 ```bash
 python3 -m venv monitoring_venv
 source monitoring_venv/bin/activate
+```
+
+### Start up:
+To run with docker cache:
+```bash
 ./deployments/monitoring/deploy_local_stack.sh up -d
 ```
 
-### This will deploy a local stack of:
+To force build (useful to enforce applying changes in docker file settings):
+```bash
+./deployments/monitoring/deploy_local_stack.sh up -d --build
+```
+
+## This will deploy a local stack of:
 - Sequencer Node Setup
-- Sequencer Node (The config is generated by **Sequencer Node Setup**.)
+- Sequencer Node (using a config generated by **Sequencer Node Setup**.)
 - Sequencer Node Simulator
 - Dummy Cende Recorder
 - Prometheus
 - Grafana (Using: [dev_grafana.json](../../Monitoring/sequencer/dev_grafana.json) dashboard.)
 
-### Open Grafana:
-When the script finish doing its work, open http://localhost:3000 in a web browser.
+Once the node starts emitting logs, one can ctrl+c to move the run to the background.
+
+## Open Grafana:
+After Grafana starts running, it can be viewed by accessing http://localhost:3000 in a web browser.
+
+## Troubleshooting
+If encountering `Failed to deploy the monitoring stack locally`, verify the docker version is adequate:
+```
+docker --version
+docker compose --version
+```
 
 ## Shutdown & Cleanup:
 ```bash
diff --git a/deployments/monitoring/local/config/prometheus/prometheus.yml b/deployments/monitoring/local/config/prometheus/prometheus.yml
index aced1b28a59..87afb99c8aa 100644
--- a/deployments/monitoring/local/config/prometheus/prometheus.yml
+++ b/deployments/monitoring/local/config/prometheus/prometheus.yml
@@ -1,5 +1,5 @@
 global:
-  scrape_interval: 10s
+  scrape_interval: 5s
 scrape_configs:
  - job_name: prometheus
    static_configs: