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.

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

[feat][doc] PIP-264: Add transaction metrics reference #925

Merged
merged 6 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
64 changes: 63 additions & 1 deletion docs/reference-metrics-opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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`

64 changes: 63 additions & 1 deletion versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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`