From 3602a4b171ab8ccd00522123babb6a7095b05ddf Mon Sep 17 00:00:00 2001 From: Dragos Misca Date: Tue, 29 Oct 2024 03:58:06 -0700 Subject: [PATCH] [feat][doc] PIP-264: Add transaction metrics reference (#925) * Add draft metadata store metrics reference * Fix metric description * Draft transaction metrics * Fix style * Apply changes to 4.0.x docs --------- Co-authored-by: Lari Hotari --- docs/reference-metrics-opentelemetry.md | 64 ++++++++++++++++++- .../reference-metrics-opentelemetry.md | 64 ++++++++++++++++++- 2 files changed, 126 insertions(+), 2 deletions(-) diff --git a/docs/reference-metrics-opentelemetry.md b/docs/reference-metrics-opentelemetry.md index da0996cb67ee..4d21357bf5e5 100644 --- a/docs/reference-metrics-opentelemetry.md +++ b/docs/reference-metrics-opentelemetry.md @@ -390,6 +390,22 @@ The number of transactions on this topic. * `committed` * `aborted` +#### pulsar.broker.topic.transaction.buffer.client.operation.count +The number of operations on the transaction buffer client. +* Type: Counter +* Unit: `{operation}` +* Attributes: + * `pulsar.tenant` - The topic tenant. + * `pulsar.namespace` - The topic namespace. + * `pulsar.topic` - The topic name. + * `pulsar.partition.index` - The partition index of the topic. Present only if the topic is partitioned. + * `pulsar.transaction.status` - The status of the Pulsar transaction. Can be one of: + * `aborted` + * `committed` + * `pulsar.transaction.buffer.client.operation.status` - The status of the Pulsar transaction buffer client operation. Can be one of: + * `failure` + * `success` + #### pulsar.broker.topic.subscription.delayed.entry.count The total number of message batches (entries) delayed for dispatching. * Type: UpDownCounter @@ -778,7 +794,6 @@ The current usage of threads in the pulsar-web executor pool. * `active` - Indicates the number of threads actively serving requests. * `current` - Indicates the total number of threads currently associated with the pool. * `idle` - Indicates the number of threads available to serve requests. - ======= ### Schema Registry Metrics @@ -818,3 +833,50 @@ Counter of HTTP requests processed by the rate limiting filter. * `accepted` * `rejected` +### Transaction Coordinator Metrics + +#### pulsar.broker.transaction.coordinator.transaction.count +The number of transactions handled by the coordinator. +* Type: UpDownCounter +* Unit: `{transaction}` +* Attributes: + * `pulsar.transaction.coordinator.id` - The ID of the Pulsar transaction coordinator. + * `pulsar.transaction.status` - The status of the Pulsar transaction. Can be one of: + * `aborted` + * `active` + * `created` + * `committed` + * `timeout` + +#### pulsar.broker.transaction.coordinator.append.log.count +The number of transaction metadata entries appended by the coordinator. +* Type: Counter +* Unit: `{entry}` +* Attributes: + * `pulsar.transaction.coordinator.id` - The ID of the Pulsar transaction coordinator. + * `pulsar.transaction.status` - The status of the Pulsar transaction. Can be one of: + * `aborted` + * `active` + * `created` + * `committed` + * `timeout` + +### Transaction Pending Acknowledgment Store Metrics + +#### pulsar.broker.transaction.pending.ack.store.transaction.count +The number of transactions handled by the persistent ack store. +* Type: Counter +* Unit: `{transaction}` +* Attributes: + * `pulsar.tenant` - The topic tenant. + * `pulsar.namespace` - The topic namespace. + * `pulsar.topic` - The topic name. + * `pulsar.partition.index` - The partition index of the topic. Present only if the topic is partitioned. + * `pulsar.subscription.name` - The name of the Pulsar subscription. + * `pulsar.transaction.status` - The Pulsar transaction status. Can be one of: + * `aborted` + * `committed` + * `pulsar.transaction.pending.ack.store.operation.status` - The status of the pending acknowledgment store operation. Can be one of: + * `failure` + * `success` + diff --git a/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md b/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md index da0996cb67ee..4d21357bf5e5 100644 --- a/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md +++ b/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md @@ -390,6 +390,22 @@ The number of transactions on this topic. * `committed` * `aborted` +#### pulsar.broker.topic.transaction.buffer.client.operation.count +The number of operations on the transaction buffer client. +* Type: Counter +* Unit: `{operation}` +* Attributes: + * `pulsar.tenant` - The topic tenant. + * `pulsar.namespace` - The topic namespace. + * `pulsar.topic` - The topic name. + * `pulsar.partition.index` - The partition index of the topic. Present only if the topic is partitioned. + * `pulsar.transaction.status` - The status of the Pulsar transaction. Can be one of: + * `aborted` + * `committed` + * `pulsar.transaction.buffer.client.operation.status` - The status of the Pulsar transaction buffer client operation. Can be one of: + * `failure` + * `success` + #### pulsar.broker.topic.subscription.delayed.entry.count The total number of message batches (entries) delayed for dispatching. * Type: UpDownCounter @@ -778,7 +794,6 @@ The current usage of threads in the pulsar-web executor pool. * `active` - Indicates the number of threads actively serving requests. * `current` - Indicates the total number of threads currently associated with the pool. * `idle` - Indicates the number of threads available to serve requests. - ======= ### Schema Registry Metrics @@ -818,3 +833,50 @@ Counter of HTTP requests processed by the rate limiting filter. * `accepted` * `rejected` +### Transaction Coordinator Metrics + +#### pulsar.broker.transaction.coordinator.transaction.count +The number of transactions handled by the coordinator. +* Type: UpDownCounter +* Unit: `{transaction}` +* Attributes: + * `pulsar.transaction.coordinator.id` - The ID of the Pulsar transaction coordinator. + * `pulsar.transaction.status` - The status of the Pulsar transaction. Can be one of: + * `aborted` + * `active` + * `created` + * `committed` + * `timeout` + +#### pulsar.broker.transaction.coordinator.append.log.count +The number of transaction metadata entries appended by the coordinator. +* Type: Counter +* Unit: `{entry}` +* Attributes: + * `pulsar.transaction.coordinator.id` - The ID of the Pulsar transaction coordinator. + * `pulsar.transaction.status` - The status of the Pulsar transaction. Can be one of: + * `aborted` + * `active` + * `created` + * `committed` + * `timeout` + +### Transaction Pending Acknowledgment Store Metrics + +#### pulsar.broker.transaction.pending.ack.store.transaction.count +The number of transactions handled by the persistent ack store. +* Type: Counter +* Unit: `{transaction}` +* Attributes: + * `pulsar.tenant` - The topic tenant. + * `pulsar.namespace` - The topic namespace. + * `pulsar.topic` - The topic name. + * `pulsar.partition.index` - The partition index of the topic. Present only if the topic is partitioned. + * `pulsar.subscription.name` - The name of the Pulsar subscription. + * `pulsar.transaction.status` - The Pulsar transaction status. Can be one of: + * `aborted` + * `committed` + * `pulsar.transaction.pending.ack.store.operation.status` - The status of the pending acknowledgment store operation. Can be one of: + * `failure` + * `success` +