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

Metrics changes after prometheus upgrade #624

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Metrics changes after prometheus upgrade #624

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
545c946
metrics update for the next release
gfukushima Dec 3, 2024
0e7d709
fix spelling
gfukushima Dec 4, 2024
9483909
remove blank line
gfukushima Dec 4, 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
42 changes: 19 additions & 23 deletions docs/how-to/monitor/update-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,27 @@ sidebar_position: 3

Manually update Teku metrics for your custom dashboard.

Teku has introduced changes to metric names, adding the `_total` suffix to counter metrics that previously did not have it.
Teku has introduced changes to metric names due to the upgrade of the Prometheus library.

Gauge names are not allowed to end with `total`, therefore metrics as `beacon_proposers_data_total` and `beacon_eth1_current_period_votes_total` are dropping the `_total` suffix

The `_created` timestamps are not returned by default.

Some JVM metrics have changed name to adhere to the OTEL standard (see the table below)
Comment on lines +11 to +17
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Teku has introduced changes to metric names due to the upgrade of the Prometheus library.
Gauge names are not allowed to end with `total`, therefore metrics as `beacon_proposers_data_total` and `beacon_eth1_current_period_votes_total` are dropping the `_total` suffix
The `_created` timestamps are not returned by default.
Some JVM metrics have changed name to adhere to the OTEL standard (see the table below)
With the upgrade of the Prometheus library, Teku introduces the following changes to metric names:
- Gauge names are not allowed to end with `total`, so metrics such as `beacon_proposers_data_total` and `beacon_eth1_current_period_votes_total` are dropping the `_total` suffix.
- The `_created` timestamps are not returned by default.
- Some JVM metric names are changing to adhere to the OTEL standard.


If you are using a custom dashboard, you must update the metric names to reflect these changes.

The following table lists the name changes for Teku metrics:

| Previous Teku metric name | New Teku metric name |
|------------------------------------------------|------------------------------------------------------|
| `beacon_block_blobs_trackers_pool_size` | `beacon_block_blobs_trackers_pool_size_total` |
| `beacon_block_blobs_trackers_pool_stats` | `beacon_block_blobs_trackers_pool_stats_total` |
| `beacon_block_import_delay_counter` | `beacon_block_import_delay_counter_total` |
| `beacon_eth1_request_queue_size` | `beacon_eth1_request_queue_size_total` |
| `beacon_execution_payload_source` | `beacon_execution_payload_source_total` |
| `beacon_teku_version` | `beacon_teku_version_total` |
| `eventbus_event_consumed_count` | `eventbus_event_consumed_count_total` |
| `eventbus_event_failed_count` | `eventbus_event_failed_count_total` |
| `eventbus_event_published_count` | `eventbus_event_published_count_total` |
| `executor_signature_verifications_batch_count` | `executor_signature_verifications_batch_count_total` |
| `executor_signature_verifications_task_count` | `executor_signature_verifications_task_count_total` |
| `network_peer_chain_validation_attempts` | `network_peer_chain_validation_attempts_total` |
| `network_peer_connection_attempt_count` | `network_peer_connection_attempt_count_total` |
| `storage_finalized_state_branch_nodes` | `storage_finalized_state_branch_nodes_total` |
| `storage_finalized_state_leaf_nodes` | `storage_finalized_state_leaf_nodes_total` |
| `storage_finalized_states_stored` | `storage_finalized_states_stored_total` |
| `validator_attestation_publication_delay` | `validator_attestation_publication_delay_total` |
| `validator_block_publication_delay` | `validator_block_publication_delay_total` |
| `validator_duties_performed` | `validator_duties_performed_total` |
| `validator_external_signer_requests` | `validator_external_signer_requests_total` |
| Previous Teku metric name | New Teku metric name |
|------------------------------------------|------------------------------------|
| `beacon_proposers_data_total` | `beacon_proposers_data` |
| `beacon_eth1_current_period_votes_total` | `beacon_eth1_current_period_votes` |
| `jvm_memory_bytes_committed` | `jvm_memory_committed_bytes` |
| `jvm_memory_bytes_init` | `jvm_memory_init_bytes` |
| `jvm_memory_bytes_max` | `jvm_memory_max_bytes` |
| `jvm_memory_bytes_used` | `jvm_memory_used_bytes` |
| `jvm_memory_pool_bytes_committed` | `jvm_memory_pool_committed_bytes` |
| `jvm_memory_pool_bytes_init` | `jvm_memory_pool_init_bytes` |
| `jvm_memory_pool_bytes_max` | `jvm_memory_pool_max_bytes` |
| `jvm_memory_pool_bytes_used` | `jvm_memory_pool_used_bytes` |
Loading