Skip to content

Commit d360379

Browse files
authored
docs: Fix quickstart closing tag (#118)
1 parent ea6fb1e commit d360379

File tree

4 files changed

+21
-13
lines changed

4 files changed

+21
-13
lines changed

Cargo.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/modules/ROOT/pages/index.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,12 @@ docker compose up -d
208208
docker compose --profile metrics up -d
209209
----
210210

211-
To view prometheus metrics in a UI, you can use `http://localhost:9090` on your browser.
211+
You can access the monitoring interfaces through your browser:
212212

213-
To view grafana dashboard, you can use `http://localhost:3000` on your browser.
213+
* Prometheus UI: `http://localhost:9090`
214+
* Grafana Dashboard: `http://localhost:3000`
214215

215-
By default, predefined metrics within a dashboard is populated in grafana.
216+
Grafana comes pre-configured with default dashboards and metrics visualizations.
216217

217218
==== Management Commands
218219

docs/modules/ROOT/pages/quickstart.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -326,8 +326,7 @@ cargo run
326326
[source,bash]
327327
----
328328
cargo make docker-compose-up
329-
---
330-
329+
----
331330

332331
The monitor will now:
333332

@@ -459,7 +458,7 @@ Update the webhook URL in the link:https://github.com/OpenZeppelin/openzeppelin-
459458
"body": "${monitor_name} triggered because of a large swap of ${function_0_4} tokens | https://stellar.expert/explorer/public/tx/${transaction_hash}"
460459
}
461460
}
462-
},
461+
}
463462
}
464463
----
465464

src/utils/metrics/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
# Metrics
22

3-
- This folder contains middleware that is used to intercept the requests for all the endpoints as well as the definition of the metrics that are collected.
3+
## Overview
44

5-
- Metrics server is started on port `8081` which collects the metrics from the monitor app and exposes them on the `/metrics` endpoint.
5+
The metrics system provides monitoring capabilities for the OpenZeppelin Monitor application through Prometheus and Grafana integration.
66

7-
- We use `prometheus` to collect metrics from the application. The list of metrics are exposed on the `/metrics` endpoint.
7+
## Architecture
88

9-
- To view prometheus metrics in a UI, you can use `http://localhost:9090` on your browser.
9+
- A metrics server runs on port `8081`
10+
- Middleware intercepts requests across all endpoints
11+
- Metrics are exposed via the `/metrics` endpoint
12+
- Prometheus collects and stores the metrics data
13+
- Grafana provides visualization through customizable dashboards
1014

11-
- To view grafana dashboard, you can use `http://localhost:3000` on your browser.
15+
## Access Points
16+
17+
- Prometheus UI: `http://localhost:9090`
18+
- Grafana Dashboard: `http://localhost:3000`
19+
- Raw Metrics: `http://localhost:8081/metrics`

0 commit comments

Comments
 (0)