This is an automated email from the ASF dual-hosted git repository.
tison 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 f850e5df504 Add missing documentation for JVM metrics in Pulsar broker
(#567)
f850e5df504 is described below
commit f850e5df504e10594112cc52c4ff453168249c6e
Author: Asaf Mesika <[email protected]>
AuthorDate: Mon May 22 14:53:49 2023 +0300
Add missing documentation for JVM metrics in Pulsar broker (#567)
* Add missing documentation for JVM metrics in Pulsar broker
* Fixed tables
* Fixed tables and PR comment
---
docs/reference-metrics.md | 61 ++++++++++++++++++++++
versioned_docs/version-2.11.x/reference-metrics.md | 61 ++++++++++++++++++++++
versioned_docs/version-3.0.x/reference-metrics.md | 61 ++++++++++++++++++++++
3 files changed, 183 insertions(+)
diff --git a/docs/reference-metrics.md b/docs/reference-metrics.md
index fcb05ea8486..0fdd0a577a7 100644
--- a/docs/reference-metrics.md
+++ b/docs/reference-metrics.md
@@ -616,6 +616,67 @@ All the metadata store metrics are labeled with the
following labels:
| pulsar_batch_metadata_store_batch_execute_time_ms | Histogram | The
duration of the batch execution in milliseconds.
|
| pulsar_batch_metadata_store_batch_size | Histogram | The number
of read/write operations in the batch.
|
+### JVM Metrics
+
+#### Process Metrics
+| Name | Type | Description
|
+|-------------------------------|---------|--------------------------------------------------------|
+| process_cpu_seconds_total | Counter | Total user and system CPU time
spent in seconds. |
+| process_start_time_seconds | Gauge | Start time of the process since
unix epoch in seconds. |
+| process_open_fds | Gauge | Number of open file descriptors.
|
+| process_max_fds | Gauge | Maximum number of open file
descriptors. |
+| process_virtual_memory_bytes | Gauge | Virtual memory size in bytes.
|
+| process_resident_memory_bytes | Gauge | Resident memory size in bytes.
|
+
+#### Memory Metrics
+| Name | Type
| Description
|
+|--------------------------------------------|----------------------------------------|--------------------------------------------------------------------------------------------|
+| jvm_memory_objects_pending_finalization | Gauge
| The number of objects waiting in the finalizer queue.
|
+| jvm_memory_bytes_used | Gauge
| Used bytes of a given JVM memory area.
|
+| jvm_memory_bytes_committed | Gauge
| Committed (bytes) of a given JVM memory area.
|
+| jvm_memory_bytes_max | Gauge
| Max (bytes) of a given JVM memory area.
|
+| jvm_memory_bytes_init | Gauge
| Initial bytes of a given JVM memory area.
|
+| jvm_memory_pool_bytes_used | Used bytes of a given JVM
memory pool. |
+| jvm_memory_pool_bytes_committed | Gauge
| Committed bytes of a given JVM memory pool.
|
+| jvm_memory_pool_bytes_max | Gauge
| Max bytes of a given JVM memory pool.
|
+| jvm_memory_pool_bytes_init | Gauge
| Initial bytes of a given JVM memory pool.
|
+| jvm_memory_pool_collection_used_bytes | Gauge
| Used bytes after the last collection of a given JVM memory pool.
|
+| jvm_memory_pool_collection_committed_bytes | Gauge
| Committed after last collection bytes of a given JVM memory pool.
|
+| jvm_memory_pool_collection_max_bytes | Gauge
| Max bytes after the last collection of a given JVM memory pool.
|
+| jvm_memory_pool_collection_init_bytes | Gauge
| Initial after last collection bytes of a given JVM memory pool.
|
+| jvm_memory_pool_allocated_bytes_total | Counter
| Total bytes allocated in a given JVM memory pool. Only updated after
GC, not continuously. |
+
+#### Buffer Pools Metrics
+| Name | Type | Description
|
+|--------------------------------|-------|--------------------------------------------|
+| jvm_buffer_pool_used_bytes | Gauge | Used bytes of a given JVM buffer
pool. |
+| jvm_buffer_pool_capacity_bytes | Gauge | Bytes capacity of a given JVM
buffer pool. |
+| jvm_buffer_pool_used_buffers | Gauge | Used buffers of a given JVM buffer
pool. |
+
+#### Garbage Collectors Metrics
+| Name | Type | Description
|
+|---------------------------|---------|---------------------------------------------------------|
+| jvm_gc_collection_seconds | Summary | Time spent in a given JVM garbage
collector in seconds. |
+
+#### Threads Metrics
+| Name | Type | Description
|
+|--------------------------------|---------|--------------------------------------------------------------------------------------------------------|
+| jvm_threads_current | Gauge | Current thread count of a JVM
|
+| jvm_threads_daemon | Gauge | Daemon thread count of a JVM
|
+| jvm_threads_peak | Gauge | Peak thread count of a JVM
|
+| jvm_threads_started_total | Counter | Started thread count of a JVM
|
+| jvm_threads_deadlocked | Gauge | Cycles of JVM-threads that are in
deadlock waiting to acquire object monitors or ownable synchronizers |
+| jvm_threads_deadlocked_monitor | Gauge | Cycles of JVM-threads that are in
deadlock waiting to acquire object monitors |
+| jvm_threads_state | Gauge | Current count of threads by state
|
+
+#### Classloaders Metrics
+| Name | Type | Description
|
+|------------------------------|---------|-----------------------------------------------------------------------------------------|
+| jvm_classes_currently_loaded | Gauge | The number of classes that are
currently loaded in the JVM |
+| jvm_classes_loaded_total | Counter | The total number of classes that
have been loaded since the JVM has started execution |
+| jvm_classes_unloaded_total | Counter | The total number of classes that
have been unloaded since the JVM has started execution |
+
+
## Pulsar Functions
All the Pulsar Functions metrics are labeled with the following labels:
diff --git a/versioned_docs/version-2.11.x/reference-metrics.md
b/versioned_docs/version-2.11.x/reference-metrics.md
index ae30ccadaed..71e2bb3a198 100644
--- a/versioned_docs/version-2.11.x/reference-metrics.md
+++ b/versioned_docs/version-2.11.x/reference-metrics.md
@@ -587,6 +587,67 @@ All the metadata store metrics are labeled with the
following labels:
| pulsar_batch_metadata_store_batch_execute_time_ms | Histogram | The
duration of the batch execution in milliseconds.
|
| pulsar_batch_metadata_store_batch_size | Histogram | The number
of read/write operations in the batch.
|
+### JVM Metrics
+
+#### Process Metrics
+| Name | Type | Description
|
+|-------------------------------|---------|--------------------------------------------------------|
+| process_cpu_seconds_total | Counter | Total user and system CPU time
spent in seconds. |
+| process_start_time_seconds | Gauge | Start time of the process since
unix epoch in seconds. |
+| process_open_fds | Gauge | Number of open file descriptors.
|
+| process_max_fds | Gauge | Maximum number of open file
descriptors. |
+| process_virtual_memory_bytes | Gauge | Virtual memory size in bytes.
|
+| process_resident_memory_bytes | Gauge | Resident memory size in bytes.
|
+
+#### Memory Metrics
+| Name | Type
| Description
|
+|--------------------------------------------|----------------------------------------|--------------------------------------------------------------------------------------------|
+| jvm_memory_objects_pending_finalization | Gauge
| The number of objects waiting in the finalizer queue.
|
+| jvm_memory_bytes_used | Gauge
| Used bytes of a given JVM memory area.
|
+| jvm_memory_bytes_committed | Gauge
| Committed (bytes) of a given JVM memory area.
|
+| jvm_memory_bytes_max | Gauge
| Max (bytes) of a given JVM memory area.
|
+| jvm_memory_bytes_init | Gauge
| Initial bytes of a given JVM memory area.
|
+| jvm_memory_pool_bytes_used | Used bytes of a given JVM
memory pool. |
+| jvm_memory_pool_bytes_committed | Gauge
| Committed bytes of a given JVM memory pool.
|
+| jvm_memory_pool_bytes_max | Gauge
| Max bytes of a given JVM memory pool.
|
+| jvm_memory_pool_bytes_init | Gauge
| Initial bytes of a given JVM memory pool.
|
+| jvm_memory_pool_collection_used_bytes | Gauge
| Used bytes after the last collection of a given JVM memory pool.
|
+| jvm_memory_pool_collection_committed_bytes | Gauge
| Committed after last collection bytes of a given JVM memory pool.
|
+| jvm_memory_pool_collection_max_bytes | Gauge
| Max bytes after the last collection of a given JVM memory pool.
|
+| jvm_memory_pool_collection_init_bytes | Gauge
| Initial after last collection bytes of a given JVM memory pool.
|
+| jvm_memory_pool_allocated_bytes_total | Counter
| Total bytes allocated in a given JVM memory pool. Only updated after
GC, not continuously. |
+
+#### Buffer Pools Metrics
+| Name | Type | Description
|
+|--------------------------------|-------|--------------------------------------------|
+| jvm_buffer_pool_used_bytes | Gauge | Used bytes of a given JVM buffer
pool. |
+| jvm_buffer_pool_capacity_bytes | Gauge | Bytes capacity of a given JVM
buffer pool. |
+| jvm_buffer_pool_used_buffers | Gauge | Used buffers of a given JVM buffer
pool. |
+
+#### Garbage Collectors Metrics
+| Name | Type | Description
|
+|---------------------------|---------|---------------------------------------------------------|
+| jvm_gc_collection_seconds | Summary | Time spent in a given JVM garbage
collector in seconds. |
+
+#### Threads Metrics
+| Name | Type | Description
|
+|--------------------------------|---------|--------------------------------------------------------------------------------------------------------|
+| jvm_threads_current | Gauge | Current thread count of a JVM
|
+| jvm_threads_daemon | Gauge | Daemon thread count of a JVM
|
+| jvm_threads_peak | Gauge | Peak thread count of a JVM
|
+| jvm_threads_started_total | Counter | Started thread count of a JVM
|
+| jvm_threads_deadlocked | Gauge | Cycles of JVM-threads that are in
deadlock waiting to acquire object monitors or ownable synchronizers |
+| jvm_threads_deadlocked_monitor | Gauge | Cycles of JVM-threads that are in
deadlock waiting to acquire object monitors |
+| jvm_threads_state | Gauge | Current count of threads by state
|
+
+#### Classloaders Metrics
+| Name | Type | Description
|
+|------------------------------|---------|-----------------------------------------------------------------------------------------|
+| jvm_classes_currently_loaded | Gauge | The number of classes that are
currently loaded in the JVM |
+| jvm_classes_loaded_total | Counter | The total number of classes that
have been loaded since the JVM has started execution |
+| jvm_classes_unloaded_total | Counter | The total number of classes that
have been unloaded since the JVM has started execution |
+
+
## Pulsar Functions
All the Pulsar Functions metrics are labeled with the following labels:
diff --git a/versioned_docs/version-3.0.x/reference-metrics.md
b/versioned_docs/version-3.0.x/reference-metrics.md
index fcb05ea8486..0fdd0a577a7 100644
--- a/versioned_docs/version-3.0.x/reference-metrics.md
+++ b/versioned_docs/version-3.0.x/reference-metrics.md
@@ -616,6 +616,67 @@ All the metadata store metrics are labeled with the
following labels:
| pulsar_batch_metadata_store_batch_execute_time_ms | Histogram | The
duration of the batch execution in milliseconds.
|
| pulsar_batch_metadata_store_batch_size | Histogram | The number
of read/write operations in the batch.
|
+### JVM Metrics
+
+#### Process Metrics
+| Name | Type | Description
|
+|-------------------------------|---------|--------------------------------------------------------|
+| process_cpu_seconds_total | Counter | Total user and system CPU time
spent in seconds. |
+| process_start_time_seconds | Gauge | Start time of the process since
unix epoch in seconds. |
+| process_open_fds | Gauge | Number of open file descriptors.
|
+| process_max_fds | Gauge | Maximum number of open file
descriptors. |
+| process_virtual_memory_bytes | Gauge | Virtual memory size in bytes.
|
+| process_resident_memory_bytes | Gauge | Resident memory size in bytes.
|
+
+#### Memory Metrics
+| Name | Type
| Description
|
+|--------------------------------------------|----------------------------------------|--------------------------------------------------------------------------------------------|
+| jvm_memory_objects_pending_finalization | Gauge
| The number of objects waiting in the finalizer queue.
|
+| jvm_memory_bytes_used | Gauge
| Used bytes of a given JVM memory area.
|
+| jvm_memory_bytes_committed | Gauge
| Committed (bytes) of a given JVM memory area.
|
+| jvm_memory_bytes_max | Gauge
| Max (bytes) of a given JVM memory area.
|
+| jvm_memory_bytes_init | Gauge
| Initial bytes of a given JVM memory area.
|
+| jvm_memory_pool_bytes_used | Used bytes of a given JVM
memory pool. |
+| jvm_memory_pool_bytes_committed | Gauge
| Committed bytes of a given JVM memory pool.
|
+| jvm_memory_pool_bytes_max | Gauge
| Max bytes of a given JVM memory pool.
|
+| jvm_memory_pool_bytes_init | Gauge
| Initial bytes of a given JVM memory pool.
|
+| jvm_memory_pool_collection_used_bytes | Gauge
| Used bytes after the last collection of a given JVM memory pool.
|
+| jvm_memory_pool_collection_committed_bytes | Gauge
| Committed after last collection bytes of a given JVM memory pool.
|
+| jvm_memory_pool_collection_max_bytes | Gauge
| Max bytes after the last collection of a given JVM memory pool.
|
+| jvm_memory_pool_collection_init_bytes | Gauge
| Initial after last collection bytes of a given JVM memory pool.
|
+| jvm_memory_pool_allocated_bytes_total | Counter
| Total bytes allocated in a given JVM memory pool. Only updated after
GC, not continuously. |
+
+#### Buffer Pools Metrics
+| Name | Type | Description
|
+|--------------------------------|-------|--------------------------------------------|
+| jvm_buffer_pool_used_bytes | Gauge | Used bytes of a given JVM buffer
pool. |
+| jvm_buffer_pool_capacity_bytes | Gauge | Bytes capacity of a given JVM
buffer pool. |
+| jvm_buffer_pool_used_buffers | Gauge | Used buffers of a given JVM buffer
pool. |
+
+#### Garbage Collectors Metrics
+| Name | Type | Description
|
+|---------------------------|---------|---------------------------------------------------------|
+| jvm_gc_collection_seconds | Summary | Time spent in a given JVM garbage
collector in seconds. |
+
+#### Threads Metrics
+| Name | Type | Description
|
+|--------------------------------|---------|--------------------------------------------------------------------------------------------------------|
+| jvm_threads_current | Gauge | Current thread count of a JVM
|
+| jvm_threads_daemon | Gauge | Daemon thread count of a JVM
|
+| jvm_threads_peak | Gauge | Peak thread count of a JVM
|
+| jvm_threads_started_total | Counter | Started thread count of a JVM
|
+| jvm_threads_deadlocked | Gauge | Cycles of JVM-threads that are in
deadlock waiting to acquire object monitors or ownable synchronizers |
+| jvm_threads_deadlocked_monitor | Gauge | Cycles of JVM-threads that are in
deadlock waiting to acquire object monitors |
+| jvm_threads_state | Gauge | Current count of threads by state
|
+
+#### Classloaders Metrics
+| Name | Type | Description
|
+|------------------------------|---------|-----------------------------------------------------------------------------------------|
+| jvm_classes_currently_loaded | Gauge | The number of classes that are
currently loaded in the JVM |
+| jvm_classes_loaded_total | Counter | The total number of classes that
have been loaded since the JVM has started execution |
+| jvm_classes_unloaded_total | Counter | The total number of classes that
have been unloaded since the JVM has started execution |
+
+
## Pulsar Functions
All the Pulsar Functions metrics are labeled with the following labels:
