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.

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

[feat][doc] PIP-264: Add OpenTelemetry ML cache metrics reference #913

Merged
merged 5 commits into from
Oct 29, 2024
Merged

[feat][doc] PIP-264: Add OpenTelemetry ML cache metrics reference #913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2c1300c
Add OpenTelemetry ML cache metrics reference
dragosvictor Jun 11, 2024
6663e4b
Merge branch 'main' into dmisca-pip-264-managed-ledger-cache-metrics
dragosvictor Jun 12, 2024
ed6dd77
Merge remote-tracking branch 'origin/main' into dmisca-pip-264-manage…
dragosvictor Jun 21, 2024
949615a
Merge remote-tracking branch 'origin/main' into dmisca-pip-264-manage…
lhotari Oct 29, 2024
f94d6a0
Add changes to 4.0.x docs
lhotari Oct 29, 2024
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: 64 additions & 0 deletions docs/reference-metrics-opentelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
64 changes: 64 additions & 0 deletions versioned_docs/version-4.0.x/reference-metrics-opentelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down