Skip to content

Update Canton metrics reference #870

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

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update Canton metrics reference #870

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
181 changes: 101 additions & 80 deletions docs-main/global-synchronizer/reference/canton-metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Canton Metrics"
description: "Canton node metrics exported for Prometheus scraping."
---

{/* GENERATED_FROM source="DACH-NY/canton" ref="v3.5.1" path="docs-open/src/sphinx/participant/reference/metrics.rst" */}
{/* GENERATED_FROM source="digital-asset/canton" ref="v3.5.7" path="docs-open/src/sphinx/participant/reference/metrics.rst" */}

# Metrics

Expand Down Expand Up @@ -172,6 +172,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Labels**:
> - **name**: The operation/pool for which the metric is registered.

### daml.decryption.latency

> - **Summary**: Latency of decryption requests.
> - **Description**: Measures the latency of decryption operations.
> - **Type**: timer
> - **Qualification**: Latency

### daml.grpc.server

> - **Summary**: Distribution of the durations of serving gRPC requests.
Expand Down Expand Up @@ -645,13 +652,6 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: gauge
> - **Qualification**: Debug

### daml.participant.api.index.transaction_trees_buffer_size

> - **Summary**: The buffer size for transaction trees requests.
> - **Description**: An Pekko stream buffer is added at the end of all streaming queries, allowing to absorb temporary downstream backpressure (e.g. when the client is slower than upstream delivery throughput). This metric gauges the size of the buffer for queries requesting transaction trees.
> - **Type**: counter
> - **Qualification**: Debug

### daml.participant.api.index.updates_buffer_size

> - **Summary**: The buffer size for streaming updates requests.
Expand Down Expand Up @@ -709,22 +709,22 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
### daml.participant.api.indexer.indexer_queue_blocked

> - **Summary**: The amount of blocked enqueue operations for the indexer queue.
> - **Description**: Indexer queue exerts backpressure by blocking asynchronous enqueue operations. This meter measures the amount of such blocked operations, signalling backpressure materializing from downstream.
> - **Type**: meter
> - **Description**: Indexer queue exerts backpressure by blocking asynchronous enqueue operations. This gauge measures the amount of such blocked operations, signalling backpressure materializing from downstream.
> - **Type**: gauge
> - **Qualification**: Debug

### daml.participant.api.indexer.indexer_queue_buffered

> - **Summary**: The size of the buffer before the indexer.
> - **Description**: This buffer is located before the indexer, increasing amount signals backpressure mounting.
> - **Type**: meter
> - **Description**: This gauge is located before the indexer, increasing amount signals backpressure mounting.
> - **Type**: gauge
> - **Qualification**: Debug

### daml.participant.api.indexer.indexer_queue_uncommitted

> - **Summary**: The amount of entries which are uncommitted for the indexer.
> - **Description**: Uncommitted entries contain all blocked, buffered and submitted, but not yet committed entries. This amount signals the momentum of stream processing, and has a theoretical maximum defined by all the queue perameters.
> - **Type**: meter
> - **Description**: Uncommitted entries contain all blocked, buffered and submitted, but not yet committed entries. This amount signals the momentum of stream processing, and has a theoretical maximum defined by all the queue parameters.
> - **Type**: gauge
> - **Qualification**: Debug

### daml.participant.api.indexer.indexer_restart_due_to_missing_contract
Expand Down Expand Up @@ -786,49 +786,42 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: counter
> - **Qualification**: Traffic

### daml.participant.api.lapi.streams.transaction_trees_sent

> - **Summary**: The number of the transaction trees sent over the ledger api.
> - **Description**: The total number of the transaction trees sent over the ledger api streams to all clients.
> - **Type**: counter
> - **Qualification**: Traffic

### daml.participant.api.lapi.streams.updates_sent

> - **Summary**: The number of the flat updates sent over the ledger api.
> - **Description**: The total number of the flat updates sent over the ledger api streams to all clients.
> - **Summary**: The number of the updates sent over the ledger api.
> - **Description**: The total number of the updates sent over the ledger api streams to all clients.
> - **Type**: counter
> - **Qualification**: Traffic

### daml.participant.api.services.current_ledger_end
### daml.participant.api.services.acs

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.get_active_contracts
### daml.participant.api.services.current_ledger_end

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.get_completions
### daml.participant.api.services.get_active_contracts

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.get_events_by_contract_id
### daml.participant.api.services.get_completions

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.get_lf_archive
### daml.participant.api.services.get_events_by_contract_id

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
Expand All @@ -849,14 +842,7 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.get_update_by_id

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.get_update_by_offset
### daml.participant.api.services.get_update

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
Expand Down Expand Up @@ -961,27 +947,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.list_lf_packages

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.lookup_active_contract

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.lookup_configuration

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.lookup_contract_key

> - **Summary**: The time to execute an index service operation.
Expand All @@ -1003,20 +975,6 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.lookup_non_unique_contract_key

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.party_entries

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.prune

> - **Summary**: The time to execute an index service operation.
Expand All @@ -1035,7 +993,7 @@ For the metric types referenced below, see the [relevant Prometheus documentatio

> - **Summary**: Optimistic locking with contention might result in retries. This metric tracks if the operation was retried this many times.
> - **Description**:
> - **Type**: meter
> - **Type**: histogram
> - **Qualification**: Debug

### daml.participant.api.services.pruning.prune.completed
Expand Down Expand Up @@ -1108,28 +1066,14 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.read.state_updates

> - **Summary**: The time to execute a read service operation.
> - **Description**: The read service is an internal interface for reading the events from the synchronization interfaces. The metrics expose the time needed to execute each operation.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.read.validate_dar

> - **Summary**: The time to execute a read service operation.
> - **Description**: The read service is an internal interface for reading the events from the synchronization interfaces. The metrics expose the time needed to execute each operation.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.transaction_trees

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
> - **Type**: timer
> - **Qualification**: Debug

### daml.participant.api.services.transactions
### daml.participant.api.services.updates

> - **Summary**: The time to execute an index service operation.
> - **Description**: The index service is an internal component responsible for access to the index db data. Its operations are invoked whenever a client request received over the ledger api requires access to the index db. This metric captures time statistics of such operations.
Expand Down Expand Up @@ -1520,6 +1464,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Description**: When the sequencer client sends an event to the sequencer to be sequenced, it will record on this metric the cost of the event. Note that the event may or may not end up being sequenced. So this metric may not exactly match the actual consumed traffic.
> - **Type**: meter
> - **Qualification**: Traffic

### daml.signing.latency

> - **Summary**: Latency of signing requests.
> - **Description**: Measures the latency of signing operations.
> - **Type**: timer
> - **Qualification**: Latency
## Sequencer Metrics

### daml.cache.evicted_weight
Expand Down Expand Up @@ -1627,6 +1578,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: timer
> - **Qualification**: Debug

### daml.decryption.latency

> - **Summary**: Latency of decryption requests.
> - **Description**: Measures the latency of decryption operations.
> - **Type**: timer
> - **Qualification**: Latency

### daml.grpc.server

> - **Summary**: Distribution of the durations of serving gRPC requests.
Expand Down Expand Up @@ -1995,6 +1953,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: gauge
> - **Qualification**: Saturation

### daml.sequencer.bftordering.consensus.view-change-progress-latency

> - **Summary**: View change progress latency
> - **Description**: Records the rate and latency it takes to make progress on a view.
> - **Type**: timer
> - **Qualification**: Latency

### daml.sequencer.bftordering.declarative_api.errors

> - **Summary**: Errors for the last update
Expand Down Expand Up @@ -2072,6 +2037,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: histogram
> - **Qualification**: Traffic

### daml.sequencer.bftordering.kms.session-signing-keys-fallback

> - **Summary**: Number of times signing had to fall back to the long-term key, triggering a KMS call.
> - **Description**: Session signing keys are configured to be valid for a short duration. If this duration is too small or a session key is unavailable, the signing process falls back to using the long-term key to ensure request validation succeeds. This metric counts how many times signing required a direct KMS call with the long-term key.
> - **Type**: counter
> - **Qualification**: Saturation

### daml.sequencer.bftordering.mempool.requested-batches

> - **Summary**: Requested batches
Expand Down Expand Up @@ -2184,6 +2156,20 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: timer
> - **Qualification**: Latency

### daml.sequencer.bftordering.sequencer-core-backpressure-current-delay-millis

> - **Summary**: Current sequencer core backpressure delay (ms)
> - **Description**: Current sequencer core backpressure delay in milliseconds.
> - **Type**: gauge
> - **Qualification**: Latency

### daml.sequencer.bftordering.sequencer-core-subscription-buffer-size

> - **Summary**: Sequencer core subscription buffer size
> - **Description**: Size of the buffer for the subscription to the sequencer core output, which is used to apply backpressure to the sequencer core when the output is not consumed fast enough.
> - **Type**: gauge
> - **Qualification**: Saturation

### daml.sequencer.bftordering.topology.max-tolerated-faults

> - **Summary**: Maximum number of tolerated faults
Expand Down Expand Up @@ -2367,6 +2353,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: gauge
> - **Qualification**: Debug

### daml.sequencer.decryption.latency

> - **Summary**: Latency of decryption requests.
> - **Description**: Measures the latency of decryption operations.
> - **Type**: timer
> - **Qualification**: Latency

### daml.sequencer.head_timestamp

> - **Summary**: Timestamp of the head (oldest) event in the buffer
Expand Down Expand Up @@ -2442,6 +2435,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: meter
> - **Qualification**: Debug

### daml.sequencer.signing.latency

> - **Summary**: Latency of signing requests.
> - **Description**: Measures the latency of signing operations.
> - **Type**: timer
> - **Qualification**: Latency

### daml.sequencer.traffic-control.balance-cache-miss-for-timestamp

> - **Summary**: Counts cache misses when trying to retrieve a balance for a given timestamp.
Expand Down Expand Up @@ -2518,6 +2518,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Description**: Counter for wasted-traffic.
> - **Type**: counter
> - **Qualification**: Traffic

### daml.signing.latency

> - **Summary**: Latency of signing requests.
> - **Description**: Measures the latency of signing operations.
> - **Type**: timer
> - **Qualification**: Latency
## Mediator Metrics

### daml.db-storage.general.executor.exectime
Expand Down Expand Up @@ -2597,6 +2604,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: timer
> - **Qualification**: Debug

### daml.decryption.latency

> - **Summary**: Latency of decryption requests.
> - **Description**: Measures the latency of decryption operations.
> - **Type**: timer
> - **Qualification**: Latency

### daml.grpc.server

> - **Summary**: Distribution of the durations of serving gRPC requests.
Expand Down Expand Up @@ -2913,6 +2927,13 @@ For the metric types referenced below, see the [relevant Prometheus documentatio
> - **Type**: meter
> - **Qualification**: Traffic

### daml.signing.latency

> - **Summary**: Latency of signing requests.
> - **Description**: Measures the latency of signing operations.
> - **Type**: timer
> - **Qualification**: Latency

## Health Metrics

The following metrics are exposed for all components.
Expand Down