Skip to content

Commit

Permalink
chore(deployment): modify local grafana deployment (#4649)
Browse files Browse the repository at this point in the history
  • Loading branch information
Itay-Tsabary-Starkware authored Mar 4, 2025
1 parent 464a83d commit 0822e6b
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 8 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ __pycache__/

# Python artifacts.
scripts/__pycache__
monitoring_venv/

# Papyrus p2p sync test artifacts.
scripts/papyrus/p2p_sync_e2e_test/data_client/
Expand Down
33 changes: 26 additions & 7 deletions deployments/monitoring/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
global:
scrape_interval: 10s
scrape_interval: 5s
scrape_configs:
- job_name: prometheus
static_configs:
Expand Down

0 comments on commit 0822e6b

Please sign in to comment.