Skip to content

Commit

Permalink
[feature] add Apache Pulsar monitor (#2013)
Browse files Browse the repository at this point in the history 
Co-authored-by: zhangshenghang <[email protected]>
Co-authored-by: tomsun28 <[email protected]>
  • Loading branch information
@zhangshenghang @tomsun28
3 people authored May 20, 2024
1 parent 066091d commit 7c9b398
Show file tree
Hide file tree
Showing 4 changed files with 525 additions and 1 deletion.
76 changes: 76 additions & 0 deletions home/docs/help/pulsar.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
id: pulsar
title: Monitoring Pulsar Monitoring
sidebar_label: Apache Pulsar
keywords: [open-source monitoring system, open-source database monitoring, HbaseMaster monitoring]
---
> Collecting and monitoring general performance metrics of Pulsar
**Protocol Used: HTTP**

## Configuration Parameters


| Parameter Name | Description |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| Target Host | The monitored endpoint's IPV4, IPV6, or domain name. Note⚠️: Do not include the protocol header (e.g., https://, http://). |
| Port | The webServicePort value of Pulsar, default is 8080. |
| Task Name | The name identifying this monitoring task, must be unique. |
| Query Timeout | Set the connection timeout in milliseconds, default is 3000 milliseconds. |
| Monitoring Interval | Interval time for periodic data collection, in seconds, minimum interval is 30 seconds. |
| Binding Tags | Used for categorizing monitoring resources. |
| Description/Remarks | Additional notes and descriptions for this monitoring task. Users can add more information here. |

### Collected Metrics

#### Metric Set: Version Information


| Metric Name | Unit | Description |
| ------------ | ---- | ------------------- |
| Version Info | NONE | Version Information |

#### Metric Set: process_start_time_seconds


| Metric Name | Unit | Description |
| ------------------ | ---- | ------------------ |
| Process Start Time | NONE | Process Start Time |

#### Metric Set: process_open_fds


| Metric Name | Unit | Description |
| --------------------- | ---- | ------------------------------- |
| Open File Descriptors | NONE | Number of Open File Descriptors |

#### Metric Set: process_max_fds


| Metric Name | Unit | Description |
| -------------------- | ---- | ---------------------------------- |
| Max File Descriptors | NONE | Maximum Number of File Descriptors |

#### Metric Set: jvm_memory_pool_allocated_bytes

Number of bytes of memory allocated in a specific memory pool in the Java Virtual Machine (JVM). In Pulsar, this typically refers to the amount of memory allocated for various purposes in the JVM (such as heap memory, non-heap memory, etc.).

#### Metric Set: jvm_memory_pool_used_bytes

Unlike allocated_bytes, this metric shows the actual used memory, not just the allocated memory.

#### Metric Set: jvm_memory_pool_committed_bytes

Number of bytes of memory committed in a specific memory pool in the JVM. In the JVM, committed memory is the amount of memory guaranteed to be available for the application to use. This portion of memory is typically locked by the operating system to reduce swapping or garbage collection.

#### Metric Set: jvm_memory_pool_max_bytes

Maximum number of bytes of memory that can be allocated in a specific memory pool in the JVM. This is the upper limit on memory usage for that memory pool and helps in setting the memory usage cap.

#### Metric Set: pulsar_broker_publish_latency

Message publishing latency on the broker side.

#### Metric Set: pulsar_metadata_store_ops_latency_ms

Latency of metadata store operations on the broker side.
152 changes: 152 additions & 0 deletions home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/pulsar.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
---
id: pulsar
title: 监控：Pulsar监控
sidebar_label: A---
id: pulsar
title: 监控：Pulsar监控
sidebar_label: Apache Pulsar
keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控]
---
> 对Pulsar的通用性能指标进行采集监控
**使用协议：HTTP**

## 配置参数


| 参数名称 | 参数帮助描述 |
| ------------ | ------------------------------------------------------------------------- |
| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
| 端口 | Pulsar的webServiceProt值，默认为8080。 |
| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 |
| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 |
| 绑定标签 | 用于对监控资源进行分类管理 |
| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |

### 采集指标

#### 指标集合：版本信息


| 指标名称 | 指标单位 | 指标帮助描述 |
| ------------ | -------- | ------------ |
| Version Info | 无 | 版本信息 |

#### 指标集合：process_start_time_seconds


| 指标名称 | 指标单位 | 指标帮助描述 |
| ------------------ | -------- | ------------ |
| Process Start Time | 无 | 进程启动时间 |

#### 指标集合：process_open_fds


| 指标名称 | 指标单位 | 指标帮助描述 |
| --------------------- | -------- | ---------------- |
| Open File Descriptors | 无 | 打开的文件描述符 |

#### 指标集合：process_max_fds


| 指标名称 | 指标单位 | 指标帮助描述 |
| -------------------- | -------- | -------------- |
| Max File Descriptors | 无 | 最大文件描述符 |

#### 指标集合： jvm_memory_pool_allocated_bytes

Java虚拟机（JVM）中特定内存池已分配的内存字节数。在Pulsar中，这通常指的是用于各种目的的JVM内存（如堆内存、非堆内存等）中已经分配出去的内存量。

#### 指标集合：jvm_memory_pool_used_bytes

与allocated_bytes不同，这个指标会显示实际使用的内存，而不仅仅是分配的内存。

#### 指标集合：jvm_memory_pool_committed_bytes

JVM中特定内存池已承诺的内存字节数。在JVM中，承诺的内存是指虚拟机保证可供应用程序使用的内存量，通常这部分内存会被操作系统锁定，以减少交换或垃圾回收的可能性。

#### 指标集合：jvm_memory_pool_max_bytes

JVM中特定内存池可分配的最大内存字节数。这是该内存池允许的最大内存限制，有助于设置内存使用的上限。

#### 指标集合：pulsar_broker_publish_latency

Broker端消息发布延迟

#### 指标集合：pulsar_metadata_store_ops_latency_ms

Broker端元数据存储操作延迟
pache Pulsar
keywords: [开源监控系统, 开源数据库监控, HbaseMaster监控]
---
> 对Pulsar的通用性能指标进行采集监控
**使用协议：HTTP**

## 配置参数


| 参数名称 | 参数帮助描述 |
| ------------ | ------------------------------------------------------------------------- |
| 目标Host | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
| 端口 | Pulsar的webServiceProt值，默认为8080。 |
| 任务名称 | 标识此监控的名称，名称需要保证唯一性。 |
| 查询超时时间 | 设置连接的超时时间，单位ms毫秒，默认3000毫秒。 |
| 监控周期 | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为30秒 |
| 绑定标签 | 用于对监控资源进行分类管理 |
| 描述备注 | 更多标识和描述此监控的备注信息，用户可以在这里备注信息 |

### 采集指标

#### 指标集合：版本信息


| 指标名称 | 指标单位 | 指标帮助描述 |
| ------------ | -------- | ------------ |
| Version Info | 无 | 版本信息 |

#### 指标集合：process_start_time_seconds


| 指标名称 | 指标单位 | 指标帮助描述 |
| ------------------ | -------- | ------------ |
| Process Start Time | 无 | 进程启动时间 |

#### 指标集合：process_open_fds


| 指标名称 | 指标单位 | 指标帮助描述 |
| --------------------- | -------- | ---------------- |
| Open File Descriptors | 无 | 打开的文件描述符 |

#### 指标集合：process_max_fds


| 指标名称 | 指标单位 | 指标帮助描述 |
| -------------------- | -------- | -------------- |
| Max File Descriptors | 无 | 最大文件描述符 |

#### 指标集合： jvm_memory_pool_allocated_bytes

Java虚拟机（JVM）中特定内存池已分配的内存字节数。在Pulsar中，这通常指的是用于各种目的的JVM内存（如堆内存、非堆内存等）中已经分配出去的内存量。

#### 指标集合：jvm_memory_pool_used_bytes

与allocated_bytes不同，这个指标会显示实际使用的内存，而不仅仅是分配的内存。

#### 指标集合：jvm_memory_pool_committed_bytes

JVM中特定内存池已承诺的内存字节数。在JVM中，承诺的内存是指虚拟机保证可供应用程序使用的内存量，通常这部分内存会被操作系统锁定，以减少交换或垃圾回收的可能性。

#### 指标集合：jvm_memory_pool_max_bytes

JVM中特定内存池可分配的最大内存字节数。这是该内存池允许的最大内存限制，有助于设置内存使用的上限。

#### 指标集合：pulsar_broker_publish_latency

Broker端消息发布延迟

#### 指标集合：pulsar_metadata_store_ops_latency_ms

Broker端元数据存储操作延迟
3 changes: 2 additions & 1 deletion home/sidebars.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,8 @@
"help/rocketmq",
"help/spring_gateway",
"help/nacos",
"help/kafka"
"help/kafka",
"help/pulsar"
]
},
{
Expand Down
Loading

0 comments on commit 7c9b398

Please sign in to comment.