From c20755530e4590154777f3ab6046a1c0dd2f1c50 Mon Sep 17 00:00:00 2001 From: Yuri Mizushima Date: Sat, 11 Oct 2025 07:11:40 +0900 Subject: [PATCH] docs: add publish latency, ml write latency, and ml entry size as otel histogram metrics --- docs/reference-metrics-opentelemetry.md | 33 +++++++++++++++++++ .../reference-metrics-opentelemetry.md | 33 +++++++++++++++++++ 2 files changed, 66 insertions(+) diff --git a/docs/reference-metrics-opentelemetry.md b/docs/reference-metrics-opentelemetry.md index d920eae5e4ac..57ad5fca74d8 100644 --- a/docs/reference-metrics-opentelemetry.md +++ b/docs/reference-metrics-opentelemetry.md @@ -133,6 +133,11 @@ The total number of messages bytes read from this topic. * `pulsar.topic` - The topic name. * `pulsar.partition.index` - The partition index of the topic. Present only if the topic is partitioned. +#### pulsar.broker.topic.publish.latency +The latency in seconds for publishing messages. +* Type: Histogram +* Unit: `s` + #### pulsar.broker.topic.publish.rate.limit.count The number of times the publish rate limit is triggered. * Type: Counter @@ -822,6 +827,34 @@ The total number of mark delete operations for this ledger. * `pulsar.namespace` - The managed ledger namespace. * `pulsar.managed_ledger.name` - The name of the managed ledger. +#### pulsar.broker.managed_ledger.message.outgoing.latency +End-to-end write latency, including time spent in the executor queue. +* Type: Histogram +* Unit: `s` +* Attributes: + * `pulsar.namespace` - The managed ledger namespace. + +#### pulsar.broker.managed_ledger.message.outgoing.ledger.latency +End-to end write latency. +* Type: Histogram +* Unit: `s` +* Attributes: + * `pulsar.namespace` - The managed ledger namespace. + +#### pulsar.broker.managed_ledger.ledger.switch.latency +Time taken to switch to a new ledger. +* Type: Histogram +* Unit: `s` +* Attributes: + * `pulsar.namespace` - The managed ledger namespace. + +#### pulsar.broker.managed_ledger.entry.size +Size of entries written to the ledger. +* Type: Histogram +* Unit: `By` +* Attributes: + * `pulsar.namespace` - The managed ledger namespace. + #### pulsar.broker.managed_ledger.inflight.read.limit Maximum number of bytes that can be retained by managed ledger data read from storage or cache. * Type: Counter diff --git a/versioned_docs/version-4.1.x/reference-metrics-opentelemetry.md b/versioned_docs/version-4.1.x/reference-metrics-opentelemetry.md index 74950473d9f4..7e346358a231 100644 --- a/versioned_docs/version-4.1.x/reference-metrics-opentelemetry.md +++ b/versioned_docs/version-4.1.x/reference-metrics-opentelemetry.md @@ -133,6 +133,11 @@ The total number of messages bytes read from this topic. * `pulsar.topic` - The topic name. * `pulsar.partition.index` - The partition index of the topic. Present only if the topic is partitioned. +#### pulsar.broker.topic.publish.latency +The latency in seconds for publishing messages. +* Type: Histogram +* Unit: `s` + #### pulsar.broker.topic.publish.rate.limit.count The number of times the publish rate limit is triggered. * Type: Counter @@ -822,6 +827,34 @@ The total number of mark delete operations for this ledger. * `pulsar.namespace` - The managed ledger namespace. * `pulsar.managed_ledger.name` - The name of the managed ledger. +#### pulsar.broker.managed_ledger.message.outgoing.latency +End-to-end write latency, including time spent in the executor queue. +* Type: Histogram +* Unit: `s` +* Attributes: + * `pulsar.namespace` - The managed ledger namespace. + +#### pulsar.broker.managed_ledger.message.outgoing.ledger.latency +End-to end write latency. +* Type: Histogram +* Unit: `s` +* Attributes: + * `pulsar.namespace` - The managed ledger namespace. + +#### pulsar.broker.managed_ledger.ledger.switch.latency +Time taken to switch to a new ledger. +* Type: Histogram +* Unit: `s` +* Attributes: + * `pulsar.namespace` - The managed ledger namespace. + +#### pulsar.broker.managed_ledger.entry.size +Size of entries written to the ledger. +* Type: Histogram +* Unit: `By` +* Attributes: + * `pulsar.namespace` - The managed ledger namespace. + #### pulsar.broker.managed_ledger.inflight.read.limit Maximum number of bytes that can be retained by managed ledger data read from storage or cache. * Type: Counter