From a0d989a64fc6d6aa1fbdc2a0ae90d319a9a3dacb Mon Sep 17 00:00:00 2001 From: Asaf Mesika Date: Tue, 9 May 2023 16:00:49 +0300 Subject: [PATCH 1/3] Add missing documentation for JVM metrics in Pulsar broker --- docs/reference-metrics.md | 61 +++++++++++++++++++ .../version-2.11.x/reference-metrics.md | 61 +++++++++++++++++++ .../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 e282065ed875..f0f749aa1d2f 100644 --- a/docs/reference-metrics.md +++ b/docs/reference-metrics.md @@ -600,6 +600,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 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 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 ae30ccadaedd..9f0415e7b64a 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 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 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 e282065ed875..f0f749aa1d2f 100644 --- a/versioned_docs/version-3.0.x/reference-metrics.md +++ b/versioned_docs/version-3.0.x/reference-metrics.md @@ -600,6 +600,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 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 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: From 18387093205fd6b43b68152a94ba4c38105181a6 Mon Sep 17 00:00:00 2001 From: Asaf Mesika Date: Sun, 21 May 2023 18:37:27 +0300 Subject: [PATCH 2/3] Fixed tables --- docs/reference-metrics.md | 88 +++++++++---------- .../version-2.11.x/reference-metrics.md | 88 +++++++++---------- 2 files changed, 88 insertions(+), 88 deletions(-) diff --git a/docs/reference-metrics.md b/docs/reference-metrics.md index f0f749aa1d2f..e4179bafc603 100644 --- a/docs/reference-metrics.md +++ b/docs/reference-metrics.md @@ -603,62 +603,62 @@ All the metadata store metrics are labeled with the following labels: ### 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. | +| 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 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 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. | +| 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 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 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. | +| 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. | +| jvm_buffer_pool_used_buffers | Gauge | Used buffers of a given JVM buffer pool. | #### Garbage Collectors Metrics -| Name | Type | Description | -|-----------------------------|---------|----------------------------------------------------------------------------------------------| +| 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 | +| 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 | +| 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 diff --git a/versioned_docs/version-2.11.x/reference-metrics.md b/versioned_docs/version-2.11.x/reference-metrics.md index 9f0415e7b64a..d7fc97e03ad5 100644 --- a/versioned_docs/version-2.11.x/reference-metrics.md +++ b/versioned_docs/version-2.11.x/reference-metrics.md @@ -590,62 +590,62 @@ All the metadata store metrics are labeled with the following labels: ### 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. | +| 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 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 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. | +| 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 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 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. | +| 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. | +| jvm_buffer_pool_used_buffers | Gauge | Used buffers of a given JVM buffer pool. | #### Garbage Collectors Metrics -| Name | Type | Description | -|-----------------------------|---------|----------------------------------------------------------------------------------------------| +| 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 | +| 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 | +| 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 From 4dbd25ef7edac8f0319c4bb94fbad9de6ed7d523 Mon Sep 17 00:00:00 2001 From: Asaf Mesika Date: Sun, 21 May 2023 18:52:10 +0300 Subject: [PATCH 3/3] Fixed tables and PR comment --- docs/reference-metrics.md | 4 +- .../version-2.11.x/reference-metrics.md | 4 +- .../version-3.0.x/reference-metrics.md | 88 +++++++++---------- 3 files changed, 48 insertions(+), 48 deletions(-) diff --git a/docs/reference-metrics.md b/docs/reference-metrics.md index e4179bafc603..dceec886b98c 100644 --- a/docs/reference-metrics.md +++ b/docs/reference-metrics.md @@ -624,9 +624,9 @@ All the metadata store metrics are labeled with the following labels: | 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 last collection 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 last collection 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. | diff --git a/versioned_docs/version-2.11.x/reference-metrics.md b/versioned_docs/version-2.11.x/reference-metrics.md index d7fc97e03ad5..71e2bb3a1989 100644 --- a/versioned_docs/version-2.11.x/reference-metrics.md +++ b/versioned_docs/version-2.11.x/reference-metrics.md @@ -611,9 +611,9 @@ All the metadata store metrics are labeled with the following labels: | 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 last collection 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 last collection 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. | diff --git a/versioned_docs/version-3.0.x/reference-metrics.md b/versioned_docs/version-3.0.x/reference-metrics.md index f0f749aa1d2f..dceec886b98c 100644 --- a/versioned_docs/version-3.0.x/reference-metrics.md +++ b/versioned_docs/version-3.0.x/reference-metrics.md @@ -603,62 +603,62 @@ All the metadata store metrics are labeled with the following labels: ### 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. | +| 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 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 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. | +| 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. | +| 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. | +| jvm_buffer_pool_used_buffers | Gauge | Used buffers of a given JVM buffer pool. | #### Garbage Collectors Metrics -| Name | Type | Description | -|-----------------------------|---------|----------------------------------------------------------------------------------------------| +| 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 | +| 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 | +| 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