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

Jump to bottom

Add missing documentation for JVM metrics in Pulsar broker #567

Merged
merged 5 commits into from May 22, 2023
Merged

Add missing documentation for JVM metrics in Pulsar broker #567

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
a0d989a
Add missing documentation for JVM metrics in Pulsar broker
asafm May 9, 2023
8d7aa89
Merge remote-tracking branch 'origin/main' into add-jvm-metrics
asafm May 9, 2023
1838709
Fixed tables
asafm May 21, 2023
4f3beea
Merge remote-tracking branch 'origin/main' into add-jvm-metrics
asafm May 21, 2023
4dbd25e
Fixed tables and PR comment
asafm May 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
61 changes: 61 additions & 0 deletions docs/reference-metrics.md
View file
Open in desktop
Expand Up @@ -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 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:
Expand Down
61 changes: 61 additions & 0 deletions versioned_docs/version-2.11.x/reference-metrics.md
View file
Open in desktop
Expand Up @@ -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:
Expand Down