Skip to content

Commit c665744

Browse files
committed
add observability to loadtest kurtosis guide
1 parent 32397ff commit c665744

File tree

3 files changed

+33
-4
lines changed

3 files changed

+33
-4
lines changed

doc/grafana_panoptchain_menu.png

142 KB
Loading

doc/grafana_panoptchain_panels.png

45.6 KB
Loading

doc/load-testing-guide.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,8 @@ these extra flags:
196196
--rate-limit 2000
197197
```
198198

199-
**Note**: These numbers are based on controlled testnet conditions and may vary depending on hardware, network conditions, and configuration.
199+
**Note**: These numbers are based on controlled testnet conditions and may vary depending on hardware, network
200+
conditions, and configuration.
200201

201202
| Scenario | CDK-Erigon | OP-Geth |
202203
|----------------------|------------|----------|
@@ -207,14 +208,42 @@ these extra flags:
207208

208209
## Monitoring and Visualization (Optional)
209210

210-
TBD
211+
The `cdk-kurtosis` package also supports additional services to run alongside the network, you can find more details
212+
[here](https://github.com/0xPolygon/kurtosis-cdk/blob/main/docs/additional-services.md)
213+
214+
The additional service called `observability` uses the following tools:
215+
- [panoptichain](https://github.com/0xPolygon/panoptichain)
216+
- [prometheus](https://prometheus.io/)
217+
- [grafana](https://grafana.com/)
218+
219+
These tools mentioned above are already configured to extract important information from the network and provide it in a
220+
friendly dashboard that can be accessed via browser. The URL is exposed when the kurtosis package is initialized with
221+
the `observability` service enabled and here is how you can enabled it:
222+
223+
````bash
224+
kurtosis run --enclave cdk github.com/0xPolygon/kurtosis-cdk '{"args": {"additional_services": ["observability"]}}'
225+
````
226+
227+
Now that the environment is running, we can get the URL to access the observability dashboard by running:
228+
```bash
229+
kurtosis port print cdk grafana-001 dashboards
230+
```
231+
232+
Access the dashboard URL in the browser and go to Menu > Dashboards > Panoptchain
233+
![grafana panoptchain menu](grafana_panoptchain_menu.png)
234+
235+
Then you can start using the network and observe the following panels:
236+
237+
![grafana panoptchain panels](grafana_panoptchain_panels.png)
211238

212239
---
213240

214241
## Source
215242

216-
For more details, see the [`polycli` repository](https://github.com/0xPolygon/polygon-cli`).
243+
For more details, see:
244+
- [`polycli` repository](https://github.com/0xPolygon/polygon-cli`)
245+
- [`kurtosis-cdk` repository](https://github.com/0xPolygon/kurtosis-cdk`).
217246

218247
---
219248

220-
_Last updated: 03-JUN-2025_
249+
_Last updated: 05-JUN-2025_

0 commit comments

Comments
 (0)