Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: prometheus metrics #204

Merged
merged 2 commits into from
Dec 9, 2024
Merged

docs: prometheus metrics #204

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
700dffc
prometheus metrics
samricotta Dec 6, 2024
715aba9
update metrics
samricotta Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion docs/finality-provider-operation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -634,4 +634,34 @@ removal from the active set.
> ⚠️ **Critical**: Slashing is irreversible and results in
> permanent removal from the network.

<!-- TODO: PROMETHEUS METRICS -->
### 5.5 Prometheus

The finality provider exposes Prometheus metrics for monitoring your
finality provider. The metrics endpoint is configurable in `fpd.conf`:
samricotta marked this conversation as resolved.
Show resolved Hide resolved

#### Core Metrics

1. **Status for Finality Providers**
- `fp_status`: Current status of a finality provider
- `babylon_tip_height`: The current tip height of the Babylon network
- `last_polled_height`: The most recent block height checked by the poller

2. **Key Operations**
- `fp_seconds_since_last_vote`: Seconds since the last finality sig vote
- `fp_seconds_since_last_randomness`: Seconds since the last public
randomness commitment
- `fp_total_failed_votes`: The total number of failed votes
- `fp_total_failed_randomness`: The total number of failed
randomness commitments

Each metric with `fp_` prefix includes the finality provider's BTC public key
hex as a label.

> 💡 **Tip**: Monitor these metrics to detect issues before they lead to jailing:
> - Large gaps in `fp_seconds_since_last_vote`
> - Increasing `fp_total_failed_votes`

For a complete list of available metrics, see:
- Finality Provider metrics: [fp_collectors.go](../metrics/fp_collectors.go)
- EOTS metrics: [eots_collectors.go](../metrics/eots_collectors.go)

Loading