This is an automated email from the ASF dual-hosted git repository.
lhotari pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 6ad2634a0854 [feat][doc] PIP-264: Add OpenTelemetry ML cache metrics
reference (#913)
6ad2634a0854 is described below
commit 6ad2634a085413e02d81ed5c3070c9c100556197
Author: Dragos Misca <[email protected]>
AuthorDate: Tue Oct 29 03:46:06 2024 -0700
[feat][doc] PIP-264: Add OpenTelemetry ML cache metrics reference (#913)
* Add OpenTelemetry ML cache metrics reference
* Add changes to 4.0.x docs
---------
Co-authored-by: Lari Hotari <[email protected]>
---
docs/reference-metrics-opentelemetry.md | 64 ++++++++++++++++++++++
.../reference-metrics-opentelemetry.md | 64 ++++++++++++++++++++++
2 files changed, 128 insertions(+)
diff --git a/docs/reference-metrics-opentelemetry.md
b/docs/reference-metrics-opentelemetry.md
index 3cd0df30a2c5..da0996cb67ee 100644
--- a/docs/reference-metrics-opentelemetry.md
+++ b/docs/reference-metrics-opentelemetry.md
@@ -549,6 +549,70 @@ The number of permits currently available for this
consumer.
* `pulsar.consumer.name` - The name of the consumer.
* `pulsar.consumer.id` - The ID of the consumer.
+### Managed Ledger Cache metrics
+
+#### pulsar.broker.managed_ledger.count
+The total number of managed ledgers.
+* Type: UpDownCounter
+* Unit: `{managed_ledger}`
+
+#### pulsar.broker.managed_ledger.cache.eviction.count
+The total number of cache eviction operations.
+* Type: Counter
+* Unit: `{eviction}`
+
+#### pulsar.broker.managed_ledger.cache.entry.count
+The number of entries in the entry cache.
+* Type: UpDownCounter
+* Unit: `{entry}`
+* Attributes:
+ * `pulsar.managed_ledger.cache.entry.status` - The status of the cache
entry. Can be one of:
+ * `active` - Indicates the number of entries currently in the cache. Equal
to the `evicted - inserted`.
+ * `inserted` - Indicates the total number of entries inserted into the
cache.
+ * `evicted` - Indicates the total number of entries evicted from the cache.
+
+#### pulsar.broker.managed_ledger.cache.entry.size
+The byte amount of entries stored in the entry cache.
+* Type: UpDownCounter
+* Unit: `{By}`
+
+#### pulsar.broker.managed_ledger.cache.operation.count
+The number of cache operations.
+* Type: Counter
+* Unit: `{entry}`
+* Attributes:
+ * `pulsar.managed_ledger.cache.operation.status` - The cache operation
result. Can be one of:
+ * `hit` - Indicates a successful cache lookup operation.
+ * `miss` - Indicates a failed cache lookup operation.
+
+#### pulsar.broker.managed_ledger.cache.operation.size
+The byte amount of data retrieved from cache operations.
+* Type: Counter
+* Unit: `{By}`
+* Attributes:
+ * `pulsar.managed_ledger.cache.operation.status` - The cache operation
result. Can be one of:
+ * `hit` - Indicates a successful cache lookup operation.
+ * `miss` - Indicates a failed cache lookup operation.
+
+#### pulsar.broker.managed_ledger.cache.pool.allocation.active.count
+The number of currently active allocations in the direct arena.
+* Type: UpDownCounter
+* Unit: `{allocation}`
+* Attributes:
+ * `pulsar.managed_ledger.pool.arena.type` - The arena type. Can be one of:
+ * `small`
+ * `normal`
+ * `huge`
+
+#### pulsar.broker.managed_ledger.cache.pool.allocation.size
+The memory allocated in the direct arena.
+* Type: UpDownCounter
+* Unit: `{By}`
+* Attributes:
+ * `pulsar.managed_ledger.pool.chunk.allocation.type` - The chunk allocation
type. Can be one of:
+ * `allocated`
+ * `used`
+
### Producer metrics
#### pulsar.broker.producer.message.incoming.count
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 3cd0df30a2c5..da0996cb67ee 100644
--- a/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md
+++ b/versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md
@@ -549,6 +549,70 @@ The number of permits currently available for this
consumer.
* `pulsar.consumer.name` - The name of the consumer.
* `pulsar.consumer.id` - The ID of the consumer.
+### Managed Ledger Cache metrics
+
+#### pulsar.broker.managed_ledger.count
+The total number of managed ledgers.
+* Type: UpDownCounter
+* Unit: `{managed_ledger}`
+
+#### pulsar.broker.managed_ledger.cache.eviction.count
+The total number of cache eviction operations.
+* Type: Counter
+* Unit: `{eviction}`
+
+#### pulsar.broker.managed_ledger.cache.entry.count
+The number of entries in the entry cache.
+* Type: UpDownCounter
+* Unit: `{entry}`
+* Attributes:
+ * `pulsar.managed_ledger.cache.entry.status` - The status of the cache
entry. Can be one of:
+ * `active` - Indicates the number of entries currently in the cache. Equal
to the `evicted - inserted`.
+ * `inserted` - Indicates the total number of entries inserted into the
cache.
+ * `evicted` - Indicates the total number of entries evicted from the cache.
+
+#### pulsar.broker.managed_ledger.cache.entry.size
+The byte amount of entries stored in the entry cache.
+* Type: UpDownCounter
+* Unit: `{By}`
+
+#### pulsar.broker.managed_ledger.cache.operation.count
+The number of cache operations.
+* Type: Counter
+* Unit: `{entry}`
+* Attributes:
+ * `pulsar.managed_ledger.cache.operation.status` - The cache operation
result. Can be one of:
+ * `hit` - Indicates a successful cache lookup operation.
+ * `miss` - Indicates a failed cache lookup operation.
+
+#### pulsar.broker.managed_ledger.cache.operation.size
+The byte amount of data retrieved from cache operations.
+* Type: Counter
+* Unit: `{By}`
+* Attributes:
+ * `pulsar.managed_ledger.cache.operation.status` - The cache operation
result. Can be one of:
+ * `hit` - Indicates a successful cache lookup operation.
+ * `miss` - Indicates a failed cache lookup operation.
+
+#### pulsar.broker.managed_ledger.cache.pool.allocation.active.count
+The number of currently active allocations in the direct arena.
+* Type: UpDownCounter
+* Unit: `{allocation}`
+* Attributes:
+ * `pulsar.managed_ledger.pool.arena.type` - The arena type. Can be one of:
+ * `small`
+ * `normal`
+ * `huge`
+
+#### pulsar.broker.managed_ledger.cache.pool.allocation.size
+The memory allocated in the direct arena.
+* Type: UpDownCounter
+* Unit: `{By}`
+* Attributes:
+ * `pulsar.managed_ledger.pool.chunk.allocation.type` - The chunk allocation
type. Can be one of:
+ * `allocated`
+ * `used`
+
### Producer metrics
#### pulsar.broker.producer.message.incoming.count
