Skip to content

Commit 1f7d073

Browse files
committed
refactor: simplify metrics handling and enhance README dashboard description
1 parent 8ad268e commit 1f7d073

File tree

4 files changed

+779
-886
lines changed

4 files changed

+779
-886
lines changed

apps/price_pusher/README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ This will start:
303303
- Prometheus server on port 9090 with the alerts configured in alerts.sample.yml
304304
- Grafana server on port 3000 with default credentials (admin/admin)
305305

306-
The docker-compose.metrics.sample.yaml file includes a pre-configured Grafana dashboard that displays all the metrics mentioned above. You can check this dashboard to see charts for wallet balance, price update statistics, errors, and other key metrics. The dashboard is automatically provisioned when you start the stack with docker-compose.
306+
The docker-compose.metrics.sample.yaml file includes a pre-configured Grafana dashboard (see the [Dashboard](#dashboard) section below) that displays all the metrics mentioned above. This dashboard provides monitoring of your price pusher operations with panels for configured feeds, active feeds, wallet balance, update statistics, and error tracking. The dashboard is automatically provisioned when you start the stack with docker-compose.
307307

308308
Alternatively, if you prefer to set up the monitoring stack manually:
309309

@@ -376,6 +376,23 @@ pyth_wallet_balance
376376
pyth_wallet_balance < 0.1
377377
```
378378

379+
### Dashboard
380+
381+
The docker-compose setup includes a pre-configured Grafana dashboard (`grafana-dashboard.sample.json`) that provides monitoring of your price pusher operations. Based on the screenshot, the dashboard includes the following panels:
382+
383+
- **Configured Price Feeds**: Shows the number of price feeds configured in your price-config file.
384+
- **Active Price Feeds**: Displays the number of price feeds currently being actively monitored.
385+
- **Time Since Last Update**: Shows how long it's been since the last successful price update was published on-chain.
386+
- **Price Feeds List**: A table listing all configured price feeds with their details.
387+
- **Price Updates (Last Hour)**: Graph showing the number of price updates over the last hour with timeline.
388+
- **Wallet Balance**: Current balance of your wallet in native token units.
389+
- **Wallet Balance Over Time**: Graph tracking your wallet balance over time to monitor consumption.
390+
- **Update Errors**: Tracks errors encountered during price update operations.
391+
392+
When you first start the monitoring stack, the dashboard may show "No data" in the panels until the price pusher has been running for some time and has collected sufficient metrics.
393+
394+
This dashboard is automatically provisioned when you start the docker-compose stack and provides visibility into the health and performance of your price pusher deployment.
395+
379396
### Alerting
380397

381398
The price pusher includes pre-configured Prometheus alerting rules in the `alerts.sample.yml` file. These rules monitor various aspects of the price pusher's operation, including:

0 commit comments

Comments
 (0)