Skip to content

Commit

Permalink
metrics update for the next release
Browse files Browse the repository at this point in the history
  • Loading branch information
gfukushima committed Dec 3, 2024
1 parent a490f08 commit 545c946
Showing 1 changed file with 20 additions and 23 deletions.
43 changes: 20 additions & 23 deletions docs/how-to/monitor/update-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,28 @@ 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 ude to the upgrade of the Prometheus library.

Check failure on line 11 in docs/how-to/monitor/update-metrics.md

View workflow job for this annotation

GitHub Actions / Spelling

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'ude'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'ude'?", "location": {"path": "docs/how-to/monitor/update-metrics.md", "range": {"start": {"line": 11, "column": 45}}}, "severity": "ERROR"}

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)

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` |

0 comments on commit 545c946

Please sign in to comment.