wehub/apache--hertzbeat
1
0
Fork 0
Code Issues Pull Requests Actions Deployments Models Agent Notes Packages Projects Releases Wiki Activity

chore: import upstream snapshot with attribution
MCP Bash Server CI / Test MCP Bash Server (dev) (push) Has been cancelled
Details
MCP Bash Server CI / Test MCP Bash Server (release) (push) Has been cancelled
Details

Browse Source
This commit is contained in:
wehub-resource-sync
2026-07-13 13:11:39 +08:00
commit c8cebdfeee
4654 changed files with 626756 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
home/versioned_docs/version-1.6.x/help/activemq.md
+145
View File
@@ -0,0 +1,145 @@
---
id: activemq
title: Monitoring Apache ActiveMQ
sidebar_label: Apache ActiveMQ
keywords: [open source monitoring tool, monitoring Apache ActiveMQ metrics]
---
> Monitoring the running status of Apache ActiveMQ message middleware, nodes, topics and other related metrics.
**Use Protocol: JMX**
## Pre-monitoring Operations
>
> You need to enable the `JMX` service on ActiveMQ, HertzBeat uses the JMX protocol to collect metrics from ActiveMQ.
1. Modify the `conf/activemq.xml` file in the installation directory to enable JMX
> Add `userJmx="true"` attribute in `broker` tag
```xml
<broker xmlns="http://activemq.apache.org/schema/core" brokerName="localhost" dataDirectory="${activemq.data}" useJmx="true">
<!-- others -->
</broker>
```
2. Modify the `bin/env` file in the installation directory, configure the JMX port IP, etc.
The original configuration information will be as follows
```text
# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.port=11099"
# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.password.file=`ACTIVEMQ_CONF`/jmx.password"
# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.access.file=`ACTIVEMQ_CONF`/jmx.access"
# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.ssl=false"
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote"
```
Update to the following configuration, ⚠️ pay attention to modify `local external IP`
```text
# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.password.file=`ACTIVEMQ_CONF`/jmx.password"
# ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.access.file=`ACTIVEMQ_CONF`/jmx.access"
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.port=11099"
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.ssl=false"
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote.authenticate=false"
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Djava.rmi.server.hostname=本机对外IP"
ACTIVEMQ_SUNJMX_START="$ACTIVEMQ_SUNJMX_START -Dcom.sun.management.jmxremote"
```
3. Restart the ACTIVEMQ service, and add the corresponding ActiveMQ monitoring in HertzBeat. The parameters use the IP port configured by JMX.
### Configuration parameters
| Parameter name | Parameter help description |
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). |
| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. |
| JMX port | The HTTP port provided by JMX, the default is 11099. |
| JMX URL | Optional, customize the JMX URL connection |
| Username | Username used for authentication |
| password | password used for authentication |
| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful |
| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here |
### Collect Metrics
#### metrics: broker
| Metric Name | Unit | Description |
|-------------------------|------|-----------------------------------------------------------------------|
| BrokerName | None | The name of the broker. |
| BrokerVersion | None | The version of the broker. |
| Uptime | None | Uptime of the broker. |
| UptimeMillis | ms | Uptime of the broker in milliseconds. |
| Persistent | None | Messages are synchronized to disk. |
| MemoryPercentUsage | % | Percent of memory limit used. |
| StorePercentUsage | % | Percent of store limit used. |
| TempPercentUsage | % | Percent of temp limit used. |
| CurrentConnectionsCount | None | Attribute exposed for management |
| TotalConnectionsCount | None | Attribute exposed for management |
| TotalEnqueueCount | None | Number of messages that have been sent to the broker. |
| TotalDequeueCount | None | Number of messages that have been acknowledged on the broker. |
| TotalConsumerCount | None | Number of message consumers subscribed to destinations on the broker. |
| TotalProducerCount | None | Number of message producers active on destinations on the broker. |
| TotalMessageCount | None | Number of unacknowledged messages on the broker. |
| AverageMessageSize | None | Average message size on this broker |
| MaxMessageSize | None | Max message size on this broker |
| MinMessageSize | None | Min message size on this broker |
#### metrics: topic
| Metric Name | Unit | Description |
|--------------------|------|-------------------------------------------------------------------------------------------|
| Name | None | Name of this destination. |
| MemoryLimit | MB | Memory limit, in bytes, used by undelivered messages before paging to temporary storage. |
| MemoryPercentUsage | None | The percentage of the memory limit used |
| ProducerCount | None | Number of producers attached to this destination |
| ConsumerCount | None | Number of consumers subscribed to this destination. |
| EnqueueCount | None | Number of messages that have been sent to the destination. |
| DequeueCount | None | Number of messages that has been acknowledged (and removed) from the destination. |
| ForwardCount | None | Number of messages that have been forwarded (to a networked broker) from the destination. |
| InFlightCount | None | Number of messages that have been dispatched to, but not acknowledged by, consumers. |
| DispatchCount | None | Number of messages that has been delivered to consumers, including those not acknowledged |
| ExpiredCount | None | Number of messages that have been expired. |
| StoreMessageSize | B | The memory size of all messages in this destination's store. |
| AverageEnqueueTime | ms | Average time a message was held on this destination. |
| MaxEnqueueTime | ms | The longest time a message was held on this destination |
| MinEnqueueTime | ms | The shortest time a message was held on this destination |
| TotalBlockedTime | ms | Total time (ms) messages have been blocked by flow control |
| AverageMessageSize | B | Average message size on this destination |
| MaxMessageSize | B | Max message size on this destination |
| MinMessageSize | B | Min message size on this destination |
#### metrics: memory_pool
| Metric Name | Unit | Description |
|-------------|------|--------------|
| name | | metrics name |
| committed | kb | total size |
| init | kb | init size |
| max | kb | max size |
| used | kb | used size |
#### metrics: class_loading
| Metric Name | Unit | Description |
|-----------------------|------|--------------------------|
| LoadedClassCount | | Loaded Class Count |
| TotalLoadedClassCount | | Total Loaded Class Count |
| UnloadedClassCount | | Unloaded Class Count |
#### metrics: thread
| Metric Name | Unit | Description |
|-------------------------|------|----------------------------|
| TotalStartedThreadCount | | Total Started Thread Count |
| ThreadCount | | Thread Count |
| PeakThreadCount | | Peak Thread Count |
| DaemonThreadCount | | Daemon Thread Count |
| CurrentThreadUserTime | ms | Current Thread User Time |
| CurrentThreadCpuTime | ms | Current Thread Cpu Time |
home/versioned_docs/version-1.6.x/help/ai_config.md
+61
View File
@@ -0,0 +1,61 @@
---
id: aiConfig
title: AI QuickStart
sidebar_label: AI QuickStartr
keywords: [AI]
---
> The dialogue with artificial intelligence is achieved by configuring aiConfig in the application.yml file
## Configuration parameter description
| Name of the parameter | Parameter help description |
|-----------------------|-----------------------------------------------------------------------|
| type | Choose a large AI model (such as Zhipu, Tongyi thousand questions...) |
| model | Select the model, which defaults to GLM-4 |
| api-key | Gets the api_key, without which you cannot talk to the large model |
### Large model options and configuration details
#### ZhiPu AI
| Name of the parameter | Example | Link |
|-----------------------|-----------------------------------------------------|-----------------------------------------------------------------|
| type | zhiPu (must be exactly the same as example) | |
| model | glm-4-0520、glm-4 、glm-4-air、glm-4-airx、 glm-4-flash | |
| api-key | xxxxx.xxxxxx | [https://open.bigmodel.cn/login?redirect=%2Fusercenter%2Fapikeys](https://open.bigmodel.cn/login?redirect=%2Fusercenter%2Fapikeys) |
#### Alibaba AI
| Name of the parameter | Example | Link |
|-----------------------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| type | alibabaAi (must be exactly the same as example) | |
| model | qwen-turbo、qwen-plus、qwen-max、qwen-max-0428、qwen-max-0403、qwen-max-0107、qwen-max-longcontext | [https://help.aliyun.com/zh/dashscope/developer-reference/model-introduction?spm=a2c4g.11186623.0.0.4e0246c1RQFKMH](https://help.aliyun.com/zh/dashscope/developer-reference/model-introduction?spm=a2c4g.11186623.0.0.4e0246c1RQFKMH) |
| api-key | xxxxxxxxxxx | [https://help.aliyun.com/zh/dashscope/developer-reference/activate-dashscope-and-create-an-api-key?spm=a2c4g.11186623.0.i10](https://help.aliyun.com/zh/dashscope/developer-reference/activate-dashscope-and-create-an-api-key?spm=a2c4g.11186623.0.i10) |
#### Kimi AI
| Name of the parameter | Example | Link |
|-----------------------|-------------------------------------------------|-----------------------------------------------|
| type | kimiAi (must be exactly the same as example) | |
| model | moonshot-v1-8k、moonshot-v1-32k、moonshot-v1-128k | |
| api-key | xxxxxxxxxxx | [https://platform.moonshot.cn/console/api-keys](https://platform.moonshot.cn/console/api-keys) |
#### sparkDesk AI
QuickStart: [https://www.xfyun.cn/doc/platform/quickguide.html](https://www.xfyun.cn/doc/platform/quickguide.html)
| Name of the parameter | Example | Link |
|-----------------------|--------------------------------------------------|---------------------------------------|
| type | sparkDesk (must be exactly the same as example) | |
| model | general、generalv2、generalv3、generalv3.5、4.0Ultra | |
| api-key | xxxxxxxxxxx | [https://console.xfyun.cn/services/cbm](https://console.xfyun.cn/services/cbm) |
| api-secret | xxxxxxxxxxx | [https://console.xfyun.cn/services/cbm](https://console.xfyun.cn/services/cbm) |
| sparkDesk version | model |
|-------------------|-------------|
| Spark4.0 Ultra | 4.0Ultra |
| Spark Max | generalv3.5 |
| Spark Pro | generalv3 |
| Spark V2.0 | generalv2 |
| Spark Lite(free) | general |
home/versioned_docs/version-1.6.x/help/airflow.md
+38
View File
@@ -0,0 +1,38 @@
---
id: airflow
title: Monitoring Apache Airflow Monitoring
sidebar_label: Apache Airflow
keywords: [open source monitoring system, open source database monitoring, Apache Airflow monitoring]
---
> Collect and monitor general performance metrics for the Apache Airflow.
## Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------|
| Monitor Host | IP address, IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ without protocol prefix (e.g., https://, http://). |
| Task Name | Name identifying this monitoring, ensuring uniqueness. |
| Port | Port number of the database exposed to the outside, default is 8080. |
| Query Timeout | Set timeout for unresponsive connections, in milliseconds (ms), default is 3000ms. |
| HTTPS | Whether to enable HTTPS. |
| Collection Interval | Interval for periodic data collection during monitoring, in seconds, with a minimum interval of 30 seconds. |
| Whether to detect | Whether to perform a probe check for monitoring availability before adding a new monitor; operations proceed if successful. |
| Description | Additional information to identify and describe this monitoring, where users can add remarks. |
### Collection Metrics
#### Metric Set: airflow_health
| Metric Name | Metric Unit | Metric Description |
|--------------|-------------|--------------------|
| metadatabase | N/A | Response time |
| scheduler | N/A | scheduler health |
| triggerer | N/A | triggerer health |
#### Metric Set: airflow_version
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|---------------------|
| value | N/A | Airflow version |
| git_version | N/A | Airflow git version |
home/versioned_docs/version-1.6.x/help/alarm_center.md
+57
View File
@@ -0,0 +1,57 @@
---
id: alarm_center
title: Alarm Center
sidebar_label: Alarm Center
keywords:
[open-source monitoring system, alarm center, alarm management, alarm display]
---
> The Alarm Center serves as a comprehensive visualization platform that displays all alarms after undergoing grouping, consolidation, suppression, and silencing processes. It encompasses both internally triggered threshold-based alarms and integrated third-party notifications.
## Alarm Sources
The HertzBeat Alarm Center manages notifications from two primary sources:
1. Internal Threshold-Triggered Alarms
- Generated when monitoring metrics exceed predefined thresholds
- Directly correlated with monitoring tasks and threshold rules configured within the system
- Manageable through adjustment of monitoring parameters and threshold configurations
2. Third-Party Integrated Alarms
- Received through API interfaces from external systems
- Compatible with various monitoring systems and alarm platforms
- Processed through identical workflow as internal alarms
## Alarm Processing Mechanism
Before appearing in the Alarm Center, all notifications undergo several processing stages:
1. Grouping
- Categorizes related alarms based on source, type, severity, and other attributes (labels)
- Facilitates efficient management of high-volume alarms
- Supports customizable grouping rules for diverse scenarios
2. Consolidation
- Mitigates notification fatigue from multiple similar alarms within short intervals
- Presents consolidated alarms in a streamlined format, eliminating redundancy
3. Suppression
- Manages alarm dependencies
- Suppresses secondary alarms when primary alarms are triggered
- Supports configurable suppression rules based on alarm dependencies
4. Silencing
- Temporarily mutes specific alarms during designated periods
- Ideal for system maintenance windows and known issue handling
- Enables time-based silence rule configuration
## Alarm Center Interface
![alarm_center](/img/docs/help/alarm-center-1.png)
The Alarm Center provides a comprehensive view of all system alarms:
1. Alarm Display
- Lists all alarms with crucial information including status, source, labels, and timestamps
- Offers detailed view functionality for comprehensive alarm information and context
2. Search Functionality
- Enables rapid alarm identification
- Supports multiple search criteria (labels, annotations, alarm status)
3. Alarm Management
- Alarm Deletion: Removes alarms no longer requiring attention
home/versioned_docs/version-1.6.x/help/alert_console.md
+18
View File
@@ -0,0 +1,18 @@
---
id: alert_console
title: Custom console address in alarm template
sidebar_label: Console address in alarm template
---
> After the threshold is triggered, send the alarm information. When you notify through DingDing / enterprise Wechat / FeiShu robot or email, the alarm content has a detailed link to log in to the console.
## Custom settings
In our startup configuration file application.yml, find the following configuration
```yml
alerter:
console-url: #Here is our custom console address
```
The default value is the official console address of HertzBeat.
home/versioned_docs/version-1.6.x/help/alert_dingtalk.md
+41
View File
@@ -0,0 +1,41 @@
---
id: alert_dingtalk
title: Alert DingDing robot notification
sidebar_label: Alert DingDing robot notification
keywords: [open source monitoring tool, open source alerter, open source DingDing robot notification]
---
> After the threshold is triggered send alarm information and notify the recipient by DingDing robot.
## Operation steps
1. **【DingDing desktop client】-> 【Group settings】-> 【Intelligent group assistant】-> 【Add new robot-select custom】-> 【Set robot name and avatar】-> 【Note⚠️Set custom keywords: HertzBeat】 ->【Copy its webhook address after adding successfully】**
> Note⚠️ When adding a robot, its custom keywords need to be set in the security setting block: HertzBeat. Other security settings or the IP segment don't need to be filled in.
![email](/img/docs/help/alert-notice-8.png)
2. **【Save access_token value of the WebHook address of the robot】**
> eg： webHook address：`https://oapi.dingtalk.com/robot/send?access_token=43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f`
> Its robot access_token value is `43aac28a236e001285ed84e473f8eabee70f63c7a70287acb0e0f8b65fade64f`
3. **【Alarm notification】->【Add new recipient】 ->【Select DingDing robot notification method】->【Set DingDing robot ACCESS_TOKEN】-> 【Confirm】**
![email](/img/docs/help/alert-notice-9.png)
4. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】**
> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.**
![email](/img/docs/help/alert-notice-4.png)
### DingDing robot common issues
1. DingDing group did not receive the robot alarm notification.
> Please check whether there is any triggered alarm information in the alarm center.
> Please check whether DingDing robot is configured with security custom keywords ：HertzBeat.
> Please check whether the robot ACCESS_TOKEN is configured correctly and whether the alarm strategy association is configured.
Other issues can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/alert_discord.md
+68
View File
@@ -0,0 +1,68 @@
---
id: alert_discord
title: Alert Discord Bot Notifications
sidebar_label: Alert Discord bot notification
keywords: [open source monitoring tool, open source alerter, open source Discord bot notification]
---
> Send an alarm message after the threshold is triggered, and notify the recipient through the Discord robot.
## Steps
### Create an application in Discord, create a robot under the application, and get the robot Token
1. Visit [https://discord.com/developers/applications](https://discord.com/developers/applications) to create an application
![bot](/img/docs/help/discord-bot-1.png)
2. Create a robot under the application and get the robot Token
![bot](/img/docs/help/discord-bot-2.png)
![bot](/img/docs/help/discord-bot-3.png)
3. Authorize the bot to the chat server
> Authorize the robot under the OAuth2 menu, select `bot` for `SCOPES`, `BOT PERMISSIONS` select `Send Messages`
![bot](/img/docs/help/discord-bot-4.png)
> Obtain the URL generated at the bottom, and the browser accesses this URL to officially authorize the robot, that is, to set which chat server the robot will join.
4. Check if your chat server has joined robot members
![bot](/img/docs/help/discord-bot-5.png)
### Enable developer mode and get Channel ID
1. Personal Settings -> Advanced Settings -> Enable Developer Mode
![bot](/img/docs/help/discord-bot-6.png)
2. Get channel Channel ID
> Right-click the chat channel you want to send the robot message to, click the COPY ID button to get the Channel ID
![bot](/img/docs/help/discord-bot-7.png)
### Add an alarm notification person in HertzBeat, the notification method is Discord Bot
1. **[Alarm notification] -> [Add recipient] -> [Select Discord robot notification method] -> [Set robot Token and ChannelId] -> [OK]**
![email](/img/docs/help/discord-bot-8.png)
2. **Configure the associated alarm notification strategy⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]**
> **Note ⚠️ Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients**.
![email](/img/docs/help/alert-notice-policy.png)
### Discord Bot Notification FAQ
1. Discord doesn't receive bot alert notifications
> Please check whether the alarm information has been triggered in the alarm center
> Please check whether the robot Token and ChannelId are configured correctly, and whether the alarm policy association has been configured
> Please check whether the bot is properly authorized by the Discord chat server
Other questions can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/alert_email.md
+33
View File
@@ -0,0 +1,33 @@
---
id: alert_email
title: Alert email notification
sidebar_label: Alert email notification
keywords: [open source monitoring tool, open source alerter, open source email notification]
---
> After the threshold is triggered send alarm information and notify the recipient by email.
## Operation steps
1. **【Alarm notification】->【Add new recipient】 ->【Select email notification method】**
![email](/img/docs/help/alert-notice-1.png)
2. **【Get verification code】-> 【Enter email verification code】-> 【Confirm】**
![email](/img/docs/help/alert-notice-2.png)
![email](/img/docs/help/alert-notice-3.png)
3. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】**
> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.**
![email](/img/docs/help/alert-notice-4.png)
### Email notification common issues
1. HertzBeat deployed on its own intranet cannot receive email notifications
> HertzBeat needs to configure its own mail server. Please confirm whether you have configured its own mail server in application.yml
Other issues can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/alert_enterprise_wechat_app.md
+34
View File
@@ -0,0 +1,34 @@
---
id: alert_enterprise_wechat_app
title: Alert Enterprise Wechat App notification
sidebar_label: Alert Enterprise Wechat App notification
keywords: [open source monitoring tool, open source alerter, open source Enterprise Wechat App notification]
---
> After the threshold is triggered send alarm information and notify the recipient by enterprise WeChat App.
## Operation steps
1. **【Enterprise Wechat backstage】-> 【App Management】-> 【Create an app】-> 【Set App message】->【Copy AgentId and Secret adding successfully】**
![email](/img/docs/help/alert-wechat-1.jpg)
2. **【Alarm notification】->【Add new recipient】 ->【Select Enterprise WeChat App notification method】->【Set Enterprise WeChat ID,Enterprise App ID and Enterprise App Secret 】-> 【Confirm】**
![email](/img/docs/help/alert-wechat-2.jpg)
3. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】**
> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.**
![email](/img/docs/help/alert-wechat-3.jpg)
### Enterprise WeChat App common issues
1. Enterprise WeChat App did not receive the alarm notification.
> Please check if the user has application permissions.
> Please check if the enterprise application callback address settings are normal.
> Please check if the server IP is on the enterprise application whitelist.
Other issues can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/alert_feishu.md
+38
View File
@@ -0,0 +1,38 @@
---
id: alert_feishu
title: Alert FeiShu robot notification
sidebar_label: Alert FeiShu robot notification
keywords: [open source monitoring tool, open source alerter, open source feishu bot notification]
---
> After the threshold is triggered send alarm information and notify the recipient by FeiShu robot.
## Operation steps
1. **【FeiShu client】-> 【Group settings】-> 【Bots】-> 【Add Bot】-> 【Custom Bot】 -> 【Set robot name and avatar】-> 【Copy its webhook URL after adding successfully】**
2. **【Save the key value of the WebHook address of the robot】**
> eg： webHook address：`https://open.feishu.cn/open-apis/bot/v2/hook/3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4`
> Its robot KEY value is `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4`
3. **【Alarm notification】->【Add new recipient】 ->【Select FeiShu robot notification method】->【Set FeiShu robot KEY】-> 【Confirm】**
4. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】**
> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.**
![email](/img/docs/help/alert-notice-4.png)
### FeiShu robot notification common issues
1. FeiShu group did not receive the robot alarm notification.
> Please check whether there is any triggered alarm information in the alarm center.
> Please check whether the robot key is configured correctly and whether the alarm strategy association is configured.
2. How to @someone in alarm notification
> In the form for adding recipients, fill in the `User ID`. If you need to @everyone, you can enter `all` in the `User ID` field. Multiple user IDs are also supported, separated by commas `,`. For detailed instructions on how to get the Feishu user ID, please refer to: [Get feishu user id](https://open.feishu.cn/document/faq/trouble-shooting/how-to-get-internal-user-id).
Other issues can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/alert_slack.md
+35
View File
@@ -0,0 +1,35 @@
---
id: alert_slack
title: Alert Slack Webhook Notifications
sidebar_label: Alert Slack Webhook Notification
keywords: [open source monitoring tool, open source alerter, open source slack webhook notification]
---
> Send an alarm message after the threshold is triggered, and notify the recipient through the Slack Webhook.
## Steps
### Open Webhook in Slack, get Webhook URL
Refer to the official website document [Sending messages using Incoming Webhooks](https://api.slack.com/messaging/webhooks)
### Add an alarm notifier to HertzBeat, and the notification method is Slack Webhook
1. **【Alarm Notification】->【Add Recipient】->【Select Slack Webhook Notification Method】->【Set Webhook URL】-> 【OK】**
![email](/img/docs/help/slack-bot-1.png)
2. **Configure the associated alarm notification strategy⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]**
> **Note ⚠️ Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients**.
![email](/img/docs/help/alert-notice-policy.png)
### Slack Notification FAQ
1. Slack did not receive the robot warning notification
> Please check whether the alarm information has been triggered in the alarm center
> Please check whether the slack webhook url are configured correctly, and whether the alarm policy association has been configured
Other questions can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/alert_smn.md
+43
View File
@@ -0,0 +1,43 @@
---
id: alert_smn
title: Alert Huawei Cloud SMN Notifications
sidebar_label: Alert Huawei Cloud SMN Notifications
keywords: [ open source monitoring tool, open source alerter, open source Huawei Cloud SMN notification ]
---
> Send an alarm message after the threshold is triggered, and notify the recipient through the Huawei Cloud SMN.
## 操作步骤
1. **According to [Huawei Cloud SMN Official Document](https://support.huaweicloud.com/qs-smn/smn_json.html) activate the SMN service and configure SMN**
![alert-notice-10](/img/docs/help/alert-notice-10.png)
2. **Save topic URN for SMN**
![alert-notice-11](/img/docs/help/alert-notice-11.png)
3. **According to [Huawei Cloud Signature Document](https://support.huaweicloud.com/devg-apisign/api-sign-provide.html) obtain AK, SK, and project ID**
![alert-notice-12](/img/docs/help/alert-notice-12.png)
![alert-notice-13](/img/docs/help/alert-notice-13.png)
4. **【Alarm Notification】->【Add Recipient】->【Select Slack Webhook Notification Method】->【Set Huawei Cloud SMN AK, SK and other configurations】-> 【OK】**
![alert-notice-14](/img/docs/help/alert-notice-14.png)
5. **Configure the associated alarm notification strategy⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]**
> **Note ⚠️ Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients**.
![email](/img/docs/help/alert-notice-4.png)
### Huawei Cloud SMN Notification FAQ
1. Huawei Cloud SMN did not receive the robot warning notification
> Please check whether the alarm information has been triggered in the alarm center
> Please check whether the Huawei Cloud SMN AK, SK and other configurations are configured correctly, and whether the alarm policy association has been configured
Other questions can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/alert_sms.md
+282
View File
@@ -0,0 +1,282 @@
---
id: alert_sms
title: Alert SMS notification
sidebar_label: Alert SMS notification
keywords: [open source monitoring tool, open source alerter, open source SMS alert notification]
---
> After the threshold is triggered send alarm information and notify the recipient by SMS.
## SMS Service Configuration
Only when you successfully configure your own SMS service will the alert SMS triggered within the monitoring system be sent correctly.
HertzBeat provides two ways to configure the SMS service: modifying the `application.yml` configuration file directly or configuring it through the HertzBeat frontend interface (Settings > Message Server Setting).
> ⚠️ Note: Only one method can be effective at a time. If both methods are configured and enabled, HertzBeat will prioritize the SMS service configured in the frontend interface.
### Tencent Cloud SMS Configuration
Add/Fill in the following Tencent Cloud SMS server configuration to `application.yml` (replace parameters with your own SMS server configuration):
```yaml
alerter:
sms:
enable: true # Whether to enable
type: tencent # SMS provider type, supports "tencent"
tencent: # Tencent Cloud SMS configuration
secret-id: AKIDbQ4VhdMr89wDedFrIcgU2PaaMvOuBCzY
secret-key: PaXGl0ziY9UcWFjUyiFlCPMr77rLkJYlyA
app-id: 1435441637
sign-name: HertzBeat
template-id: 1343434
```
1. Create a signature (sign-name) in Tencent Cloud SMS
![image](https://github.com/apache/hertzbeat/assets/40455946/3a4c287d-b23d-4398-8562-4894296af485)
2. Create a message template (template-id) in Tencent Cloud SMS
```text
Monitor: {1}, Alert Level: {2}. Content: {3}
```
![image](https://github.com/apache/hertzbeat/assets/40455946/face71a6-46d5-452c-bed3-59d2a975afeb)
3. Create an application (app-id) in Tencent Cloud SMS
![image](https://github.com/apache/hertzbeat/assets/40455946/2732d710-37fa-4455-af64-48bba273c2f8)
4. Obtain Tencent Cloud Access Management credentials (secret-id, secret-key)
![image](https://github.com/apache/hertzbeat/assets/40455946/36f056f0-94e7-43db-8f07-82893c98024e)
### Alibaba Cloud SMS Configuration
To activate and use Alibaba Cloud SMS service, you can refer to the official Alibaba Cloud documentation: [SMS Getting Started Guide](https://help.aliyun.com/zh/sms/getting-started/get-started-with-sms)
You can configure the Alibaba Cloud SMS service either through the graphical interface or in the `application.yml` file.
To use `application.yml`, add/fill in the following Alibaba Cloud SMS configuration (replace parameters with your own SMS server configuration):
```yaml
alerter:
sms:
enable: true # Whether to enable
type: alibaba # SMS provider type, supports "alibaba"
alibaba: # Alibaba Cloud SMS configuration
access-key-id: # Your AccessKey ID
access-key-secret: # Your AccessKey Secret
sign-name: # SMS signature
template-code: # SMS template code
```
1. Create an Alibaba Cloud account and activate SMS service
- Visit [Alibaba Cloud SMS Console](https://dysms.console.aliyun.com/)
- Activate SMS service
2. Create a signature (sign-name)
- Log in to [SMS Console](https://dysms.console.aliyun.com/)
- Select Domestic/International SMS service
- Go to "Signature Management" page and click "Add Signature"
- Fill in signature information and submit for review
- Wait for signature approval
3. Create a message template (template-code)
- Go to "Template Management" page
- Click "Add Template"
- Create a template with the following format:
```text
Monitor: `instance`, Alert Level: `priority`. Content: `content`
```
- Submit the template for review
4. Obtain Access Key credentials (access-key-id, access-key-secret)
:::tip
Alibaba Cloud officially recommends using RAM user AccessKey with minimal permissions.
:::
- [Go to RAM Access Control](https://ram.console.aliyun.com/users) to manage RAM users
- Create user and select "Access Key for API Access"
- Securely save the AccessKey ID and AccessKey Secret
- Grant SMS service permission "AliyunDysmsFullAccess" to the user
Now you can configure this information in your hertzbeat application.
### UniSMS Configuration
UniSMS is an aggregated SMS service platform. You can refer to [UniSMS Documentation](https://unisms.apistd.com/docs/tutorials) for configuration.
Add/Fill in the following UniSMS configuration to `application.yml` (replace parameters with your own SMS server configuration):
```yaml
alerter:
sms:
enable: true # Whether to enable
type: unisms # SMS provider type, set to unisms
unisms: # UniSMS configuration
# auth-mode: simple or hmac
auth-mode: simple
access-key-id: YOUR_ACCESS_KEY_ID
# hmac mode need to fill in access-key-secret
access-key-secret: YOUR_ACCESS_KEY_SECRET
signature: YOUR_SMS_SIGNATURE
template-id: YOUR_TEMPLATE_ID
```
1. Register UniSMS account
- Visit [UniSMS website](https://unisms.apistd.com/)
2. Create signature
- Log in to [UniSMS Console](https://unisms.apistd.com/console/)
- Go to "SMS Filing - Signature Management" page
- Click "Add Signature"
- Fill in signature information and submit for review
- Wait for signature approval
3. Create message template
- Go to "SMS Filing - Template Management" page
- Click "Add Template"
- Create a template with the following format:
```text
Monitor: {instance}, Alert Level: {priority}. Content: {content}
```
- Submit the template for review
4. Obtain `access-key-id` and `access-key-secret`
- Log in to [UniSMS Console](https://unisms.apistd.com/console/)
- Go to "Credential Management" page
- Get AccessKey ID and AccessKey Secret
- Securely save the AccessKey ID and AccessKey Secret
:::note
UniSMS provides two authentication methods for developers to choose from, which can be set in Console - Credential Management, with Simple Mode as default.
- Simple Mode [Default]: This mode only verifies AccessKey ID without request parameter signature, making it easier for developers to integrate quickly.
- HMAC Mode: This mode requires signing request parameters with AccessKey Secret to enhance the security and authenticity of requests.
:::
Now you can configure this information in your hertzbeat application.
### Smslocal SMS Configuration
SMSLocal is an all-in-one SMS service for businesses, with features like multi-way sending, strong security, and 24/7 support. You can refer to smslocal's [Developer Documentation](https://www.smslocal.com/developer/) for configuration.
Add/Fill in the following Smslocal configuration to `application.yml` (replace parameters with your own SMS server configuration):
```yaml
alerter:
sms:
enable: true # Whether to enable
type: smslocal # SMS provider type, set to smslocal
smslocal: # Smslocal configuration
api-key: YOUR_API_KEY_HERE
```
1. Register smslocal account
- Visit [Smslocal Website](https://www.smslocal.com/)
2. Obtain `api-key`
- Log in to [Smslocal Api Access](https://secure.smslocal.com/cpaas/pages/profile/settings/api-reference)
- Go to "API Access" page
- Click the eye button
- Copy the displayed access key
- Then you can configure the `application.yml` file
Now you can configure this information in your hertzbeat application.
### AWS Cloud SMS Configuration
To activate and use the AWS Cloud SMS service, refer to the official AWS documentation: [SMS Getting Started Guide](https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-sms-mms.html)
You can configure the AWS Cloud SMS service either through the graphical interface or in the `application.yml` file.
To use `application.yml`, add/fill in the following AWS Cloud SMS configuration (replace parameters with your own SMS server configuration):
```yaml
alerter:
sms:
enable: true # Whether to enable
type: aws # SMS provider type, supports "aws"
aws: # AWS Cloud SMS configuration
access-key-id: # Your AccessKey ID
access-key-secret: # Your AccessKey Secret
region: # Region Of Your AWS
```
1. Create an AWS Cloud account
- If you don’t already have an AWS account, sign up at [AWS Cloud SMS Console](https://aws.amazon.com/console/)
2. Obtain Access Key credentials (access-key-id, access-key-secret)
- Go to the AWS IAM (Identity and Access Management) Console.
- Create an IAM user with programmatic access and attach the necessary permissions.
- Retrieve your Access Key ID and Secret Access Key (You will need these for configuration).
3. Select a Specific AWS Region for SMS Messaging
- Choose a region that supports AWS End User Messaging (SMS Service).
- You can check the supported regions [guide](https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-sms-by-country.html).
4. Move from the AWS SMS Sandbox to Production
- By default, AWS SMS operates in sandbox mode, which restricts SMS delivery to verified phone numbers.
To send messages to any number, you must move your account to production mode. follow this [guide](https://docs.aws.amazon.com/sms-voice/latest/userguide/sandbox.html#sandbox-sms-move-to-production)
5. Verify Destination Phone Numbers (for Sandbox Mode)
- if you are still in sandbox mode, you can only send SMS messages to verified phone numbers. To add a verified number, follow this [guide](https://docs.aws.amazon.com/sms-voice/latest/userguide/verify-destination-phone-number.html)
- Note: You do not need to create an Origination Identity or Origination Simulator—just use the AWS CLI to add verified phone numbers.
> The message template is fixed as follows: "Instance: {}, Priority: {}, Content: {}"
Now you can configure this information in your hertzbeat application.
### Twilio SMS Configuration
To activate and use the Twilio SMS service, refer to the official Twilio documentation: [SMS Getting Started Guide](https://www.twilio.com/docs/sms/quickstart)
You can configure the Twilio SMS service either through the graphical interface or in the `application.yml` file.
To use `application.yml`, add/fill in the following Twilio SMS configuration (replace parameters with your own SMS server configuration):
```yaml
alerter:
sms:
enable: true # Whether to enable
type: twilio # SMS provider type, supports "twilio"
twilio: # Twilio SMS configuration
account-sid: # Your Twilio Account SID
auth-token: # Your Twilio Auth Token
twilio-phone-number: # Your Twilio Phone Number
```
1. Create a Twilio account
- If you don't have a Twilio account, sign up at [Twilio Console](https://www.twilio.com/console)
- You'll get a free trial account that allows you to test the SMS service
2. Obtain Twilio credentials
- After signing in, locate your Account SID and Auth Token on the dashboard
- These credentials will be used to authenticate API requests
3. Get a Twilio Phone Number
- In the Twilio Console, navigate to "Phone Numbers" > "Manage" > "Active Numbers"
- Click "Buy a Number" or use the trial number provided by Twilio
- Make sure the number has SMS capabilities enabled
- This number will be used as the sender for your SMS alerts
- A phone number is required for the Twilio SMS service to work
4. Testing Your Configuration on Twilio
- Twilio provides a sandbox environment for testing
- If you are in the trial period, you will only be able to send SMS to verified phone numbers
- To verify a phone number, add it to your verified phone numbers list in the Twilio Console
> The message follows the format: "Instance: {}, Priority: {}, Content: {}"
This information can be configured in the HertzBeat application.
## Operation steps
1. **【Alarm notification】->【Add new recipient】 ->【Select SMS notification method】**
2. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】**
> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.**
If you have any issues, please provide feedback through the communication group or ISSUE!
home/versioned_docs/version-1.6.x/help/alert_telegram.md
+65
View File
@@ -0,0 +1,65 @@
---
id: alert_telegram
title: Alert Telegram Bot Notification
sidebar_label: Alert Telegram bot notification
keywords: [open source monitoring tool, open source alerter, open source Telegram bot notification]
---
> Send an alarm message after the threshold is triggered, and notify the recipient through the Telegram robot.
## Steps
### Create a bot in Telegram, get Bot Token and UserId
1. Use [@BotFather](https://t.me/BotFather) to create your own bot and get an access token `Token`
![telegram-bot](/img/docs/help/telegram-bot-1.png)
2. Get the `User ID` of the recipient
**Use the recipient account you want to notify to send a message to the newly created Bot account**,
Visit ```https://api.telegram.org/bot`<TOKEN>`/getUpdates```, **`use the Bot Token from the previous step to replace the <TOKEN>`**, and respond to the first in the `Json` data A `result.message.from.id` value is the recipient's `User ID`
```json
{
"ok": true,
"result": [
{
"update_id": 632299191,
"message": {
"from":{
"id": "User ID"
},
"chat":{
},
"date": 1673858065,
"text": "111"
}
}
]
}
```
3. Record and save the `Token` and `User Id` we got
### Add an alarm notification person to HertzBeat, the notification method is Telegram Bot
1. **【Alarm Notification】->【Add Recipient】->【Select Telegram Robot Notification Method】->【Set Robot Token and UserId】-> 【OK】**
![email](/img/docs/help/telegram-bot-2.png)
2. **Configure the associated alarm notification strategy⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]**
> **Note ⚠️ Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients**.
![email](/img/docs/help/alert-notice-policy.png)
### Telegram Bot Notification FAQ
1. Telegram did not receive the robot warning notification
> Please check whether the alarm information has been triggered in the alarm center
> Please check whether the robot Token and UserId are configured correctly, and whether the alarm policy association has been configured
> UserId should be the UserId of the recipient of the message
Other questions can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/alert_threshold.md
+43
View File
@@ -0,0 +1,43 @@
---
id: alert_threshold
title: Alarm Threshold Configuration
sidebar_label: Alarm Threshold
---
:::tip
Alarm Threshold are the core function of `HertzBeat`, users can configure the trigger conditions of the alarm through the threshold rules.
Support real-time threshold and scheduled threshold, real-time threshold can directly trigger the alarm when monitoring data is collected, scheduled threshold supports PromQL and other expressions to calculate the trigger alarm within a specified time period.
Support visual page configuration or more flexible expression rule configuration, support configuring trigger times, alarm levels, notification templates, associated specified monitoring and so on.
:::
![threshold](/img/docs/help/alert-threshold-1.png)
## Real-time Threshold
> Real-time threshold means that the alarm is triggered directly when the monitoring data is collected, which is suitable for scenarios with high real-time requirements.
### Creating Threshold Rules
> HertzBeat Page -> Alerting -> Threshold -> New Threshold -> ReadTime Threshold Rule
Configure the threshold, for example: Select the SSL certificate metric object, configure the alarm expression-triggered when the metric `expired` is `true`, that is, `equals(expired,"true")`, set the alarm level notification template information, etc.
![HertzBeat](/img/docs/start/ssl_5.png)
Configuration item details:
- **Rule Name**：Unique name defining this threshold rule
- **Metric Object**: Select the monitoring metric object for which we need to configure the threshold. For example: Under website monitoring type -> under the summary metric set -> responseTime metric.
- **Threshold Rule**: Configure the alarm trigger rules for specific indicators, support graphical interface and expression rules. For expression environment variables and operators, see the page prompts. For detailed help on threshold expressions, see [Threshold Expression Help](alert_threshold_expr).
- **Associated Monitors**：Apply this threshold rule to the specified monitoring object (support direct binding and label association). If not configured, it will be applied to all monitoring objects that meet this threshold type rule.
- **Alert Level**: The alert level triggered by the threshold, from low to high: warning, critical, emergency.
- **Trigger Count**: Set how many times the threshold must be triggered before the alert is actually triggered.
- **Notification Template**: The template for the notification message sent after the alert is triggered. Template variables are provided on the page. For example: ``app`.`metrics`.`metric` metric value is `responseTime`, which is greater than 50 triggering the alert`.
- **Bind Label**: Select the label we need to apply. If no label is selected, it will apply to all services corresponding to the set metric object.
- **Bing Annotation**：Add annotation information to this threshold rule (the annotation content supports environment variables). When an alarm is generated, this annotation information will be rendered and attached to the alarm.
- **Enable Alert**: Enable or disable this alert threshold configuration.
**The threshold alert configuration is complete, and alerts that have been successfully triggered can be viewed in the [Alarm Center].**
**If you need to send alert notifications via email, WeChat, DingTalk, or Feishu, you can configure it in [Notification].**
## Scheduled Threshold
home/versioned_docs/version-1.6.x/help/alert_threshold_expr.md
+66
View File
@@ -0,0 +1,66 @@
---
id: alert_threshold_expr
title: Threshold Trigger Expression
sidebar_label: Threshold Trigger Expression
---
> When configuring threshold alerts, it is necessary to set up threshold trigger expressions. The system calculates whether to trigger an alert based on the expression and the monitored metric values. Here, we provide a detailed explanation of expression usage.
## Supported Operators in Expressions
| Operator (Visual Configuration) | Operator (Expression Configuration) | Supported Types | Description |
|---------------------------------|-------------------------------------|-----------------------|--------------------------------------------|
| Equals | equals(str1,str2) | String | Check if strings are equal |
| Not Equals | !equals(str1,str2) | String | Check if strings are not equal |
| Contains | contains(str1,str2) | String | Check if string contains |
| Not Contains | !contains(str1,str2) | String | Check if string does not contain |
| Matches | matches(str1,str2) | String | Check if string matches regex |
| Not Matches | !matches(str1,str2) | String | Check if string does not match regex |
| Exists | exists(obj) | String, Numeric, Time | Check if value exists |
| Not Exists | !exists(obj) | String, Numeric, Time | Check if value does not exist |
| Greater than | obj1 > obj2 | Numeric, Time | Check if value is greater than |
| Less than | obj1 < obj2 | Numeric, Time | Check if value is less than |
| Greater than or Equal to | obj1 >= obj2 | Numeric, Time | Check if value is greater than or equal to |
| Less than or Equal to | `obj1 <= obj2` | Numeric, Time | Check if value is less than or equal to |
| Not Equal to | obj1 != obj2 | Numeric, Time | Check if values are not equal |
| Equal to | obj1 == obj2 | Numeric, Time | Check if values are equal |
### Expression Function Library List
| Supported Function Library | Description |
|----------------------------------------------|--------------------------------------------------------------------------------------------|
| condition ? trueExpression : falseExpression | Ternary operator |
| toDouble(str) | Convert string to Double type |
| toBoolean(str) | Convert string to Boolean type |
| toInteger(str) | Convert string to Integer type |
| array[n] | Retrieve the nth element of an array |
| * | Multiplication |
| / | Division |
| % | Modulo |
| ( and ) | Parentheses for controlling the order of operations in logical or mathematical expressions |
| + | Addition |
| - | Subtraction |
| && | Logical AND operator |
| \|\| | Logical OR operator |
#### Supported Environment Variables
> Environment variables refer to variables supported by metric values, used in expressions. During threshold calculation and judgment, these variables will be replaced with actual values.
Non-fixed Environment Variables: These variables change dynamically based on the selected monitoring metric. For example, if we choose **response time metric for website monitoring**, the environment variable would be `responseTime - this represents response time variable`. If we want to set an alert trigger for **response time greater than 400 for website monitoring**, the expression would be `responseTime>400`.
Fixed Environment Variables (Less commonly used): `instance: instance value`
This variable is mainly used for calculations involving multiple instances. For instance, if we collect usage metrics for C drive and D drive (`usage` being a non-fixed environment variable), and we only want to set an alert for **usage greater than 80 for the C drive**, the expression would be `equals(instance,"c")&&usage>80`.
#### Expression Configuration Examples
1. Website Monitoring -> Alert when response time is greater than or equal to 400ms
`responseTime>=400`
2. API Monitoring -> Alert when response time is greater than 3000ms
`responseTime>3000`
3. Overall Monitoring -> Alert when response time for URL (instance) path '[https://baidu.com](https://baidu.com)' is greater than 200ms
`equals(instance,"https://baidu.com")&&responseTime>200`
4. MYSQL Monitoring -> Alert when 'threads_running' metric under 'status' exceeds 7
`threads_running>7`
If you encounter any issues, feel free to discuss and provide feedback through our community group or ISSUE tracker!
home/versioned_docs/version-1.6.x/help/alert_webhook.md
+66
View File
@@ -0,0 +1,66 @@
---
id: alert_webhook
title: Alert WebHook callback notification
sidebar_label: Alert webHook notification
keywords: [open source monitoring tool, open source alerter, open source webhook notification]
---
> After the threshold is triggered send alarm information and call the Webhook interface through post request to notify the recipient.
## Operation steps
1. **【Alarm notification】->【Add new recipient】 ->【Select WebHook notification method】-> 【Set WebHook callback address】 -> 【Confirm】**
![email](/img/docs/help/alert-notice-5.png)
2. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】**
> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.**
![email](/img/docs/help/alert-notice-4.png)
### WebHook callback POST body BODY content
Content format：JSON
```json
{
"alarmId": 76456,
"target": "`target`",
"thresholdId": 33455,
"priority": 0,
"content": "udp_port monitoring availability alert, code is FAIL",
"status": 0,
"times": 1,
"triggerTime": "2022-02-25T13:32:13",
"tags": {
"app": "windows",
"monitorId": "180427708350720",
"metrics": "availability",
"code": "UN_CONNECTABLE",
"thresholdId": "112",
"monitorName": "WINDOWS_192.168.124.12"
}
}
```
| | |
|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| alarmId | integer($int64) title: Alarm record entity primary key index ID 告警记录实体主键索引ID |
| target | string title: Alert target object: monitor availability-available metrics-app.metrics.field 告警目标对象: 监控可用性-available 指标-app.metrics.field |
| thresholdId | integer($int64) title: Alarm definition ID associated with the alarm 告警关联的告警定义ID |
| priority | string($byte) title: Alarm level 0: high-emergency-critical alarm-red 1: medium-critical-critical alarm-orange 2: low-warning-warning alarm-yellow 告警级别 0:高-emergency-紧急告警-红色 1:中-critical-严重告警-橙色 2:低-warning-警告告警-黄色 |
| content | string title: The actual content of the alarm notification 告警通知实际内容 |
| status | string($byte) title: Alarm status: 0-normal alarm (to be processed) 1-threshold triggered but not reached the number of alarms 2-recovered alarm 3-processed 告警状态: 0-正常告警(待处理) 1-阈值触发但未达到告警次数 2-恢复告警 3-已处理 |
| times | integer($int32) title: Alarm threshold trigger times 告警阈值触发次数 |
| triggerTime | integer($int64) title: Alarm trigger time (timestamp in milliseconds) 首次告警触发时间(毫秒时间戳) |
| tags | example: `{key1:value1}` |
### Webhook notification common issues
1. WebHook callback did not take effect
> Please check whether there is any triggered alarm information in the alarm center.
> Please check whether the configured webhook callback address is correct.
Other issues can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/alert_wework.md
+38
View File
@@ -0,0 +1,38 @@
---
id: alert_wework
title: Alert enterprise Wechat notification
sidebar_label: Alert enterprise Wechat notification
keywords: [open source monitoring tool, open source alerter, open source WeWork notification]
---
> After the threshold is triggered send alarm information and notify the recipient by enterprise Wechat robot.
## Operation steps
1. **【Enterprise Wechat】-> 【Group settings】-> 【Group robot】-> 【Add new robot】-> 【Set robot name and avatar】-> 【Copy its webhook address after adding successfully】**
![email](/img/docs/help/alert-notice-6.jpg)
2. **【Save the key value of the WebHook address of the robot】**
> eg： webHook address：`https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4`
> Its robot KEY value is `3adafc96-23d0-4cd5-8feb-17f6e0b5fcs4`
3. **【Alarm notification】->【Add new recipient】 ->【Select enterprise Wechat robot notification method】->【Set enterprise Wechat robot KEY】-> 【Confirm】**
![email](/img/docs/help/alert-notice-7.png)
4. **Configure the associated alarm notification strategy⚠️ 【Add new notification strategy】-> 【Associate the recipient just set】-> 【Confirm】**
> **Note⚠️ Adding a new recipient does not mean that it is effective to receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, to specify which messages are sent to which recipients.**
![email](/img/docs/help/alert-notice-4.png)
### Enterprise Wechat robot common issues
1. The enterprise wechat group did not receive the robot alarm notification.
> Please check whether there is any triggered alarm information in the alarm center.
> Please check whether the robot key is configured correctly and whether the alarm strategy association is configured.
Other issues can be fed back through the communication group ISSUE!
home/versioned_docs/version-1.6.x/help/almalinux.md
+109
View File
@@ -0,0 +1,109 @@
---
id: almalinux
title: Monitoring AlmaLinux Operating System Monitoring
sidebar_label: AlmaLinux Operating System
keywords: [open-source monitoring system, open-source operating system monitoring, AlmaLinux operating system monitoring]
---
> Collect and monitor common performance metrics of the AlmaLinux operating system.
## Configuration Parameters
| Parameter Name | Parameter Help Description |
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | The monitored peer's IPv4, IPv6, or domain name. Note ⚠️ No protocol header (e.g., https://, http://). |
| Task Name | A unique name to identify this monitoring task. |
| Port | The port provided by Linux SSH, default is 22. |
| Timeout | Set the connection timeout in milliseconds, default is 6000 ms. |
| Connection Reuse | Set whether to reuse SSH connections, default is false. If false, a new connection will be created for each retrieval of information. |
| Username | SSH connection username, optional. |
| Password | SSH connection password, optional. |
| Collector | Configure which collector to use for scheduling data collection for this monitoring. |
| Monitoring Period | The interval time for periodic data collection, in seconds, with a minimum interval of 30 seconds. |
| Binding Tags | Used for classifying and managing monitoring resources. |
| Description Note | Additional notes to identify and describe this monitoring, where users can make notes. |
| Key | The key required to connect to the server. |
### Data Collection Metrics
#### Metric Set: Basic System Information
| Metric Name | Metric Unit | Metric Help Description |
|----------------|-------------|--------------------------|
| Host Name | None | Host name |
| System Version | None | Operating system version |
| Uptime | None | Uptime |
#### Metric Set: CPU Information
| Metric Name | Metric Unit | Metric Help Description |
|----------------|-------------|-----------------------------------|
| info | None | CPU model |
| cores | Cores | Number of CPU cores |
| interrupt | Count | Number of CPU interrupts |
| load | None | Average CPU load (1/5/15 minutes) |
| context_switch | Count | Number of context switches |
| usage | % | CPU usage |
#### Metric Set: Memory Information
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|-------------------------------------|
| total | Mb | Total memory capacity |
| used | Mb | Memory used by user programs |
| free | Mb | Free memory capacity |
| buff_cache | Mb | Memory used for cache |
| available | Mb | Remaining available memory capacity |
| usage | % | Memory usage rate |
#### Metric Set: Disk Information
| Metric Name | Metric Unit | Metric Help Description |
|---------------|-------------|----------------------------------------|
| disk_num | Count | Total number of disks |
| partition_num | Count | Total number of partitions |
| block_write | Blocks | Total number of blocks written to disk |
| block_read | Blocks | Total number of blocks read from disk |
| write_rate | IOPS | Disk block write rate per second |
#### Metric Set: Network Card Information
| Metric Name | Metric Unit | Metric Help Description |
|----------------|-------------|-------------------------------|
| interface_name | None | Network card name |
| receive_bytes | Byte | Inbound data traffic (bytes) |
| transmit_bytes | Byte | Outbound data traffic (bytes) |
#### Metric Set: File System
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|-------------------------|
| filesystem | None | Name of the file system |
| used | Mb | Used disk size |
| available | Mb | Available disk size |
| usage | % | Usage rate |
| mounted | None | Mount point directory |
#### Metric Set: Top 10 CPU Processes
Statistics for the top 10 processes using the CPU. Statistics include: process ID, CPU usage, memory usage, and executed command.
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| cpu_usage | % | CPU usage |
| mem_usage | % | Memory usage |
| command | None | Executed command |
#### Metric Set: Top 10 Memory Processes
Statistics for the top 10 processes using memory. Statistics include: process ID, memory usage, CPU usage, and executed command.
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| mem_usage | % | Memory usage |
| cpu_usage | % | CPU usage |
| command | None | Executed command |
---
home/versioned_docs/version-1.6.x/help/api.md
+36
View File
@@ -0,0 +1,36 @@
---
id: api
title: Monitoring HTTP API
sidebar_label: HTTP API
keywords: [ open source monitoring tool, monitoring http api ]
---
> Call HTTP API interface, check whether the interface is available, and monitor its response time and other Metrics.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Ports provided by website, http generally defaults to 80 and https generally defaults to 443 |
| Relative path | Suffix path of website address except IP port. For example, the relative path of `www.tancloud.io/console` website is `/console` |
| Request mode | Set the request mode of interface call：GET, POST, PUT, DELETE |
| Enable HTTPS | Whether to access the website through HTTPS. Note⚠️When HTTPS is enabled, the default corresponding port needs to be changed to 443 |
| Username | User name used for interface Basic authentication or Digest authentication |
| Password | Password used for interface Basic authentication or Digest authentication |
| Headers | HTTP request headers |
| Params | HTTP query params, support [time expression](time_expression) |
| Content-Type | Set the resource type when carrying the BODY request body data request |
| Request BODY | Set the carry BODY request body data, which is valid when PUT or POST request method is used, support [time expression](time_expression) |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：summary
| Metric name | Metric unit | Metric help description |
|--------------|-------------|-------------------------|
| responseTime | ms | Website response time |
home/versioned_docs/version-1.6.x/help/bulletin.md
+28
View File
@@ -0,0 +1,28 @@
---
id: bulletin
title: Customizable bulletins
sidebar_label: Customized bulletins
keywords: [bulletin, custom]
---
> Customize a bulletin to show a table of self-selected metrics for some kind of monitoring.
## Add Bulletin Item
1. Click `Add New Bulletin Item`, enter the `Bulletin Name`, scroll down to select the `Monitoring Type`, select the associated `Monitoring Task Name`, You can filter `Monitor Task Name` by `Label`, and then select the `Monitoring Metrics` you want to show in the shuttle box.
2. Click `OK` button to finish creating the customized bulletin.
![new-bulletin](/img/docs/help/bulletin-1.png)
### Viewing Multiple Bulletins
1. Click the name of the bulletin in the tab to view the details of that bulletin.
### Deleting Bulletins
1. Click the `Delete Bulletin Item` button to delete the current bulletin. 2.
2. Click the `Batch delete Bulletin Items` button to delete selected bulletins in a batch.
![bulletin](/img/docs/help/bulletin-2.png)
home/versioned_docs/version-1.6.x/help/centos.md
+81
View File
@@ -0,0 +1,81 @@
---
id: centos
title: CentOS operating system monitoring
sidebar_label: CentOS operating system
keywords: [open source monitoring tool, open source os monitoring tool, monitoring CentOS operating system metrics]
---
> Collect and monitor the general performance Metrics of CentOS operating system.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by Linux SSH. The default is 22 |
| Username | SSH connection user name, optional |
| Password | SSH connection password, optional |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|-------------|-------------|--------------------------|
| hostname | none | Host name |
| version | none | Operating system version |
| uptime | none | System running time |
#### Metric set：cpu
| Metric name | Metric unit | Metric help description |
|----------------|-------------|------------------------------------------------|
| info | none | CPU model |
| cores | cores | Number of CPU cores |
| interrupt | number | Number of CPU interrupts |
| load | none | Average load of CPU in the last 1/5/15 minutes |
| context_switch | number | Number of current context switches |
| usage | % | CPU usage |
#### Metric set：memory
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------------------|
| total | Mb | Total memory capacity |
| used | Mb | User program memory |
| free | Mb | Free memory capacity |
| buff_cache | Mb | Memory occupied by cache |
| available | Mb | Remaining available memory capacity |
| usage | % | Memory usage |
#### Metric set：disk
| Metric name | Metric unit | Metric help description |
|---------------|-------------|----------------------------------------|
| disk_num | blocks | Total number of disks |
| partition_num | partitions | Total number of partitions |
| block_write | blocks | Total number of blocks written to disk |
| block_read | blocks | Number of blocks read from disk |
| write_rate | iops | Rate of writing disk blocks per second |
#### Metric set：interface
| Metric name | Metric unit | Metric help description |
|----------------|-------------|------------------------------|
| interface_name | none | Network card name |
| receive_bytes | byte | Inbound data traffic(bytes) |
| transmit_bytes | byte | Outbound data traffic(bytes) |
#### Metric set：disk_free
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| filesystem | none | File system name |
| used | Mb | Used disk size |
| available | Mb | Available disk size |
| usage | % | usage |
| mounted | none | Mount point directory |
home/versioned_docs/version-1.6.x/help/clickhouse.md
+95
View File
@@ -0,0 +1,95 @@
---
id: clickhouse
title: Monitoring ClickHouse Database Monitoring
sidebar_label: ClickHouse Database
keywords: [open source monitoring system, open source database monitoring, ClickHouse database monitoring]
---
> Collect and monitor general performance metrics for the ClickHouse database.
## Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|--------------------------------------------------------------------------------------------------------------------------------|
| Monitor Host | IP address, IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ without protocol prefix (e.g., https://, http://). |
| Task Name | Name identifying this monitoring, ensuring uniqueness. |
| Port | Port number of the database exposed to the outside, default is 8123. |
| Query Timeout | Timeout for SQL queries to respond, in milliseconds (ms), default is 6000ms. |
| Database Name | Name of the database instance, optional. |
| Username | Username for database connection, optional. |
| Password | Password for database connection, optional. |
| Collection Interval | Interval for periodic data collection during monitoring, in seconds, with a minimum interval of 30 seconds. |
| Tag Binding | Used for categorizing and managing monitored resources. |
| Description | Additional information to identify and describe this monitoring, where users can add remarks. |
### Collected Metrics
#### Metric Set: ping Availability
| Metric Name | Metric Unit | Metric Description |
|--------------|-------------|--------------------|
| responseTime | N/A | Response time |
#### Metric Set: Data from system.metrics table
| Metric Name | Metric Unit | Metric Description |
|----------------------|-------------|----------------------------------------------------------|
| Query | N/A | Number of queries being executed |
| Merge | N/A | Number of background merges being executed |
| Move | N/A | Number of background moves being executed |
| PartMutation | N/A | Number of table mutations |
| ReplicatedFetch | N/A | Number of data blocks fetched from replicas |
| ReplicatedSend | N/A | Number of data blocks sent to replicas |
| ReplicatedChecks | N/A | Number of consistency checks on data blocks |
| QueryPreempted | N/A | Number of queries stopped or waiting |
| TCPConnection | N/A | Number of TCP connections |
| HTTPConnection | N/A | Number of HTTP connections |
| OpenFileForRead | N/A | Number of open readable files |
| OpenFileForWrite | N/A | Number of open writable files |
| QueryThread | N/A | Number of threads processing queries |
| ReadonlyReplica | N/A | Number of Replicated tables in read-only state |
| EphemeralNode | N/A | Number of ephemeral nodes in ZooKeeper |
| ZooKeeperWatch | N/A | Number of ZooKeeper event subscriptions |
| StorageBufferBytes | Bytes | Bytes in Buffer tables |
| VersionInteger | N/A | ClickHouse version number |
| RWLockWaitingReaders | N/A | Number of threads waiting for read-write lock on a table |
| RWLockWaitingWriters | N/A | Number of threads waiting for write lock on a table |
| RWLockActiveReaders | N/A | Number of threads holding read lock on a table |
| RWLockActiveWriters | N/A | Number of threads holding write lock on a table |
| GlobalThread | N/A | Number of threads in global thread pool |
| GlobalThreadActive | N/A | Number of active threads in global thread pool |
| LocalThread | N/A | Number of threads in local thread pool |
| LocalThreadActive | N/A | Number of active threads in local thread pool |
#### Metric Set: Data from system.events table
| Metric Name | Metric Unit | Metric Description |
|------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Query | N/A | Number of queries to parse and possibly execute. Excludes queries rejected due to AST size limits, quota limits, or simultaneous query limits. May include internal queries initiated by ClickHouse. Subqueries are not counted. |
| SelectQuery | N/A | Number of Select queries possibly executed |
| InsertQuery | N/A | Number of Insert queries possibly executed |
| InsertedRows | N/A | Number of rows inserted into all tables |
| InsertedBytes | Bytes | Number of bytes inserted into all tables |
| FailedQuery | N/A | Number of failed queries |
| FailedSelectQuery | N/A | Number of failed Select queries |
| FileOpen | N/A | Number of file openings |
| MergeTreeDataWriterRows | N/A | Number of data rows written to MergeTree tables |
| MergeTreeDataWriterCompressedBytes | Bytes | Number of compressed data bytes written to MergeTree tables |
#### Metric Set: Data from system.asynchronous_metrics table
| Metric Name | Metric Unit | Metric Description |
|------------------------------------------|-------------|-------------------------------------------------------|
| AsynchronousMetricsCalculationTimeSpent | N/A | Time spent calculating asynchronous metrics (seconds) |
| jemalloc.arenas.all.muzzy_purged | N/A | Number of purged muzzy pages |
| jemalloc.arenas.all.dirty_purged | N/A | Number of purged dirty pages |
| BlockReadBytes_ram1 | N/A | Number of bytes read from ram1 block |
| jemalloc.background_thread.run_intervals | N/A | Number of intervals jemalloc background thread ran |
| BlockQueueTime_nbd13 | N/A | Queue wait time for nbd13 block |
| jemalloc.background_thread.num_threads | N/A | Number of jemalloc background threads |
| jemalloc.resident | N/A | Physical memory size allocated by jemalloc (bytes) |
| InterserverThreads | N/A | Number of Interserver threads |
| BlockWriteMerges_nbd7 | N/A | Number of block write merges for nbd7 block |
| MarkCacheBytes | N/A | Size of marks cache in StorageMergeTree |
| MarkCacheFiles | N/A | Number of files in marks cache for StorageMergeTree |
| MaxPartCountForPartition | N/A | Maximum active data blocks in partitions |
home/versioned_docs/version-1.6.x/help/collector.md
+131
View File
@@ -0,0 +1,131 @@
---
id: collector
title: HertzBeat Collector
sidebar_label: Collector
keywords: [monitoring, observability, collector, metrics]
---
> HertzBeat Collector is a lightweight data collection module that enables metrics collection, high availability deployments, and cloud-edge collaboration in Apache HertzBeat.
## Introduction
HertzBeat Collector is a versatile and lightweight metrics collection module within the Apache HertzBeat monitoring system. It's designed to gather monitoring data from various targets and send the collected metrics to the main HertzBeat server for processing, alerting, and visualization.
With the collector module, you can implement:
- **High Availability**: Deploy multiple collectors to ensure continuous monitoring even if some collector instances fail
- **Load Balancing**: Distribute monitoring tasks across multiple collectors to improve performance
- **Cloud-Edge Collaboration**: Monitor resources in isolated networks while managing everything from a central HertzBeat server
## Collector Architecture
The collector module is built with a modular design to make it easily extensible for various monitoring scenarios. The architecture consists of:
1. **Collector Entry Point**: The main entry point for running the collector module, from which collection tasks are executed after startup.
2. **collector-basic**: Contains implementations for common protocols like HTTP, JDBC, SSH, SNMP, etc. These collectors typically don't require additional proprietary dependencies and can handle most basic monitoring needs.
3. **collector-common**: Provides general utility classes and methods, such as connection pools and caching mechanisms that other modules can reuse.
4. **collector-xxx**: Extension modules for specific services or protocols (MongoDB, RocketMQ, Kafka, NebulaGraph, etc.). These modules often require specific dependencies for their respective services.
## Supported Protocols
HertzBeat Collector supports an extensive list of monitoring protocols:
| Protocol Category | Protocols |
| ----------------- | ------------------------------------------------------------------------------------- |
| Web/API | `http`, `ssl_cert`, `websocket` |
| Databases | `jdbc`, `redis`, `mongodb`, `memcached` |
| Operating Systems | `ssh`, `ipmi` |
| Network | `icmp` (ping), `telnet`, `snmp`, `modbus` |
| Messaging | `mqtt`, `rocketmq`, `kafka` |
| Email | `pop3`, `smtp`, `imap` |
| Cloud Services | `prometheus`, `nebulagraph`, `ngql` |
| Others | `jmx`, `dns`, `ftp`, `ntp`, `udp`, `nginx`, `redfish`, `script`, `registry`, `httpsd` |
## Deployment Options
You can deploy HertzBeat Collector in several ways depending on your environment and needs, once you log in to the HertzBeat web interface and go to the collector, you can see the deployment options.
Parameters explanation:
- `-e IDENTITY=custom-collector-name`: (Optional) Set a unique identifier for this collector. Must be unique across all collectors.
- `-e MODE=public`: Set the running mode (public or private), for public cluster or private cloud-edge mode.
- `-e MANAGER_HOST=192.168.1.100`: Important! Set the IP address of the main HertzBeat server. Replace with your actual server IP.
- `-e MANAGER_PORT=1158`: (Optional) Set the port of the main HertzBeat server, default is 1158.
- `-v $(pwd)/logs:/opt/hertzbeat-collector/logs`: (Optional) Mount the log files to the local host.
## Operating Modes
HertzBeat Collector supports two operating modes:
### Public Mode (Cluster Mode)
In public mode, collectors form a cluster with the main HertzBeat server. Tasks are automatically distributed among collectors, providing high availability and load balancing.
- Set `MODE=public` when deploying the collector
- All collectors must have connectivity to the main HertzBeat server
- Great for horizontal scaling to handle large numbers of monitoring tasks
### Private Mode (Cloud-Edge Mode)
In private mode, collectors operate in isolated networks while still reporting to a central HertzBeat server. This allows monitoring of resources in multiple separate networks.
- Set `MODE=private` when deploying the collector
- Collectors need outbound connectivity to the HertzBeat server, but inbound connectivity is not required
- Ideal for monitoring resources across different data centers, cloud providers, or network segments
## Configuration Parameters
| Parameter | Description | Default |
| -------------- | ----------------------------------- | ------------------------- |
| `identity` | Unique identifier for the collector | Auto-generated if not set |
| `mode` | Operating mode (public/private) | public |
| `manager-host` | IP address of the HertzBeat server | IP |
| `manager-port` | Port of the HertzBeat server | 1158 |
## Collector Management
You can manage collectors through the HertzBeat web interface:
1. Navigate to the Overview page to see all registered collectors
2. Monitor collector status (online/offline), metrics tasks, and system information
3. Enable or disable collectors as needed
## High Availability Setup
To achieve high availability with HertzBeat collectors:
1. Deploy multiple collector instances across different servers or containers
2. Ensure all collectors have the same `mode` setting
3. Connect all collectors to the same HertzBeat server
4. HertzBeat will automatically distribute monitoring tasks and handle failover
If a collector goes offline, its tasks will be reassigned to other available collectors. When the collector comes back online, it will receive new tasks based on the current load distribution.
## Cloud-Edge Collaboration
For monitoring across isolated networks:
1. Deploy HertzBeat Server in your central management network
2. Deploy collectors in each isolated network you need to monitor
3. Configure collectors with:
- `MODE=private`
- `MANAGER_HOST=` pointing to your central HertzBeat server
4. Ensure outbound connectivity from each isolated network to the central server
5. Manage all monitoring tasks from the central HertzBeat dashboard
## Advanced Features
### Custom Protocol Support
HertzBeat's architecture allows for extending the collector with custom protocols. Developers can create new collector modules following the project's modular design.
### Task Scheduling
The collector automatically handles task scheduling based on task priority, available resources, and current system load. Tasks are processed with intelligent prioritization to ensure critical monitoring is performed first.
### Resource Utilization
Collectors are designed to be lightweight and efficient with system resources, making them suitable for deployment on various hardware, from small edge devices to powerful servers.
home/versioned_docs/version-1.6.x/help/debian.md
+97
View File
@@ -0,0 +1,97 @@
---
id: debian
title: Monitoring Debian System Monitoring
sidebar_label: Debian
keywords: [Open Source Monitoring System, Operating System Monitoring, Debian Monitoring]
---
> Collect and monitor general performance metrics of the Debian system.
## Configuration Parameters
| Parameter Name | Metric help description |
|-------------------------|-------------------------------------------------------------------------------------------------------------------|
| Target Host | The monitored destination IPV4, IPV6, or domain name. Note: no protocol header (e.g., https://, http://). |
| Task Name | A unique name to identify this monitoring task. |
| Port | SSH port of the Debian system, default: 22 |
| Timeout | Timeout for the connection, in milliseconds, default: 6000 milliseconds. |
| Connection Reuse | Whether to reuse the SSH connection, default: false. False means a new connection will be created for each query. |
| Username | Server username |
| Password | Server password |
| Collector | Configure which collector to use for scheduling this monitoring. |
| Monitoring Period | The interval for periodically collecting data, in seconds, with a minimum interval of 30 seconds. |
| Binding Tags | Used for categorizing and managing monitoring resources. |
| Metric help description | Additional notes and Metric help descriptions for this monitoring, users can add notes here. |
| Key | Key required to connect to the server. |
### Monitoring Metrics
#### Metric Set: Basic System Information
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|--------------------------|
| Host Name | N/A | Host name |
| System Version | N/A | Operating system version |
| Uptime | N/A | Boot time |
#### Metric Set: CPU Information
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|-------------------------|
| Info | N/A | Model |
| Cores | N/A | Number of cores |
| Interrupt | N/A | Number of interrupts |
| Load | N/A | Load |
| Context Switch | N/A | Context switches |
| Usage | % | Usage rate |
#### Metric Set: Memory Information
| Metric Name | Metric Unit | Metric help description |
|---------------------|-------------|------------------------------|
| Total Memory | Mb | Total memory capacity |
| User Program Memory | Mb | Memory used by user programs |
| Free Memory | Mb | Free memory capacity |
| Buff Cache Memory | Mb | Memory used by cache |
| Available Memory | Mb | Available memory |
| Memory Usage | % | Memory usage rate |
#### Metric Set: Disk Information
| Metric Name | Metric Unit | Metric help description |
|---------------|-------------|-------------------------------|
| Disk Num | N/A | Total number of disks |
| Partition Num | N/A | Total number of partitions |
| Block Write | N/A | Number of disk blocks written |
| Block Read | N/A | Number of disk blocks read |
| Write Rate | iops | Disk write rate |
#### Metric Set: Network Interface Information
Statistics for all network interface cards, including interface name, incoming data traffic, and outgoing data traffic.
Metric Unit: Mb
#### Metric Set: File System
Statistics for all mounted file systems. Statistics include: file system, usage, available space, usage rate, mount point.
Metric Unit:
- Usage: Mb
- Available Space: Mb
- Usage Rate: %
#### Metric Set: Top 10 CPU Processes
Statistics for the top 10 processes by CPU usage. Statistics include: process ID, CPU usage rate, memory usage rate, command being executed.
Metric Unit:
- CPU Usage Rate: %
- Memory Usage Rate: %
#### Metric Set: Top 10 Memory Processes
Statistics for the top 10 processes by memory usage. Statistics include: process ID, memory usage rate, CPU usage rate, command being executed.
Metric Unit:
- Memory Usage Rate: %
- CPU Usage Rate: %
home/versioned_docs/version-1.6.x/help/deepseek.md
+35
View File
@@ -0,0 +1,35 @@
---
id: deepseek
title: Monitoring Deepseek Account Status
sidebar_label: Deepseek Account Status
keywords: [Open Source Monitoring System, Open Source Network Monitoring, Deepseek Account Monitoring]
---
## Preparation
### Obtain Session Key
Log in to the Deepseek backend and visit the `https://platform.deepseek.com/api_keys` page to obtain the session key.
### Configuration Parameters
| Parameter Name | Parameter Description |
| ------------- | --------------------- |
| Monitoring Host | Enter `api.deepseek.com` here. |
| Task Name | The name that identifies this monitoring task, which must be unique. |
| Session Key | The session key obtained in the preparation step. |
| Collector | Configure which collector is used to schedule data collection for this monitoring. |
| Monitoring Interval | The interval for periodically collecting data, in seconds. The minimum interval that can be set is 30 seconds. |
| Bound Tags | Tags for categorizing and managing monitoring resources. |
| Description/Remarks | Additional remarks to identify and describe this monitoring. Users can add notes here. |
### Collection Metrics
#### Metric Set: Billing
| Metric Name | Metric Unit | Metric Description |
| ---------- | ---------- | ----------------- |
| Currency | None | Currency, either RMB or USD. |
| Available Balance | RMB/USD | Total available balance, including bonus and recharge balance. |
| Unexpired Bonus Balance | RMB/USD | Unexpired bonus balance. |
| Recharge Balance | RMB/USD | Recharge balance. |
home/versioned_docs/version-1.6.x/help/dm.md
+48
View File
@@ -0,0 +1,48 @@
---
id: dm
title: Monitoring DM database
sidebar_label: DM Database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring DM database metrics]
---
> Collect and monitor the general performance metrics of the DM database. DM8+ is supported.
## Configuration parameters
| Parameter name | Parameter help description |
|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitor Host | Monitored peer IPV4, IPV6 or domain name. Note ⚠️ without protocol headers (eg: https://, http://). |
| Monitor Name | Identifies the name of this monitor. The name needs to be unique. |
| Port | The port provided by the database externally, the default is 5236. |
| Query Timeout | Set the timeout when the SQL query does not respond to data, in ms milliseconds, the default is 3000 milliseconds. |
| database name | database instance name, optional. |
| username | database connection username, optional |
| password | database connection password, optional |
| URL | Database connection URL, optional |
| Collection Interval | Monitor periodical collection data interval, in seconds, the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and then continue to add and modify operations if the detection is successful |
| Description Remarks | More remarks that identify and describe this monitoring, users can remark information here |
### Collect metrics
#### Metric collection: basic
| Metric Name | Metric Unit | Metric Help Description |
|--------------|-------------|-------------------------------|
| PORT_NUM | None | Database exposed service port |
| CTL_PATH | None | Control File Path |
| MAX_SESSIONS | None | Maximum database connections |
#### Metric collection: status
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|----------------------------------|
| status$ | None | Open/Close status of DM database |
#### Metric collection: thread
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|-------------------------------------------------------------------------|
| dm_sql_thd | None | Thread for writing dmsql dmserver |
| dm_io_thd | None | IO threads, controlled by IO_THR_GROUPS parameter, default is 2 threads |
| dm_quit_thd | None | Thread used to perform a graceful shutdown of the database |
home/versioned_docs/version-1.6.x/help/dns.md
+70
View File
@@ -0,0 +1,70 @@
---
id: dns
title: Monitoring DNS
sidebar_label: DNS Monitor
keywords: [ open source monitoring tool, open source DNS monitoring tool, monitoring DNS metrics ]
---
> Collect and monitor the general performance Metrics of DNS.
**Protocol Use：DNS**
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|--------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6. Note⚠️Without protocol header (eg: https://, http://). |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique. |
| Monitoring port | The port for DNS service provided to the outside,default is 53. |
| Address For DNS | The address for domain name resolution. |
| Connect Timeout | Set the timeout for connecting to the DNS server, default is 6000 milliseconds. |
| Query Class | Resource class for DNS query. Optional values include `IN`, `CHAOS`, `HESIOD`, `NONE`, and `ANY`,default is IN. |
| Use TCP Protocol | DNS queries use the TCP protocol. |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. |
| Bind Tags | Used to classify and manage monitoring resources. |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here. |
### Collection Metrics
#### Metrics Set：Header
| Metric name | Metric unit | Metric help description |
|-------------------------|-------------|---------------------------------------------------|
| Response Time | ms | Time taken for DNS server to respond to requests. |
| Opcode | none | Type of the current message. |
| Response Status | none | Status code of the response. |
| Response Flags | none | Response flags. |
| Question Record Count | none | Number of question records. |
| Answer Record Count | none | Number of answer records. |
| Authority Record Count | none | Number of authoritative resource records. |
| Additional Record Count | none | Number of additional resource records. |
### Metrics Set: Question
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------|
| Section | none | Question record information, including the queried domain name, resource type, resource record class, and additional information. |
### Metrics Set: Answer
| Metric name | Metric unit | Metric help description |
|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------|
| Section0 | none | Answer record information, including the queried domain name, TTL, resource record class, resource type, and query result. |
> The metric set collects up to 10 records, with metric names from Section0 to Section9.
### Metrics Set: Authority
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| Section0 | none | SOA (Start of Authority) record for the domain name, including queried domain name, TTL, resource type, resource record class, and other information. |
> The metric set collects up to 10 records, with metric names from Section0 to Section9.
### Metrics Set: Additional
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-----------------------------------------|
| Section0 | none | Additional information for DNS queries. |
> The metric set collects up to 10 records, with metric names from Section0 to Section9.
home/versioned_docs/version-1.6.x/help/docker.md
+101
View File
@@ -0,0 +1,101 @@
---
id: docker
title: Monitor：Docker Monitor
sidebar_label: Docker Monitor
keywords: [open source monitoring tool, open source docker monitoring tool, monitoring docker metrics]
---
> Collect and monitor general performance Metrics of Docker containers.
## Pre-monitoring operations
If you want to monitor the container information in `Docker`, you need to open the port according to the following steps, so that the collection request can obtain the corresponding information.
**1. Edit the docker.server file:**
````shell
vi /usr/lib/systemd/system/docker.service
````
Find the **[Service]** node, modify the ExecStart property, and add `-H tcp://0.0.0.0:2375`
````shell
ExecStart=/usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock -H tcp://0.0.0.0:2375
````
This is equivalent to the **2375** port that is open to the outside world. Of course, it can be modified to other ports according to your own situation.
**2. Reload the Docker configuration to take effect:**
```shell
systemctl daemon-reload
systemctl restart docker
```
**Note: Remember to open the `2375` port number in the server console.**
**3. If the above method does not work:**
Open the `2375` port number inside the server.
```shell
firewall-cmd --zone=public --add-port=2375/tcp --permanent
firewall-cmd --reload
```
### Configuration parameters
| Parameter name | Parameter help description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitor Host | Monitored peer IPV4, IPV6 or domain name. Note ⚠️ without protocol headers (eg: https://, http://). |
| Monitor Name | Identifies the name of this monitor. The name needs to be unique. |
| Port | The port provided by the database externally, the default is 2375. |
| Query Timeout | Set the timeout when getting the Docker server API interface, in ms, the default is 3000 ms. |
| Container Name | Generally monitors all running container information. |
| username | connection username, optional |
| password | connection password, optional |
| URL | Database connection URL, optional, if configured, the parameters such as database name, username and password in the URL will override the parameters configured above |
| Collection Interval | Monitor periodical collection data interval, in seconds, the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and then continue to add and modify operations if the detection is successful |
| Description Remarks | More remarks that identify and describe this monitoring, users can remark information here |
### Collect metrics
#### Metric collection: system
| Metric Name | Metric Unit | Metric Help Description |
|--------------------|-------------|----------------------------------------------------|
| Name | None | Server Name |
| version | none | docker version number |
| os | none | server version eg: linux x86_64 |
| root_dir | none | docker folder directory eg: /var/lib/docker |
| containers | None | Total number of containers (running + not running) |
| containers_running | None | Number of running containers |
| containers_paused | none | number of containers in pause |
| images | None | The total number of container images. |
| ncpu | none | ncpu |
| mem_total | MB | Total size of memory used |
| system_time | none | system time |
#### Metric collection: containers
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|----------------------------------------------|
| id | None | The ID of the container in Docker |
| name | None | The container name in the Docker container |
| image | None | Image used by the Docker container |
| command | None | Default startup command in Docker |
| state | None | The running state of the container in Docker |
| status | None | Update time in Docker container |
#### Metrics collection: stats
| Metric Name | Metric Unit | Metric Help Description |
|------------------|-------------|------------------------------------------------------------|
| name | None | The name in the Docker container |
| available_memory | MB | The amount of memory that the Docker container can utilize |
| used_memory | MB | The amount of memory already used by the Docker container |
| memory_usage | None | Memory usage of the Docker container |
| cpu_delta | None | The number of CPUs already used by the Docker container |
| number_cpus | None | The number of CPUs that the Docker container can use |
| cpu_usage | None | Docker container CPU usage |
home/versioned_docs/version-1.6.x/help/doris_be.md
+170
View File
@@ -0,0 +1,170 @@
---
id: doris_be
title: Monitoring DORIS Database BE Monitoring
sidebar_label: DORIS Database BE
keywords: [Open Source Monitoring System, Open Source Database Monitoring, DORIS Database BE Monitoring]
---
> Collect and monitor general performance metrics for DORIS database BE. Supports DORIS 2.0.0.
## Pre-monitoring operations
| Parameter Name | Parameter Description |
|--------|-----------------------------------------------------|
| Monitor Host | The monitored target's IPV4, IPV6, or domain name. Note: Without the protocol header (e.g., https://, http://) |
| Task Name | A unique name identifying this monitoring task |
| Port | The port provided by the database to the outside, default is 8040 ,get the value of the`http_port` configuration item |
| Query Timeout | The timeout for the connection to not respond, in milliseconds, default is 3000 milliseconds |
| Database Name | Optional database instance name |
| Collection Interval | The interval between periodic data collections for monitoring, in seconds, with a minimum interval of 30 seconds |
| Probe Required | Whether to probe and check the availability of monitoring before adding new monitoring, continue with the addition or modification operation only if the probe is successful |
| Description | Additional notes and descriptions for this monitoring task |
### Collection Indicators
#### Metric Set:doris_be_load_channel_count
| Metric Name | Metric Unit | Metric help description |
|-------|------|-----------------------|
| value | None | The current number of load channels |
#### Metric Set:doris_be_memtable_flush_total
| Metric Name | Metric Unit | Metric help description |
|-------|------|--------------------|
| value | None | Cumulative number of memtable writes to disk |
#### Metric Set:doris_be_plan_fragment_count
| Metric Name | Metric Unit | Metric help description |
|-------|------|------------------------------|
| value | None | Number of fragment instances currently received |
#### Metric Set:doris_be_process_thread_num
| Metric Name | Metric Unit | Metric help description |
|-------|------|---------------------------------|
| value | None | Number of BE process threads, collected through /proc/pid/task |
#### Metric Set:doris_be_query_scan_rows
| Metric Name | Metric Unit | Metric help description |
|-------|------|------------------------------------------------------------------------------|
| value | None | Cumulative number of rows read. This only counts the data volume read from OLAP tables, and it represents RawRowsRead (some data rows may be skipped by the index and not actually read, but they are still recorded in this value). |
#### Metric Set:doris_be_result_buffer_block_count
| Metric Name | Metric Unit | Metric help description |
|-------|------|---------------------|
| value | None | Number of queries in the current query result cache |
#### Metric Set:doris_be_send_batch_thread_pool_queue_size
| Metric Name | Metric Unit | Metric help description |
|-------|------|---------------------|
| value | None | Number of tasks in the queue of the thread pool used for sending data packets during import |
#### Metric Set:doris_be_tablet_base_max_compaction_score
| Metric Name | Metric Unit | Metric help description |
|-------|------|-----------------------------|
| value | None | Current maximum Base Compaction Score |
#### Metric Set:doris_be_timeout_canceled_fragment_count
| Metric Name | Metric Unit | Metric help description |
|-------|------|----------------------------------|
| value | None | Cumulative number of fragment instances cancelled due to timeout |
#### Metric Set:doris_be_load_rows
| Metric Name | Metric Unit | Metric help description |
|-------|------|------------------------|
| value | None | Cumulative number of rows sent through tablet sink |
#### Metric Set:doris_be_all_rowsets_num
| Metric Name | Metric Unit | Metric help description |
|-------|------|-----------------|
| value | None | Current number of rowsets |
#### Metric Set:doris_be_all_segments_num
| Metric Name | Metric Unit | Metric help description |
|-------|------|------------------|
| value | None | Current number of segments |
#### Metric Set:doris_be_heavy_work_max_threads
| Metric Name | Metric Unit | Metric help description |
|-------|------|-------------------|
| value | None | Number of threads in the brpc heavy thread pool |
#### Metric Set:doris_be_light_work_max_threads
| Metric Name | Metric Unit | Metric help description |
|-------|------|-------------------|
| value | None | Number of threads in the brpc light thread pool|
#### Metric Set:doris_be_heavy_work_pool_queue_size
| Metric Name | Metric Unit | Metric help description |
|-------|------|---------------------------------|
| value | None | Maximum queue length of the brpc heavy thread pool; if exceeded, work submissions will be blocked |
#### Metric Set:doris_be_light_work_pool_queue_size
| Metric Name | Metric Unit | Metric help description |
|-------|------|---------------------------------|
| value | None | Maximum queue length of the brpc light thread pool; if exceeded, work submissions will be blocked |
#### Metric Set:doris_be_heavy_work_active_threads
| Metric Name | Metric Unit | Metric help description |
|-------|------|--------------------|
| value | None | Number of active threads in the brpc heavy thread pool |
#### Metric Set:doris_be_light_work_active_threads
| Metric Name | Metric Unit | Metric help description |
|-------|------|--------------------|
| value | None | Number of active threads in the brpc light thread pool |
#### Metric Set:doris_be_compaction_bytes_total
| Metric Name | Metric Unit | Metric help description |
|------------|------|------------------------------|
| base | Bytes | Cumulative data volume of Base Compaction |
| cumulative | Bytes | Cumulative data volume of Cumulative Compaction |
#### Metric Set:doris_be_disks_avail_capacity
| Metric Name | Metric Unit | Metric help description |
|-------|------|--------------------------------------------|
| path | None | Specify data directory |
| value | Bytes | `{path="/path1/"}` represents the remaining disk space of the /path1 directory's disk. |
#### Metric Set:doris_be_disks_total_capacity
| Metric Name | Metric Unit | Metric help description |
|-------|------|--------------------------------------------|
| path | None | Specify data directory |
| value | Bytes | `{path="/path1/"}` represents the total disk space of the disk where the /path1 directory is located. |
#### Metric Set:doris_be_local_bytes_read_total
| Metric Name | Metric Unit | Metric help description |
|-------|------|----------------------------|
| value | Bytes | Number of bytes read by LocalFileReader |
#### Metric Set:doris_be_local_bytes_written_total
| Metric Name | Metric Unit | Metric help description |
|-------|------|----------------------------|
| value | Bytes | Number of bytes written by LocalFileWriter |
#### Metric Set:doris_be_memory_allocated_bytes
| Metric Name | Metric Unit | Metric help description |
|-------|------|------------------------------------------|
| value | Bytes | Physical memory size of the BE process, retrieved from /proc/self/status/VmRSS |
home/versioned_docs/version-1.6.x/help/doris_fe.md
+132
View File
@@ -0,0 +1,132 @@
---
id: doris_fe
title: Monitoring DORIS Database FE Monitoring
sidebar_label: DORIS Database FE
keywords: [Open Source Monitoring System, Open Source Database Monitoring, DORIS Database FE Monitoring]
---
> Collect and monitor general performance metrics for DORIS database FE. Supports DORIS 2.0.0.
**Protocol: HTTP**
## Pre-monitoring operations
Check the `fe/conf/fe.conf` file to obtain the value of the `http_port` configuration item, which is used for monitoring.
### Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitor Host | The monitored target's IPV4, IPV6, or domain name. Note: Without the protocol header (e.g., https://, http://) |
| Task Name | A unique name identifying this monitoring task |
| Port | The port provided by the database to the outside, default is 8030 ,get the value of the`http_port` configuration item |
| Query Timeout | The timeout for the connection to not respond, in milliseconds, default is 3000 milliseconds |
| Database Name | Optional database instance name |
| Collection Interval | The interval between periodic data collections for monitoring, in seconds, with a minimum interval of 30 seconds |
| Probe Required | Whether to probe and check the availability of monitoring before adding new monitoring, continue with the addition or modification operation only if the probe is successful |
| Description | Additional notes and descriptions for this monitoring task |
### Collection Indicators
#### Metric Set: doris_fe_connection_total
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|----------------------------------------------------|
| value | None | The current number of MySQL port connections on FE |
#### Metric Set: doris_fe_edit_log_clean
Should not fail; if it does, manual intervention is required.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|---------------------------------------------------------------|
| success | None | The number of successful cleanups of historical metadata logs |
| failed | None | The number of failed cleanups of historical metadata logs |
#### Metric Set: doris_fe_edit_log
| Metric Name | Metric Unit | Metric help description |
|-------------------|-------------|---------------------------------------------|
| write | None | The count of metadata log write operations |
| read | None | The count of metadata log read operations |
| current | None | The current number of metadata logs |
| accumulated_bytes | Bytes | The cumulative value of metadata log writes |
| current_bytes | Bytes | The current value of metadata logs |
#### Metric Set: doris_fe_image_clean
Should not fail; if it does, manual intervention is required.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|----------------------------------------------------------------------|
| success | None | The number of successful cleanups of historical metadata image files |
| failed | None | The number of failed cleanups of historical metadata image files |
#### Metric Set: doris_fe_image_write
Should not fail; if it does, manual intervention is required.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------------------------------------------|
| success | None | The number of successful generations of metadata image files |
| failed | None | The number of failed generations of metadata image files |
#### Metric Set: doris_fe_query_err
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------------------------|
| value | None | The cumulative value of erroneous queries |
#### Metric Set: doris_fe_max_journal_id
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| value | None | The current maximum metadata log ID on the FE node. If it is a Master FE, it is the maximum ID currently written; if it is a non-Master FE, it represents the maximum metadata log ID currently being replayed. Used to observe if there is a large gap between the IDs of multiple FEs. A large gap indicates issues with metadata synchronization |
#### Metric Set: doris_fe_max_tablet_compaction_score
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| value | None | The largest compaction score value among all BE nodes. This value can observe the current cluster's maximum compaction score to judge if it is too high. If too high, there may be delays in queries or writes |
#### Metric Set: doris_fe_qps
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|---------------------------------------------------------------------------------|
| value | None | The number of queries per second on the current FE (only counts query requests) |
#### Metric Set: doris_fe_query_err_rate
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------------------------|
| value | None | The number of erroneous queries per second |
#### Metric Set: doris_fe_report_queue_size
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| value | None | The length of the queue for various regular reporting tasks on the BE side at the FE end. This value reflects the degree of blocking of reporting tasks on the Master FE node. A larger value indicates insufficient processing capacity on the FE |
#### Metric Set: doris_fe_rps
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|------------------------------------------------------------------------------------------------------|
| value | None | The number of requests per second on the current FE (includes queries and other types of statements) |
#### Metric Set: doris_fe_scheduled_tablet_num
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| value | None | The number of tablets currently being scheduled by the Master FE node. This includes tablets that are being repaired and tablets that are being balanced. This value can reflect the number of tablets currently migrating in the cluster. If there is a value for a long time, it indicates that the cluster is unstable |
#### Metric Set: doris_fe_txn_status
Can observe the number of import transactions in various states to determine if there is a backlog.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| unknown | None | Unknown state |
| prepare | None | In preparation |
| committed | None | Committed |
| visible | None | Visible |
| aborted | None | Aborted / Revoked |
home/versioned_docs/version-1.6.x/help/dynamic_tp.md
+101
View File
@@ -0,0 +1,101 @@
---
id: dynamic_tp
title: Monitoring DynamicTp ThreadPool
sidebar_label: DynamicTp Monitor
keywords: [open source monitoring tool, open source dynamicTp monitoring tool, monitoring DynamicTp metrics]
---
> Collect and monitor the thread pool performance Metrics exposed by DynamicTp actuator.
## PreRequisites
1. Integration Using `DynamicTp`
`DynamicTp` is a lightweight dynamic thread pool based on the configuration center of the Jvm language. It has built-in monitoring and alarm functions, which can be realized through SPI custom extensions.
For integrated use, please refer to the document [Quick Start](https://dynamictp.cn/guide/use/quick-start.html)
2. Open SpringBoot Actuator Endpoint to expose `DynamicTp` Metric interface
```yaml
management:
endpoints:
web:
exposure:
include: '*'
```
Test whether the access Metric interface `ip:port/actuator/dynamic-tp` has response json data as follows:
```json
[
{
"poolName": "commonExecutor",
"corePoolSize": 1,
"maximumPoolSize": 1,
"queueType": "LinkedBlockingQueue",
"queueCapacity": 2147483647,
"queueSize": 0,
"fair": false,
"queueRemainingCapacity": 2147483647,
"activeCount": 0,
"taskCount": 0,
"completedTaskCount": 0,
"largestPoolSize": 0,
"poolSize": 0,
"waitTaskCount": 0,
"rejectCount": 0,
"rejectHandlerName": null,
"dynamic": false,
"runTimeoutCount": 0,
"queueTimeoutCount": 0
},
{
"maxMemory": "4GB",
"totalMemory": "444MB",
"freeMemory": "250.34 MB",
"usableMemory": "3.81GB"
}
]
```
3. Add DynamicTp monitoring under HertzBeat middleware monitoring
### Configuration parameters
| Parameter name | Parameter help description |
| ------------ |------------------------------------ ------------------|
| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). |
| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. |
| Port | The port provided by the application service, the default is 8080. |
| Enable HTTPS | Whether to access the website through HTTPS, note ⚠️Enable HTTPS, the default corresponding port needs to be changed to 443 |
| Base Path | Exposed interface path prefix, default /actuator |
| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful |
| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here |
### Collect metrics
#### Metric collection: thread_pool
| Metric Name | Metric Unit | Metric Help Description |
|--------------------------|-------------|---------------------------------------------|
| pool_name | None | Thread pool name |
| core_pool_size | None | Number of core threads |
| maximum_pool_size | None | Maximum number of threads |
| queue_type | None | Task queue type |
| queue_capacity | MB | task queue capacity |
| queue_size | None | The current occupied size of the task queue |
| fair | None | Queue mode, SynchronousQueue will be used |
| queue_remaining_capacity | MB | task queue remaining size |
| active_count | None | Number of active threads |
| task_count | None | Total number of tasks |
| completed_task_count | None | Number of completed tasks |
| largest_pool_size | None | The largest number of threads in history |
| pool_size | none | current number of threads |
| wait_task_count | None | Number of tasks waiting to be executed |
| reject_count | None | Number of rejected tasks |
| reject_handler_name | None | Reject policy type |
| dynamic | None | Dynamic thread pool or not |
| run_timeout_count | None | Number of running timeout tasks |
| queue_timeout_count | None | Number of tasks waiting for timeout |
home/versioned_docs/version-1.6.x/help/elasticsearch.md
+63
View File
@@ -0,0 +1,63 @@
---
id: elasticsearch
title: Monitoring：ElasticSearch
sidebar_label: ElasticSearch
keywords: [ open source monitoring tool, monitoring ElasticSearch metrics ]
---
> Collect and monitor the general performance Metrics of ElasticSearch
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|--------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6. Note⚠️Without protocol header (eg: https://, http://). |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique. |
| Monitoring port | The HTTP API port opened by Elasticsearch,default is 9200. |
| SSL | Whether SSL is enabled for connecting to Elasticsearch. |
| Auth Type | Authentication type,Optional. |
| Username | Username,Optional. |
| Password | Password,Optional. |
| Connect Timeout | Set the timeout for elasticsearch query, default is 6000 milliseconds. |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. |
| Bind Tags | Used to classify and manage monitoring resources. |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here. |
### Collection Metrics
#### Metrics Set：health
| Metric name | Metric unit | Metric help description |
|-----------------------|-------------|-------------------------------------------|
| cluster_name | none | Cluster Name |
| status | none | status |
| nodes | none | Number of nodes in the cluster. |
| data_nodes | none | Number of data nodes in the cluster. |
| active_primary_shards | none | Number of active shards on primary nodes. |
| active_shards | none | Number of active shards. |
| active_percentage | % | Active Percentage |
| initializing_shards | none | Number of initialized shards. |
| unassigned_shards | none | Number of unassigned shards. |
#### Metrics Set：nodes
| Metric name | Metric unit | Metric help description |
|-------------|-------------|--------------------------|
| total | none | Number of nodes. |
| successful | none | Number of online nodes. |
| failed | none | Number of offline nodes. |
#### Metrics Set：nodes_detail
| Metric name | Metric unit | Metric help description |
|-------------------|-------------|-------------------------|
| node_name | none | Node Name |
| ip | none | IP Address |
| cpu_load_average | none | Cpu Load Average |
| cpu_percent | % | Cpu Percent |
| heap_used | MB | Heap Used |
| heap_used_percent | % | Heap Used Percent |
| heap_total | MB | Heap Total |
| disk_free | GB | Disk Free |
| disk_total | GB | Disk Total |
| disk_used_percent | % | Disk Used Percent |
home/versioned_docs/version-1.6.x/help/euleros.md
+107
View File
@@ -0,0 +1,107 @@
---
id: euleros
title: Monitoring EulerOS
sidebar_label: EulerOS
keywords: [ Open Source Monitoring System, Open Source OS Monitoring, EulerOS Monitoring ]
---
> Collect and monitor general performance metrics for EulerOS (system information, CPU, memory, disk, network interface, file system, top resource processes, etc.).
## Configuration Parameters
| Parameter Name | Parameter help description |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). |
| Task Name | Identifies the name of this monitoring, ensuring uniqueness. |
| Port | Port provided by Linux SSH externally, defaults to 22. |
| Timeout | Sets the timeout for connection in milliseconds (ms), defaults to 6000 ms. |
| Connection Reuse | Sets whether the SSH connection is reused, defaults to: false. Creates a new connection for each information retrieval if false. |
| Username | SSH connection username, optional. |
| Password | SSH connection password, optional. |
| Collector | Specifies which collector schedules the collection for this monitoring. |
| Monitoring Interval | Interval for periodically collecting data, in seconds. Minimum interval is 30 seconds. |
| Binding Tags | Used for categorizing and managing monitored resources. |
| Description | Additional remarks and descriptions for this monitoring, for users' reference. |
| PrivateKey | Key required for connecting to the server. |
### Collected Metrics
#### Metric Set: Basic Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|---------------------------|
| Host Name | None | Host name. |
| System Version | None | Operating system version. |
| Uptime | None | System uptime. |
#### Metric Set: CPU Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|-------------------------------------------|
| info | None | CPU model. |
| cores | None | Number of CPU cores. |
| interrupt | None | Number of CPU interrupts. |
| load | None | Average load for the last 1/5/15 minutes. |
| context_switch | None | Current context switches. |
| usage | % | CPU usage percentage. |
#### Metric Set: Memory Info
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|------------------------------------|
| total | Mb | Total memory capacity. |
| used | Mb | Used memory by user programs. |
| free | Mb | Free memory capacity. |
| buff_cache | Mb | Memory used for buffers and cache. |
| available | Mb | Available memory capacity. |
| usage | % | Memory usage percentage. |
#### Metric Set: Disk Info
| Metric Name | Metric Unit | Metric help description |
|---------------|-------------|------------------------------------|
| disk_num | None | Total number of disks. |
| partition_num | None | Total number of partitions. |
| block_write | None | Total blocks written to disk. |
| block_read | None | Total blocks read from disk. |
| write_rate | iops | Rate of blocks written per second. |
#### Metric Set: Interface Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|--------------------------------|
| interface_name | None | Name of the network interface. |
| receive_bytes | Mb | Inbound data traffic. |
| transmit_bytes | Mb | Outbound data traffic. |
#### Metric Set: Disk Free
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------|
| filesystem | None | Name of the file system. |
| used | Mb | Used disk space. |
| available | Mb | Available disk space. |
| usage | % | Disk usage percentage. |
| mounted | None | Mount point directory. |
#### Metric Set: Top10 CPU Process
Top 10 processes consuming CPU. Metrics include: Process ID, CPU usage, Memory usage, Command.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| cpu_usage | % | CPU usage |
| mem_usage | % | Memory usage |
| command | None | Executed command |
#### Metric Set: Top10 Memory Process
Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CPU usage, Command.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| mem_usage | % | Memory usage |
| cpu_usage | % | CPU usage |
| command | None | Executed command |
home/versioned_docs/version-1.6.x/help/flink.md
+35
View File
@@ -0,0 +1,35 @@
---
id: flink
title: Monitoring Flink
sidebar_label: Flink
keywords: [open source monitoring tool, open source flink monitoring tool]
---
> Collect and monitor the general performance Metrics of Flink.
## Configuration parameter
| Parameter Name | Parameter Help Description |
|---------------------|-----------------------------------------------------------------------------------------------------------------------------|
| Monitor Host | The monitored peer IPV4, IPV6, or domain name. Note: Do not include protocol headers (e.g., https://, http://). |
| Task Name | Identifier for this monitoring task, name must be unique. |
| Port | Monitoring port. |
| Query Timeout | Sets the timeout for JVM connection in milliseconds, default is 3000 milliseconds. |
| SSL | Whether to enable SSL (default is off). |
| Username | Connection username. |
| Password | Connection password. |
| Collection Interval | Interval for periodic data collection during monitoring, in seconds. The minimum settable interval is 30 seconds. |
| Whether to detect | Whether to perform a probe check for monitoring availability before adding a new monitor; operations proceed if successful. |
| Description Remarks | Additional identifiers and descriptions for this monitoring, where users can note information. |
### Collection Metrics
#### Metrics Set：Overview
| Metric Name | Metric Unit | Metric Help Description |
|--------------|-------------|-------------------------|
| slots_total | Units | Total number of slots. |
| slots_used | Units | Number of slots used. |
| task_total | Units | Total number of tasks. |
| jobs_running | Units | Number of jobs running. |
| jobs_failed | Units | Number of jobs failed. |
home/versioned_docs/version-1.6.x/help/flink_on_yarn.md
+137
View File
@@ -0,0 +1,137 @@
# Flink On Yarn Monitoring
> Measurement and monitoring of general metrics for Flink stream engine in Yarn running mode.
## Configuration Parameters
| Parameter Name | Parameter Help Description |
|---------------------|---------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | The monitored peer's IPV4, IPV6, or domain name. Note ⚠️ do not include protocol headers (e.g., https://, http://). |
| Task Name | The name identifying this monitoring task. The name must be unique. |
| Yarn Port | The Yarn port, corresponding to the port in `yarn.resourcemanager.webapp.address`. |
| Query Timeout | The timeout for JVM connections, in milliseconds, default is 3000 ms. |
| Enable SSL | Whether to enable SSL |
| Username | Connection username |
| Password | Connection password |
| Monitoring Interval | Interval for periodic data collection, in seconds, minimum interval is 30 seconds. |
| Tags | Used for categorizing and managing monitoring resources. |
| Description | Additional notes and descriptions for this monitoring task. Users can add notes here. |
### Collected Metrics
#### Metrics Set: JobManager Metrics
| Metric Name | Metric Unit | Metric Help Description |
|-------------------------------------------------------|-------------|----------------------------------------------------|
| Status.JVM.Memory.NonHeap.Committed | Bytes | Non-heap memory committed |
| Status.JVM.Memory.Mapped.TotalCapacity | Bytes | Total capacity of mapped memory |
| Status.JVM.Memory.NonHeap.Used | Bytes | Non-heap memory used |
| Status.JVM.Memory.Metaspace.Max | Bytes | Maximum capacity of metaspace |
| Status.JVM.GarbageCollector.G1_Old_Generation.Count | Count | Count of old generation garbage collections |
| Status.JVM.Memory.Direct.MemoryUsed | Bytes | Direct memory used |
| Status.JVM.Memory.Mapped.MemoryUsed | Bytes | Mapped memory used |
| Status.JVM.GarbageCollector.G1_Young_Generation.Count | Count | Count of young generation garbage collections |
| Status.JVM.Memory.Direct.TotalCapacity | Bytes | Total capacity of direct memory |
| Status.JVM.GarbageCollector.G1_Old_Generation.Time | ms | Time spent on old generation garbage collections |
| Status.JVM.Memory.Heap.Committed | Bytes | Heap memory committed |
| Status.JVM.Memory.Mapped.Count | Count | Count of mapped memory |
| Status.JVM.Memory.Metaspace.Used | Bytes | Metaspace memory used |
| Status.JVM.Memory.Direct.Count | Count | Count of direct memory |
| Status.JVM.Memory.Heap.Used | Bytes | Heap memory used |
| Status.JVM.Memory.Heap.Max | Bytes | Maximum capacity of heap memory |
| Status.JVM.GarbageCollector.G1_Young_Generation.Time | ms | Time spent on young generation garbage collections |
| Status.JVM.Memory.NonHeap.Max | Bytes | Maximum capacity of non-heap memory |
#### Metrics Set: JobManager Config
| Metric Name | Metric Unit | Metric Help Description |
|--------------------------------------------|-------------|----------------------------------------------------|
| internal.jobgraph-path | - | Internal job graph path |
| env.java.home | - | Java environment path |
| classloader.check-leaked-classloader | - | Whether to check for leaked class loaders |
| env.java.opts | - | Java options |
| high-availability.cluster-id | - | High availability cluster ID |
| jobmanager.rpc.address | - | JobManager's RPC address |
| jobmanager.memory.jvm-overhead.min | Bytes | Minimum JVM overhead for JobManager |
| jobmanager.web.port | Port | JobManager's Web port |
| webclient.port | Port | Web client port |
| execution.savepoint.ignore-unclaimed-state | - | Whether to ignore unclaimed state |
| io.tmp.dirs | Path | Temporary file directories |
| parallelism.default | - | Default parallelism |
| taskmanager.memory.fraction | - | TaskManager memory fraction |
| taskmanager.numberOfTaskSlots | - | Number of task slots for TaskManager |
| yarn.application.name | - | Yarn application name |
| taskmanager.heap.mb | MB | Heap memory size for TaskManager |
| taskmanager.memory.process.size | GB | Process memory size for TaskManager |
| web.port | Port | Web port |
| classloader.resolve-order | - | Class loader resolve order |
| jobmanager.heap.mb | MB | Heap memory size for JobManager |
| jobmanager.memory.off-heap.size | Bytes | Off-heap memory size for JobManager |
| state.backend.incremental | - | Whether the state backend is incremental |
| execution.target | - | Execution target |
| jobmanager.memory.process.size | GB | Process memory size for JobManager |
| web.tmpdir | Path | Web temporary directory |
| yarn.ship-files | Path | Yarn shipped files |
| jobmanager.rpc.port | Port | JobManager's RPC port |
| internal.io.tmpdirs.use-local-default | - | Whether to use local default temporary directories |
| execution.checkpointing.interval | ms | Checkpointing interval |
| execution.attached | - | Whether to execute attached |
| internal.cluster.execution-mode | - | Internal cluster execution mode |
| execution.shutdown-on-attached-exit | - | Whether to shutdown on attached exit |
| pipeline.jars | Path | Pipeline JAR files |
| rest.address | - | REST address |
| state.backend | - | State backend type |
| jobmanager.memory.jvm-metaspace.size | Bytes | JVM metaspace size for JobManager |
| $internal.deployment.config-dir | Path | Internal deployment configuration directory |
| $internal.yarn.log-config-file | Path | Internal Yarn log configuration file path |
| jobmanager.memory.heap.size | Bytes | Heap memory size for JobManager |
| state.checkpoints.dir | Path | State checkpoints directory |
| jobmanager.memory.jvm-overhead.max | Bytes | Maximum JVM overhead for JobManager |
#### TaskManager Metrics
| Metric Name | Metric Unit | Metric Help Description |
|---------------------------------------|-------------|---------------------------------------------------|
| Container ID | - | Container ID for uniquely identifying a container |
| Path | - | Container path |
| Data Port | Port | Data transmission port |
| JMX Port | Port | JMX (Java Management Extensions) port |
| Last Heartbeat | Timestamp | Last heartbeat time |
| All Slots | Count | Total number of task slots in the container |
| Free Slots | Count | Number of free task slots in the container |
| totalResourceCpuCores | Cores | Total number of CPU cores in the container |
| totalResourceTaskHeapMemory | MB | Total task heap memory size in the container |
| totalResourceManagedMemory | MB | Total managed memory size in the container |
| totalResourceNetworkMemory | MB | Total network memory size in the container |
| freeResourceCpuCores | Cores | Number of free CPU cores in the container |
| freeResourceTaskHeapMemory | MB | Free task heap memory size in the container |
| freeResourceTaskOffHeapMemory | MB | Free task off-heap memory size in the container |
| freeResourceManagedMemory | MB | Free managed memory size in the container |
| freeResourceNetworkMemory | MB | Free network memory size in the container |
| CPU Cores | Cores | Number of CPU cores |
| Physical MEM | MB | Size of physical memory |
| JVM Heap Size | MB | Size of JVM heap memory |
| Flink Managed MEM | MB | Size of Flink managed memory |
| Framework Heap | MB | Size of framework heap memory |
| Task Heap | MB | Size of task heap memory |
| Framework Off-Heap | MB | Size of framework off-heap memory |
| memoryConfigurationTaskOffHeap | Bytes | Task off-heap memory configuration |
| Network | MB | Network memory configuration |
| Managed Memory | MB | Managed memory configuration |
| JVM Metaspace | MB | Size of JVM metaspace |
| JVM Overhead | MB | JVM overhead |
| memoryConfigurationTotalFlinkMemory | Bytes | Total Flink memory configuration |
| memoryConfigurationTotalProcessMemory | Bytes | Total process memory configuration |
#### TaskManager Status Metrics
| Metric Name | Metric Unit | Metric Help Description |
|-----------------------------------|-------------|------------------------------------|
| Status.Shuffle.Netty.TotalMemory | MB | Total memory used by Netty Shuffle |
| Status.Flink.Memory.Managed.Used | MB | Managed memory used by Flink |
| Status.JVM.Memory.Metaspace.Used | MB | Used JVM metaspace memory |
| Status.JVM.Memory.Metaspace.Max | MB | Maximum JVM metaspace memory |
| Status.JVM.Memory.Heap.Used | MB | Used JVM heap memory |
| Status.JVM.Memory.Heap.Max | MB | Maximum JVM heap memory |
| Status.Flink.Memory.Managed.Total | MB | Total managed memory by Flink |
| Status.Shuffle.Netty.UsedMemory | MB | Used memory by Netty Shuffle |
home/versioned_docs/version-1.6.x/help/freebsd.md
+87
View File
@@ -0,0 +1,87 @@
---
id: freebsd
title: Monitoring FreeBSD Operating System
sidebar_label: FreeBSD Operating System
keywords: [ Open Source Monitoring System, Open Source Operating System Monitoring, FreeBSD Operating System Monitoring ]
---
> Collect and monitor general performance metrics (system information, CPU, memory, disk, network cards, file systems, top resource processes, etc.) of the FreeBSD operating system.
## Configuration Parameters
| Parameter Name | Parameter help description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | The IPv4, IPv6, or domain name of the monitored peer. Note ⚠️ without the protocol header (eg: https://, http://). |
| Task Name | Identifies the name of this monitor, ensuring uniqueness of the name. |
| Port | The port where SSH for Linux is exposed, default is 22. |
| Timeout | Set the connection timeout, in milliseconds, default is 6000 milliseconds. |
| Reuse Connection | Set whether SSH connections are reused, default is: false. If false, a connection is created for each information retrieval. |
| Username | SSH connection username, optional. |
| Password | SSH connection password, optional. |
| Collector | Configure which collector to use for scheduling collection for this monitor. |
| Monitoring Interval | Interval for periodically collecting data, in seconds. The minimum interval that can be set is 30 seconds. |
| Bind Labels | Used to categorize and manage monitored resources. |
| Description | Additional information for identifying and describing this monitor. Users can add remarks here. |
| PrivateKey | Private key required to connect to the server. |
### Collection Metrics
#### Metric Set: Basic Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|--------------------------|
| Host Name | None | Host name |
| System Version | None | Operating system version |
| Uptime | None | System uptime |
#### Metric Set: CPU Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|----------------------------------------------|
| info | None | CPU model |
| cores | Number | Number of CPU cores |
| interrupt | Number | Number of CPU interrupts |
| load | None | Average CPU load for the last 1/5/15 minutes |
| context_switch | Number | Current context switches |
| usage | % | CPU usage |
#### Metric Set: Memory Info
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| physmem | Mb | Physical memory |
| usermem | Mb | User program memory |
| realmem | Mb | Actual memory |
| availmem | Mb | Available memory |
#### Metric Set: Disk Free
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| filesystem | None | File system name |
| used | Mb | Used disk space |
| available | Mb | Available disk space |
| usage | % | Usage percentage |
| mounted | None | Mount point directory |
#### Metric Set: Top10 CPU Process
Statistics of the top 10 processes using CPU. Statistics include: Process ID, CPU usage, memory usage, executed command.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| cpu_usage | % | CPU usage |
| mem_usage | % | Memory usage |
| command | None | Executed command |
#### Metric Set: Top10 Memory Process
Statistics of the top 10 processes using memory. Statistics include: Process ID, memory usage, CPU usage, executed command.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| mem_usage | % | Memory usage |
| cpu_usage | % | CPU usage |
| command | None | Executed command |
home/versioned_docs/version-1.6.x/help/ftp.md
+34
View File
@@ -0,0 +1,34 @@
---
id: ftp
title: Monitoring FTP
sidebar_label: FTP Monitor
keywords: [ open source monitoring tool, open source ftp server monitoring tool, monitoring ftp metrics ]
---
> Collect and monitor the general performance Metrics of FTP server.
**Protocol Use：FTP**
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|--------------------------------------------------------------------------------------------------------------------------|
| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: ftp://). |
| Monitoring name | Identify the name of this monitoring, The name needs to be unique. |
| Port | Port provided by FTP server ,default is 21. |
| Direction | Directory on the FTP server. |
| Timeout | Timeout for connecting to FTP server. |
| Username | Username for connecting to the FTP server, optional. |
| Password | Password for connecting to the FTP server, optional. |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. |
| Bind Tags | Used to classify and manage monitoring resources. |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here. |
### Collection Metrics
#### Metrics Set：Basic
| Metric name | Metric unit | Metric help description |
|---------------|-------------|----------------------------------------------------------|
| Is Active | none | Check if the directory exists and has access permission. |
| Response Time | ms | Response Time |
home/versioned_docs/version-1.6.x/help/fullsite.md
+34
View File
@@ -0,0 +1,34 @@
---
id: fullsite
title: Monitoring Full site
sidebar_label: Full site Monitor
keywords: [open source monitoring tool, open source website monitoring tool, monitoring sitemap metrics]
---
> Available or not to monitor all pages of the website.
> A website often has multiple pages provided by different services. We monitor the full site by collecting the SiteMap exposed by the website.
> Note⚠️ This monitoring requires your website to support SiteMap. We support SiteMap in XML and TXT formats.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Ports provided by website, http generally defaults to 80 and https generally defaults to 443 |
| SiteMap | Relative path of website SiteMap address, eg：/sitemap.xml |
| Enable HTTPS | Whether to access the website through HTTPS. Note⚠️When HTTPS is enabled, the default corresponding port needs to be changed to 443 |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：summary
| Metric name | Metric unit | Metric help description |
|--------------|-------------|------------------------------------------------------|
| url | none | URL path of web page |
| statusCode | none | Response HTTP status code for requesting the website |
| responseTime | ms | Website response time |
| errorMsg | none | Error message feedback after requesting the website |
home/versioned_docs/version-1.6.x/help/grafana_dashboard.md
+55
View File
@@ -0,0 +1,55 @@
---
id: grafana_dashboard
title: Grafana Dashboard
sidebar_label: Grafana Historical Charts
keywords: [Grafana, Historical Dashboard]
---
> `Grafana` is an open source visualization and analytics platform that helps you easily create, share and monitor dashboards. In this article, we will cover how to use `Grafana` to display historical data in `HertzBeat`.
## Prerequisites
- The `Grafana` version 8.1.0 or later is installed and running.
- The `Grafana` service is started and the account password is configured.
- The `HertzBeat` service is started and the `VictoriaMetrics` time-series database is configured (note: the `VictoriaMetrics` data source is required).
:::caution Caution.
`Grafana` can only show historical data for `Prometheus` type of monitoring, currently it does not support monitoring data defined by `yml` in `HertzBeat`.
:::
### enable Grafana embedded url
ref: [https://grafana.com/blog/2023/10/10/how-to-embed-grafana-dashboards-into-web-applications/](https://grafana.com/blog/2023/10/10/how-to-embed-grafana-dashboards-into-web-applications/)
In the `Grafana` configuration file `grafana.ini`, set the `allow_embedding = true`.
In the `Grafana` configuration file `grafana.ini`, set the `[auth.anonymous]` option to `true`.
```ini
allow_embedding = true
[auth.anonymous]
# enable anonymous access
enabled = true
```
### Configuring Grafana in HertzBeat
In the configuration file `application.yml` in `HertzBeat`, configure the `Grafana` data source.
```yaml
grafana:
enabled: true
url: http://127.0.0.1:3000
username: admin
password: admin
```
### Upload Grafana monitor template json file in HertzBeat monitor
In `HertzBeat`, when creating or editing a `Prometheus` type monitor, click Enable Grafana Templates and select the Grafana template json file to upload.
The monitor template json file can be downloaded at [https://grafana.com/grafana/dashboards/](https://grafana.com/grafana/dashboards/).
For example, create a new monitor in `HertzBeat` for `VictoriaMetrics` single node, then open [https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/](https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/), click `Download JSON` button on the right side. `Download JSON` button on the right to download the template json file. Upload the template json file in the `HertzBeat` monitor, save it.
![grafana-1.png](/img/docs/help/grafana-1.png)
### View Grafana historical charts
On the `HertzBeat` monitoring page, click the `Grafana` button, select `Grafana` Historical Charts, select a monitoring template, and click the `Query` button to view the `Grafana` historical charts.
![grafana-2.png](/img/docs/help/grafana-2.png)
home/versioned_docs/version-1.6.x/help/greenplum.md
+55
View File
@@ -0,0 +1,55 @@
---
id: greenplum
title: Monitoring：GreenPlum database monitoring
sidebar_label: GreenPlum database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring greenplum database metrics]
---
> Collect and monitor the general performance Metrics of GreenPlum database. Support GreenPlum 6.23.0+.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored Host address. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by the database. The default is 5432 |
| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms |
| Database name | Database instance name, optional |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|-------------------------------------------|
| server_version | none | Version number of the database server |
| port | none | Database server exposure service port |
| server_encoding | none | Character set encoding of database server |
| data_directory | none | Database storage data disk address |
| max_connections | connections | Database maximum connections |
#### Metric set：state
| Metric name | Metric unit | Metric help description |
|----------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | none | Database name, or share-object is a shared object |
| conflicts | times | The number of queries canceled in the database due to a conflict with recovery |
| deadlocks | number | Number of deadlocks detected in the database |
| blks_read | times | The number of disk blocks read in the database |
| blks_hit | times | Times the disk block has been found to be in the buffer, so there is no need to read it once (This only includes hits in the GreenPlum buffer, not in the operating system file system buffer) |
| blk_read_time | ms | Time spent by the backend reading data file blocks in the database |
| blk_write_time | ms | Time spent by the backend writing data file blocks in the database |
| stats_reset | none | The last time these statistics were reset |
#### Metric set：activity
| Metric name | Metric unit | Metric help description |
|-------------|-------------|--------------------------------------|
| running | connections | Number of current client connections |
home/versioned_docs/version-1.6.x/help/guide.md
+137
View File
@@ -0,0 +1,137 @@
---
id: guide
title: Help Center
sidebar_label: Help Center
---
> HertzBeat - An open source, real-time monitoring tool with custom-monitor and agentless.
> Help documents and auxiliary information during use
## 🔬 Monitoring services
> Regularly collect and monitor the performance Metrics exposed by end-to-end services, provide visual interfaces, and process data for alarm and other service scheduling.
> Planned monitoring type：application service, database, operating system, cloud native, open source middleware.
### Application service monitoring
&emsp;&#x1F449;&emsp;[Website monitoring](website) <br />
&emsp;&#x1F449;&emsp;[HTTP API](api) <br />
&emsp;&#x1F449;&emsp;[PING Connectivity](ping) <br />
&emsp;&#x1F449;&emsp;[Port availability](port) <br />
&emsp;&#x1F449;&emsp;[Full site monitoring](fullsite) <br />
&emsp;&#x1F449;&emsp;[SSL Cert monitoring](ssl_cert) <br />
&emsp;&#x1F449;&emsp;[DNS monitoring](dns) <br />
&emsp;&#x1F449;&emsp;[FTP monitoring](ftp) <br />
&emsp;&#x1F449;&emsp;[Websocket monitoring](websocket) <br />
&emsp;&#x1F449;&emsp;[MQTT connection monitoring](mqtt) <br />
### Program monitoring
&emsp;&#x1F449;&emsp;[Process](process) <br />
&emsp;&#x1F449;&emsp;[JVM monitoring](jvm) <br />
&emsp;&#x1F449;&emsp;[SpringBoot2.0](springboot2) <br />
&emsp;&#x1F449;&emsp;[SpringBoot3.0](springboot3) <br />
&emsp;&#x1F449;&emsp;[DynamicTp](dynamic_tp) <br />
### Database monitoring
&emsp;&#x1F449;&emsp;[MYSQL database monitoring](mysql) <br />
&emsp;&#x1F449;&emsp;[MariaDB database monitoring](mariadb) <br />
&emsp;&#x1F449;&emsp;[PostgreSQL database monitoring](postgresql) <br />
&emsp;&#x1F449;&emsp;[SqlServer database monitoring](sqlserver) <br />
&emsp;&#x1F449;&emsp;[Oracle database monitoring](oracle) <br />
&emsp;&#x1F449;&emsp;[DM database monitoring](dm) <br />
&emsp;&#x1F449;&emsp;[OpenGauss database monitoring](opengauss) <br />
&emsp;&#x1F449;&emsp;[IoTDB database monitoring](iotdb) <br />
&emsp;&#x1F449;&emsp;[TiDB database monitoring](tidb) <br />
&emsp;&#x1F449;&emsp;[MongoDB database monitoring](mongodb) <br />
&emsp;&#x1F449;&emsp;[NebulaGraph cluster monitoring](nebulagraph_cluster) <br />
### Cache monitoring
&emsp;&#x1F449;&emsp;[Redis monitoring](redis) <br />
&emsp;&#x1F449;&emsp;[Memcached monitoring](memcached) <br />
### Operating system monitoring
&emsp;&#x1F449;&emsp;[Linux operating system monitoring](linux) <br />
&emsp;&#x1F449;&emsp;[Windows operating system monitoring](windows) <br />
&emsp;&#x1F449;&emsp;[Ubuntu operating system monitoring](ubuntu) <br />
&emsp;&#x1F449;&emsp;[Centos operating system monitoring](centos) <br />
&emsp;&#x1F449;&emsp;[FreeBSD operating system monitoring](freebsd) <br />
&emsp;&#x1F449;&emsp;[RedHat operating system monitoring](redhat) <br />
&emsp;&#x1F449;&emsp;[Rocky Linux operating system monitoring](rockylinux) <br />
&emsp;&#x1F449;&emsp;[EulerOS monitoring](euleros) <br />
### Middleware monitoring
&emsp;&#x1F449;&emsp;[Zookeeper](zookeeper) <br />
&emsp;&#x1F449;&emsp;[Kafka](kafka) <br />
&emsp;&#x1F449;&emsp;[Tomcat](tomcat) <br />
&emsp;&#x1F449;&emsp;[ShenYu](shenyu) <br />
&emsp;&#x1F449;&emsp;[DynamicTp](dynamic_tp) <br />
&emsp;&#x1F449;&emsp;[RabbitMQ](rabbitmq) <br />
&emsp;&#x1F449;&emsp;[ActiveMQ](activemq) <br />
&emsp;&#x1F449;&emsp;[Jetty](jetty) <br />
&emsp;&#x1F449;&emsp;[Nacos](nacos) <br />
### CloudNative monitoring
&emsp;&#x1F449;&emsp;[Docker](docker) <br />
&emsp;&#x1F449;&emsp;[Kubernetes](kubernetes) <br />
### Bigdata monitoring
&emsp;&#x1F449;&emsp;[Clickhouse](clickhouse) <br />
&emsp;&#x1F449;&emsp;[ElasticSearch](elasticsearch) <br />
&emsp;&#x1F449;&emsp;[Flink](flink) <br />
### Ai LLM monitoring
&emsp;&#x1F449;&emsp;[openai](openai) <br />
### Network monitoring
&emsp;&#x1F449;&emsp;[Huawei-switch](huawei_switch) <br />
### Server monitoring
***
## 💡 Alarm service
> More liberal threshold alarm configuration (calculation expression), supports email, SMS, WebHook, DingDing, WeChat and FeiShu for alarm notification.
> The positioning of alarm service is to trigger the threshold accurately and timely, and the alarm notification can be reached in time.
### Alarm center
> The triggered alarm information center provides query and filtering of alarm deletion, alarm processing, mark unprocessed, alarm level status, etc.
More details see&emsp;&#x1F449;&emsp;[Alarm center](alarm_center)
### Alarm configuration
> The Metric threshold configuration provides the Metric threshold configuration in the form of expression, which can set the alarm level, trigger times, alarm notification template and whether it is enabled, correlation monitoring and other functions.
More details see&emsp;&#x1F449;&emsp;[Threshold alarm](alert_threshold) <br />
&emsp;&emsp;&emsp;&#x1F449;&emsp;[Threshold expression](alert_threshold_expr)
### Alarm notification
> After triggering the alarm information, in addition to being displayed in the alarm center list, it can also be notified to the designated recipient in a specified way (e-mail, wechat and FeiShu etc.)
> Alarm notification provides different types of notification methods, such as email recipient, enterprise wechat robot notification, DingDing robot notification, and FeiShu robot notification.
> After setting the receiver, you need to set the associated alarm notification strategy to configure which alarm information is sent to which receiver.
&emsp;&#x1F449;&emsp;[Configure Email Notification](alert_email) <br />
&emsp;&#x1F449;&emsp;[Configure Discord Notification](alert_webhook) <br />
&emsp;&#x1F449;&emsp;[Configure Slack Notification](alert_webhook) <br />
&emsp;&#x1F449;&emsp;[Configure Telegram Notification](alert_webhook) <br />
&emsp;&#x1F449;&emsp;[Configure WebHook Notification](alert_webhook) <br />
&emsp;&#x1F449;&emsp;[Configure enterprise WeChat Robot Notification](alert_wework) <br />
&emsp;&#x1F449;&emsp;[Configure DingDing Robot Notification](alert_dingtalk) <br />
&emsp;&#x1F449;&emsp;[Configure FeiShu Robot Notification](alert_feishu) <br />
&emsp;&#x1F449;&emsp;[Configure Huawei Cloud SMN Notification](alert_smn) <br />
### Plugins
&emsp;&#x1F449;&emsp;[Plugin](plugin) <br />
home/versioned_docs/version-1.6.x/help/hadoop.md
+89
View File
@@ -0,0 +1,89 @@
---
id: hadoop
title: Monitoring Hadoop
sidebar_label: Apache Hadoop
keywords: [Open Source Monitoring System, Open Source Java Monitoring, Hadoop JVM Monitoring]
---
> Collect and monitor general performance metrics for the JVM virtual machine in Hadoop.
**Protocol used: JMX**
## Pre-monitoring steps
>
> You need to enable JMX service in the Hadoop application before monitoring. HertzBeat uses the JMX protocol to collect performance metrics from Hadoop's JVM.
### Steps to enable JMX protocol in the Hadoop application
Add JVM parameters when the application starts. ⚠️Note that you can customize the exposed port and external IP.
- 1.Enter the hadoop-env.sh configuration file and enter the following command in the terminal:
```shell
vi $HADOOP_HOME/etc/hadoop/hadoop-env.sh
```
- 2.Add the following parameters, where `port` is the number of the custom-exposed port
```shell
export HADOOP_OPTS= "$HADOOP_OPTS
-Djava.rmi.server.hostname=对外ip地址
-Dcom.sun.management.jmxremote.port=9999
-Dcom.sun.management.jmxremote.ssl=false
-Dcom.sun.management.jmxremote.authenticate=false "
```
- 3.Save and exit, and then execute "start-all.sh" in the "$HADOOP_HOME/sbin" directory to restart the service.
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by JMX |
| Username | JMX connection user name, optional |
| Password | JMX connection password, optional |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metrics
#### Metrics Set：memory_pool
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| name | | metrics name |
| committed | kb | total size |
| init | kb | init size |
| max | kb | max size |
| used | kb | used size |
#### Metrics Set：code_cache (Only Support JDK8)
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| committed | kb | total size |
| init | kb | init size |
| max | kb | max size |
| used | kb | used size |
#### Metrics Set：class_loading
| Metric name | Metric unit | Metric help description |
|-----------------------|-------------|--------------------------|
| LoadedClassCount | | Loaded Class Count |
| TotalLoadedClassCount | | Total Loaded Class Count |
| UnloadedClassCount | | Unloaded Class Count |
#### Metrics Set：thread
| Metric name | Metric unit | Metric help description |
|-------------------------|-------------|----------------------------|
| TotalStartedThreadCount | | Total Started Thread Count |
| ThreadCount | | Thread Count |
| PeakThreadCount | | Peak Thread Count |
| DaemonThreadCount | | Daemon Thread Count |
| CurrentThreadUserTime | ms | Current Thread User Time |
| CurrentThreadCpuTime | ms | Current Thread Cpu Time |
home/versioned_docs/version-1.6.x/help/hbase_master.md
+59
View File
@@ -0,0 +1,59 @@
---
id: hbase_master
title: Monitoring Hbase Master
sidebar_label: HbaseMaster Monitoring
keywords: [Open Source Monitoring System, Open Source Database Monitoring, HbaseMaster Monitoring]
---
> Collect monitoring data for general performance metrics of Hbase Master.
**Protocol: HTTP**
## Pre-monitoring steps
Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.port` configuration item, which is used for monitoring.
## Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note: without protocol header (e.g., https://, http://). |
| Port | The port number of the Hbase master, default is 16010. That is, the value of the`hbase.master.info.port` parameter. |
| Task Name | The name identifying this monitoring, which needs to be unique. |
| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. |
| Collection Interval | The periodic collection interval for monitoring data, in seconds, with the minimum allowable interval being 30 seconds. |
| Probe | Whether to probe and check the availability of monitoring before adding new monitoring, and proceed with the addition or modification operation only if the probe is successful. |
| Description | Additional notes and descriptions for this monitoring, users can add notes here. |
### Collected Metrics
#### Metric Set: server
| Metric Name | Unit | Metric Description |
|----------------------|------|-----------------------------------------|
| numRegionServers | none | Number of currently alive RegionServers |
| numDeadRegionServers | none | Number of currently dead RegionServers |
| averageLoad | none | Cluster average load |
| clusterRequests | none | Total number of cluster requests |
#### Metric Set: Rit
| Metric Name | Unit | Metric Description |
|----------------------|------|----------------------------------|
| ritnone | none | Current number of RIT |
| ritnoneOverThreshold | none | Number of RIT over the threshold |
| ritOldestAge | ms | Duration of the oldest RIT |
#### Metric Set: basic
| Metric Name | Unit | Metric Description |
|-------------------------|------|---------------------------------------------|
| liveRegionServers | none | List of currently active RegionServers |
| deadRegionServers | none | List of currently offline RegionServers |
| zookeeperQuorum | none | Zookeeper list |
| masterHostName | none | Master node |
| BalancerCluster_num_ops | none | Number of cluster load balancing operations |
| numActiveHandler | none | Number of RPC handlers |
| receivedBytes | MB | Cluster received data volume |
| sentBytes | MB | Cluster sent data volume (MB) |
| clusterRequests | none | Total number of cluster requests |
home/versioned_docs/version-1.6.x/help/hbase_regionserver.md
+93
View File
@@ -0,0 +1,93 @@
---
id: hbase_regionserver
title: Monitoring HBase RegionServer Monitoring
sidebar_label: HBase RegionServer Monitoring
keywords: [Open-source monitoring system, Open-source database monitoring, RegionServer monitoring]
---
> Collect and monitor common performance metrics for HBase RegionServer.
**Protocol:** HTTP
## Pre-Monitoring Operations
Review the `hbase-site.xml` file to obtain the value of the `hbase.regionserver.info.port` configuration item, which is used for monitoring.
## Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| Target Host | The IPV4, IPV6, or domain name of the monitored entity. Note ⚠️ Do not include the protocol header (e.g., https://, http://). |
| Port | The port number of the HBase regionserver, default is 16030, i.e., the value of the`hbase.regionserver.info.port` parameter |
| Task Name | A unique name to identify this monitoring task. |
| Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. |
| Collection Interval | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. |
| Probe Before Adding | Whether to probe and check the availability of monitoring before adding new monitoring, only proceed with the addition if the probe is successful. |
| Description Note | Additional notes to identify and describe this monitoring, users can add notes here. |
### Collection Metrics
> All metric names are directly referenced from the official fields, hence there may be non-standard naming.
#### Metric Set: server
| Metric Name | Unit | Metric Description |
|-----------------------------------|-------|---------------------------------------------------------------------------|
| regionCount | None | Number of Regions |
| readRequestCount | None | Number of read requests since cluster restart |
| writeRequestCount | None | Number of write requests since cluster restart |
| averageRegionSize | MB | Average size of a Region |
| totalRequestCount | None | Total number of requests |
| ScanTime_num_ops | None | Total number of Scan requests |
| Append_num_ops | None | Total number of Append requests |
| Increment_num_ops | None | Total number of Increment requests |
| Get_num_ops | None | Total number of Get requests |
| Delete_num_ops | None | Total number of Delete requests |
| Put_num_ops | None | Total number of Put requests |
| ScanTime_mean | None | Average time of a Scan request |
| ScanTime_min | None | Minimum time of a Scan request |
| ScanTime_max | None | Maximum time of a Scan request |
| ScanSize_mean | bytes | Average size of a Scan request |
| ScanSize_min | None | Minimum size of a Scan request |
| ScanSize_max | None | Maximum size of a Scan request |
| slowPutCount | None | Number of slow Put operations |
| slowGetCount | None | Number of slow Get operations |
| slowAppendCount | None | Number of slow Append operations |
| slowIncrementCount | None | Number of slow Increment operations |
| slowDeleteCount | None | Number of slow Delete operations |
| blockCacheSize | None | Size of memory used by block cache |
| blockCacheCount | None | Number of blocks in Block Cache |
| blockCacheExpressHitPercent | None | Block cache hit ratio |
| memStoreSize | None | Size of Memstore |
| FlushTime_num_ops | None | Number of RS writes to disk/Memstore flushes |
| flushQueueLength | None | Length of Region Flush queue |
| flushedCellsSize | None | Size flushed to disk |
| storeFileCount | None | Number of Storefiles |
| storeCount | None | Number of Stores |
| storeFileSize | None | Size of Storefiles |
| compactionQueueLength | None | Length of Compaction queue |
| percentFilesLocal | None | Percentage of HFile in local HDFS Data Node |
| percentFilesLocalSecondaryRegions | None | Percentage of HFile for secondary region replicas in local HDFS Data Node |
| hlogFileCount | None | Number of WAL files |
| hlogFileSize | None | Size of WAL files |
#### Metric Set: IPC
| Metric Name | Unit | Metric Description |
|---------------------------|------|----------------------------------------|
| numActiveHandler | None | Current number of RITs |
| NotServingRegionException | None | Number of RITs exceeding the threshold |
| RegionMovedException | ms | Duration of the oldest RIT |
| RegionTooBusyException | ms | Duration of the oldest RIT |
#### Metric Set: JVM
| Metric Name | Unit | Metric Description |
|----------------------|------|-----------------------------------|
| MemNonHeapUsedM | None | Current active RegionServer list |
| MemNonHeapCommittedM | None | Current offline RegionServer list |
| MemHeapUsedM | None | Zookeeper list |
| MemHeapCommittedM | None | Master node |
| MemHeapMaxM | None | Cluster balance load times |
| MemMaxM | None | RPC handle count |
| GcCount | MB | Cluster data reception volume |
home/versioned_docs/version-1.6.x/help/hdfs_datanode.md
+56
View File
@@ -0,0 +1,56 @@
---
id: hdfs_datanode
title: Monitoring Apache HDFS DataNode Monitoring
sidebar_label: Apache HDFS DataNode
keywords: [big data monitoring system, distributed file system monitoring, Apache HDFS DataNode monitoring]
---
> HertzBeat monitors metrics for Apache HDFS DataNode nodes.
**Protocol Used: HTTP**
## Pre-monitoring Operations
Retrieve the HTTP monitoring port for the Apache HDFS DataNode. Value: `dfs.datanode.http.address`
## Configuration Parameters
| Parameter Name | Parameter Description |
|-----------------------------|-------------------------------------------------------------------------------------------|
| Target Host | IP(v4 or v6) or domain name of the target to be monitored. Exclude protocol. |
| Port | Monitoring port number for Apache HDFS DataNode, default is 50075. |
| Query Timeout | Timeout for querying Apache HDFS DataNode, in milliseconds, default is 6000 milliseconds. |
| Metrics Collection Interval | Time interval for monitoring data collection, in seconds, minimum interval is 30 seconds. |
| Probe Before Monitoring | Whether to probe and check monitoring availability before adding. |
| Description/Remarks | Additional description and remarks for this monitoring. |
### Metrics Collected
#### Metric Set: FSDatasetState
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|----------------------------------|
| DfsUsed | GB | DataNode HDFS usage |
| Remaining | GB | Remaining space on DataNode HDFS |
| Capacity | GB | Total capacity of DataNode HDFS |
#### Metric Set: JvmMetrics
| Metric Name | Metric Unit | Metric Description |
|----------------------|-------------|---------------------------------------------------|
| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM |
| MemNonHeapCommittedM | MB | Committed size of NonHeapMemory configured in JVM |
| MemHeapUsedM | MB | Current usage of HeapMemory by JVM |
| MemHeapCommittedM | MB | Committed size of HeapMemory by JVM |
| MemHeapMaxM | MB | Maximum size of HeapMemory configured in JVM |
| MemMaxM | MB | Maximum memory available for JVM at runtime |
| ThreadsRunnable | Count | Number of threads in RUNNABLE state |
| ThreadsBlocked | Count | Number of threads in BLOCKED state |
| ThreadsWaiting | Count | Number of threads in WAITING state |
| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state |
#### Metric Set: runtime
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|--------------------|
| StartTime | | Startup time |
home/versioned_docs/version-1.6.x/help/hdfs_namenode.md
+92
View File
@@ -0,0 +1,92 @@
---
id: hdfs_namenode
title: Monitoring HDFS NameNode Monitoring
sidebar_label: Apache HDFS NameNode
keywords: [big data monitoring system, distributed file system monitoring, HDFS NameNode monitoring]
---
> HertzBeat monitors metrics for HDFS NameNode nodes.
**Protocol Used: HTTP**
## Pre-Monitoring Actions
Ensure that you have obtained the JMX monitoring port for the HDFS NameNode.
## Configuration Parameters
| Parameter Name | Parameter Description |
|-----------------------------|-------------------------------------------------------------------------------------------|
| Target Host | The IPv4, IPv6, or domain name of the target being monitored. Exclude protocol headers. |
| Port | The monitoring port number of the HDFS NameNode, default is 50070. |
| Query Timeout | Timeout for querying the HDFS NameNode, in milliseconds, default is 6000 milliseconds. |
| Metrics Collection Interval | Time interval for collecting monitoring data, in seconds, minimum interval is 30 seconds. |
| Probe Before Monitoring | Whether to probe and check the availability of monitoring before adding it. |
| Description/Remarks | Additional description and remarks for this monitoring. |
### Collected Metrics
#### Metric Set: FSNamesystem
| Metric Name | Metric Unit | Metric Description |
|---------------------------------|-------------|------------------------------------------------------------|
| CapacityTotal | | Total cluster storage capacity |
| CapacityTotalGB | GB | Total cluster storage capacity |
| CapacityUsed | | Used cluster storage capacity |
| CapacityUsedGB | GB | Used cluster storage capacity |
| CapacityRemaining | | Remaining cluster storage capacity |
| CapacityRemainingGB | GB | Remaining cluster storage capacity |
| CapacityUsedNonDFS | | Non-HDFS usage of cluster capacity |
| TotalLoad | | Total client connections in the cluster |
| FilesTotal | | Total number of files in the cluster |
| BlocksTotal | | Total number of BLOCKs |
| PendingReplicationBlocks | | Number of blocks awaiting replication |
| UnderReplicatedBlocks | | Number of blocks with insufficient replicas |
| CorruptBlocks | | Number of corrupt blocks |
| ScheduledReplicationBlocks | | Number of blocks scheduled for replication |
| PendingDeletionBlocks | | Number of blocks awaiting deletion |
| ExcessBlocks | | Number of excess blocks |
| PostponedMisreplicatedBlocks | | Number of misreplicated blocks postponed for processing |
| NumLiveDataNodes | | Number of live data nodes in the cluster |
| NumDeadDataNodes | | Number of data nodes marked as dead |
| NumDecomLiveDataNodes | | Number of decommissioned live nodes |
| NumDecomDeadDataNodes | | Number of decommissioned dead nodes |
| NumDecommissioningDataNodes | | Number of nodes currently being decommissioned |
| TransactionsSinceLastCheckpoint | | Number of transactions since the last checkpoint |
| LastCheckpointTime | | Time of the last checkpoint |
| PendingDataNodeMessageCount | | Number of DATANODE requests queued in the standby namenode |
#### Metric Set: RPC
| Metric Name | Metric Unit | Metric Description |
|--------------------|-------------|---------------------|
| ReceivedBytes | | Data receiving rate |
| SentBytes | | Data sending rate |
| RpcQueueTimeNumOps | | RPC call rate |
#### Metric Set: runtime
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|--------------------|
| StartTime | | Start time |
#### Metric Set: JvmMetrics
| Metric Name | Metric Unit | Metric Description |
|---------------------------------|--------------|------------------------------------------|
| MemNonHeapUsedM | MB | Current usage of NonHeapMemory by JVM |
| MemNonHeapCommittedM | MB | Committed NonHeapMemory by JVM |
| MemHeapUsedM | MB | Current usage of HeapMemory by JVM |
| MemHeapCommittedM | MB | Committed HeapMemory by JVM |
| MemHeapMaxM | MB | Maximum HeapMemory configured for JVM |
| MemMaxM | MB | Maximum memory that can be used by JVM |
| GcCountParNew | Count | Number of ParNew GC events |
| GcTimeMillisParNew | Milliseconds | Time spent in ParNew GC |
| GcCountConcurrentMarkSweep | Count | Number of ConcurrentMarkSweep GC events |
| GcTimeMillisConcurrentMarkSweep | Milliseconds | Time spent in ConcurrentMarkSweep GC |
| GcCount | Count | Total number of GC events |
| GcTimeMillis | Milliseconds | Total time spent in GC events |
| ThreadsRunnable | Count | Number of threads in RUNNABLE state |
| ThreadsBlocked | Count | Number of threads in BLOCKED state |
| ThreadsWaiting | Count | Number of threads in WAITING state |
| ThreadsTimedWaiting | Count | Number of threads in TIMED WAITING state |
home/versioned_docs/version-1.6.x/help/hive.md
+76
View File
@@ -0,0 +1,76 @@
---
id: hive
Title: Monitoring Apache Hive
sidebar_label: Apache Hive
keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache hive metrics]
---
> Collect and monitor the general performance metrics exposed by the Apache Hive.
## Pre-monitoring operations
If you want to monitor information in `Apache Hive` with this monitoring type, you need to open your `Hive Server2` in remoting mode.
**1、Enable metastore:**
```shell
hive --service metastore &
```
**2. Enable hive server2:**
```shell
hive --service hiveserver2 &
```
### Configure parameters
| Parameter name | Parameter Help describes the |
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). |
| Monitoring Name | A name that identifies this monitoring that needs to be unique. |
| Port | The default port provided by the database is 10002. |
| Enable HTTPS | Whether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443 |
| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds |
| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful |
| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here |
### Collect metrics
#### metric Collection: basic
| Metric Name | metric unit | Metrics help describe |
|-------------|-------------|-----------------------------------------------------------|
| vm_name | None | The name of the virtual machine (VM) running HiveServer2. |
| vm_vendor | None | The vendor or provider of the virtual machine. |
| vm_version | None | The version of the virtual machine. |
| up_time | None | The duration for which HiveServer2 has been running. |
#### metric Collection: environment
| Metric Name | metric unit | Metrics help describe |
|----------------------|-------------|-------------------------------------------------------------------|
| https_proxyPort | None | The port number used for HTTPS proxy communication. |
| os_name | None | The name of the operating system on which HiveServer2 is running. |
| os_version | None | The version of the operating system. |
| os_arch | None | The architecture of the operating system. |
| java_runtime_name | None | The name of the Java runtime environment used by HiveServer2. |
| java_runtime_version | None | The version of the Java runtime environment. |
#### metric Collection: thread
| Metric Name | metric unit | Metrics help describe |
|----------------------|-------------|----------------------------------------------------------------------|
| thread_count | None | The current number of threads being used by HiveServer2. |
| total_started_thread | None | The total count of threads started by HiveServer2 since its launch. |
| peak_thread_count | None | The highest number of threads used by HiveServer2 at any given time. |
| daemon_thread_count | None | The number of daemon threads currently active in HiveServer2. |
#### metric Collection: code_cache
| Metric Name | metric unit | Metrics help describe |
|-------------|-------------|-------------------------------------------------------------------------|
| committed | MB | The amount of memory currently allocated for the memory pool. |
| init | MB | The initial amount of memory requested for the memory pool. |
| max | MB | The maximum amount of memory that can be allocated for the memory pool. |
| used | MB | The amount of memory currently being used by the memory pool. |
home/versioned_docs/version-1.6.x/help/huawei_switch.md
+53
View File
@@ -0,0 +1,53 @@
---
id: huawei_switch
title: Monitoring：Huawei switch
sidebar_label: Huawei switch
keywords: [ open source monitoring tool, network monitoring, Huawei switch ]
---
> Collect and monitor the general indicators (availability, system information, port traffic, etc.) of Huawei switches.
**Protocol Use: SNMP**
## Configuration parameter
| Parameter name | Parameter help description |
|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Task Name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port of SNMP. The default is 161 |
| SNMP Version | SNMP version to use |
| SNMP Community | Used in SNMP v1 and SNMP v2c, used to complete authentication in SNMP Agent, in string form. Group name includes "read" and "write", when performing SNMP query operation, "read" group name is used for authentication; when performing SNMP setting operation, "write" group name is used for authentication. When performing SNMP query operation, "read" group name is used for authentication; when performing SNMP setting operation, "write" group name is used for authentication. |
| SNMP username | For SNMP v3, MSG username |
| SNMP contextName | For SNMP v3, used to determine the MIB view of the Context EngineID to the managed device |
| SNMP authPassword | For SNMP v3, SNMP authentication passwords |
| authPassword Encryption | For SNMP v3, SNMP authentication algorithm |
| SNMP privPassphrase | For SNMP v3, SNMP encrypted passwords |
| privPassword Encryption | For SNMP v3, SNMP encrypted algorithm |
| Timeout | Set the timeout time when querying unresponsive data, in milliseconds, the default is 6000 milliseconds |
| Intervals | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Description | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
Since there are too many metrics that can be queried on Huawei switches, detailed metrics can be queried
on [Huawei MIB Query Platform](https://info.support.huawei.com/info-finder/tool/en/enterprise/mib).
This document only introduces the monitoring indicators queried in the monitor template.
#### Metric set: huawei_core
| Metric Name | Metric Unit | Metric Help Description |
|---------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ifIndex | none | Interface index. This value is greater than zero and globally unique. |
| ifDescr | none | A textual string containing information about the interface. This string should include the name of the manufacturer, the product name and the version of the interface hardware/software. |
| ifMtu | octets | The size of the largest packet which can be sent/received on the interface. For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface. |
| ifSpeed | bit/s | An estimate of the interface's current bandwidth. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. If the bandwidth of the interface is greater than the maximum value reportable by this object then this object should report its maximum value (4,294,967,295) and ifHighSpeed must be used to report the interace's speed. For a sub-layer which has no concept of bandwidth, this object should be zero. |
| ifInOctets | octets | The total number of octets received on the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
| ifInDiscards | none | The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
| ifInErrors | none | For packet-oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
| ifOutOctets | octets | The total number of octets transmitted out of the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
| ifOutDiscards | none | The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
| ifOutErrors | none | For packet-oriented interfaces, the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, the number of outbound transmission units that could not be transmitted because of errors. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. |
| ifAdminStatus | none | The desired state of the interface. The testing(3) state indicates that no operational packets can be passed. When a managed system initializes, all interfaces start with ifAdminStatus in the down(2) state. As a result of either explicit management action or per configuration information retained by the managed system, ifAdminStatus is then changed to either the up(1) or testing(3) states (or remains in the down(2) state). |
| ifOperStatus | none | The current operational state of the interface. The testing(3) state indicates that no operational packets can be passed. If ifAdminStatus is down(2) then ifOperStatus should be down(2). If ifAdminStatus is changed to up(1) then ifOperStatus should change to up(1) if the interface is ready to transmit and receive network traffic; it should change to dormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection); it should remain in the down(2) state if and only if there is a fault that prevents it from going to the up(1) state; it should remain in the notPresent(6) state if the interface has missing (typically, hardware) components. |
home/versioned_docs/version-1.6.x/help/hugegraph.md
+140
View File
@@ -0,0 +1,140 @@
---
id: hugegraph
title: Monitoring HugeGraph Monitoring
sidebar_label: Apache HugeGraph
keywords: [Open Source Monitoring System, Open Source Database Monitoring, HugeGraph Monitoring]
---
> Collect and monitor the general performance metrics of HugeGraph
**Protocol used: HTTP**
## Pre-monitoring Operations
Check the `rest-server.properties` file to obtain the value of the `restserver_port` configuration item, which is used for monitoring.
## Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|----------------------------------------------------------------------------------------------------------------------------|
| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️ Do not include protocol headers (eg: https://, http://). |
| Port | Port number of the HugeGraph restserver, default is 8080. i.e., the value of the `restserver_port` parameter |
| Enable SSL | Enable SSL usage |
| Base Path | Base path, default is: /metrics, usually does not need to be modified |
| Task Name | Identifies the name of this monitoring, ensuring uniqueness. |
| Collection Interval | Interval for periodically collecting data for monitoring, in seconds, with a minimum interval of 30 seconds |
| Probe Enabled | Whether to probe before adding new monitoring, only continue with add/modify operations if the probe is successful |
| Description | Additional identification and description of this monitoring, users can add information here |
### Metrics Collection
#### Metric Set: gauges
| Metric Name | Metric Unit | Metric Description |
|--------------------------------|-------------|----------------------------------------------------------------|
| edge-hugegraph-capacity | NONE | Indicates the capacity limit of edges in the current graph |
| edge-hugegraph-expire | NONE | Indicates the expiration time of edge data |
| edge-hugegraph-hits | NONE | Indicates the number of hits in the edge data cache |
| edge-hugegraph-miss | NONE | Indicates the number of misses in the edge data cache |
| edge-hugegraph-size | NONE | Indicates the number of edges in the current graph |
| instances | NONE | Indicates the number of currently running HugeGraph instances |
| schema-id-hugegraph-capacity | NONE | Indicates the capacity limit of schema IDs in the graph |
| schema-id-hugegraph-expire | NONE | Indicates the expiration time of schema ID data |
| schema-id-hugegraph-hits | NONE | Indicates the number of hits in the schema ID data cache |
| schema-id-hugegraph-miss | NONE | Indicates the number of misses in the schema ID data cache |
| schema-id-hugegraph-size | NONE | Indicates the number of schema IDs in the current graph |
| schema-name-hugegraph-capacity | NONE | Indicates the capacity limit of schema names in the graph |
| schema-name-hugegraph-expire | NONE | Indicates the expiration time of schema name data |
| schema-name-hugegraph-hits | NONE | Indicates the number of hits in the schema name data cache |
| schema-name-hugegraph-miss | NONE | Indicates the number of misses in the schema name data cache |
| schema-name-hugegraph-size | NONE | Indicates the number of schema names in the current graph |
| token-hugegraph-capacity | NONE | Indicates the capacity limit of tokens in the graph |
| token-hugegraph-expire | NONE | Indicates the expiration time of token data |
| token-hugegraph-hits | NONE | Indicates the number of hits in the token data cache |
| token-hugegraph-miss | NONE | Indicates the number of misses in the token data cache |
| token-hugegraph-size | NONE | Indicates the number of tokens in the current graph |
| users-hugegraph-capacity | NONE | Indicates the capacity limit of users in the graph |
| users-hugegraph-expire | NONE | Indicates the expiration time of user data |
| users-hugegraph-hits | NONE | Indicates the number of hits in the user data cache |
| users-hugegraph-miss | NONE | Indicates the number of misses in the user data cache |
| users-hugegraph-size | NONE | Indicates the number of users in the current graph |
| users_pwd-hugegraph-capacity | NONE | Indicates the capacity limit of user passwords |
| users_pwd-hugegraph-expire | NONE | Indicates the expiration time of user password data |
| users_pwd-hugegraph-hits | NONE | Indicates the number of hits in the user password data cache |
| users_pwd-hugegraph-miss | NONE | Indicates the number of misses in the user password data cache |
| users_pwd-hugegraph-size | NONE | Indicates the number of user passwords in the current graph |
| vertex-hugegraph-capacity | NONE | Indicates the capacity limit of vertices in the graph |
| vertex-hugegraph-expire | NONE | Indicates the expiration time of vertex data |
| vertex-hugegraph-hits | NONE | Indicates the number of hits in the vertex data cache |
| vertex-hugegraph-miss | NONE | Indicates the number of misses in the vertex data cache |
| vertex-hugegraph-size | NONE | Indicates the number of vertices in the current graph |
| batch-write-threads | NONE | Indicates the number of threads for batch write operations |
| max-write-threads | NONE | Indicates the maximum number of threads for write operations |
| pending-tasks | NONE | Indicates the number of pending tasks |
| workers | NONE | Indicates the current number of worker threads |
| average-load-penalty | NONE | Indicates the average load penalty |
| estimated-size | NONE | Indicates the estimated data size |
| eviction-count | NONE | Indicates the number of evicted data entries |
| eviction-weight | NONE | Indicates the weight of evicted data |
| hit-count | NONE | Indicates the total cache hits |
| hit-rate | NONE | Indicates the cache hit rate |
| load-count | NONE | Indicates the number of data loads |
| load-failure-count | NONE | Indicates the number of data load failures |
| load-failure-rate | NONE | Indicates the data load failure rate |
| load-success-count | NONE | Indicates the number of successful data loads |
| long-run-compilation-count | NONE | Indicates the number of long-running compilations |
| miss-count | NONE | Indicates the total cache misses |
| miss-rate | NONE | Indicates the cache miss rate |
| request-count | NONE | Indicates the total request count |
| total-load-time | NONE | Indicates the total data load time |
| sessions | NONE | Indicates the current number of active sessions |
#### Metric Set: counters
| Metric Name | Metric Unit | Metric Description |
|-----------------------------------------------------|-------------|--------------------------------------------------------------------------------|
| GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests |
| GET-TOTAL_COUNTER | NONE | Records the total number of GET requests |
| favicon-ico-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve favicon.ico |
| favicon-ico-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve favicon.ico |
| graphs-HEAD-FAILED_COUNTER | NONE | Records the number of failed HEAD requests for graphs resources |
| graphs-HEAD-SUCCESS_COUNTER | NONE | Records the number of successful HEAD requests for graphs resources |
| graphs-HEAD-TOTAL_COUNTER | NONE | Records the total number of HEAD requests for graphs resources |
| graphs-hugegraph-graph-vertices-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests for vertices in HugeGraph graphs |
| graphs-hugegraph-graph-vertices-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests for vertices in HugeGraph graphs |
| metrics-GET-FAILED_COUNTER | NONE | Records the number of failed GET requests to retrieve metrics |
| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics |
| metrics-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics |
| metrics-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics |
| metrics-gauges-GET-SUCCESS_COUNTER | NONE | Records the number of successful GET requests to retrieve metrics gauges |
| metrics-gauges-GET-TOTAL_COUNTER | NONE | Records the total number of GET requests to retrieve metrics gauges |
#### Metric Set: system
| Metric Name | Metric Unit | Metric Description |
|---------------------------------------------|-------------|---------------------------------------------------------------------------------------------------------|
| mem | NONE | Indicates the total memory of the system |
| mem_total | NONE | Indicates the total memory of the system (same as mem) |
| mem_used | NONE | Indicates the currently used memory of the system |
| mem_free | NONE | Indicates the free memory of the system |
| mem_unit | NONE | Indicates the unit of memory (such as bytes, kilobytes, megabytes, etc.) |
| processors | NONE | Indicates the number of processors in the system |
| uptime | NONE | Indicates the system uptime, i.e., the time since booting |
| systemload_average | NONE | Indicates the average system load, reflecting the system's busyness |
| heap_committed | NONE | Indicates the committed size of JVM heap memory, i.e., the guaranteed heap memory size available to JVM |
| heap_init | NONE | Indicates the initial size of JVM heap memory |
| heap_used | NONE | Indicates the currently used JVM heap memory size |
| heap_max | NONE | Indicates the maximum available size of JVM heap memory |
| nonheap_committed | NONE | Indicates the committed size of JVM non-heap memory |
| nonheap_init | NONE | Indicates the initial size of JVM non-heap memory |
| nonheap_used | NONE | Indicates the currently used JVM non-heap memory size |
| nonheap_max | NONE | Indicates the maximum available size of JVM non-heap memory |
| thread_peak | NONE | Indicates the peak number of threads since JVM startup |
| thread_daemon | NONE | Indicates the current number of active daemon threads |
| thread_total_started | NONE | Indicates the total number of threads started since JVM startup |
| thread_count | NONE | Indicates the current number of active threads |
| garbage_collector_g1_young_generation_count | NONE | Indicates the number of young generation garbage collections by G1 garbage collector |
| garbage_collector_g1_young_generation_time | NONE | Indicates the total time spent in young generation garbage collections by G1 garbage collector |
| garbage_collector_g1_old_generation_count | NONE | Indicates the number of old generation garbage collections by G1 garbage collector |
| garbage_collector_g1_old_generation_time | NONE | Indicates the total time spent in old generation garbage collections by G1 garbage collector |
| garbage_collector_time_unit | NONE | Indicates the unit of garbage collection time (such as milliseconds, seconds, etc.) |
home/versioned_docs/version-1.6.x/help/iceberg.md
+76
View File
@@ -0,0 +1,76 @@
---
id: iceberg
Title: Monitoring Apache Iceberg
sidebar_label: Apache Iceberg
keywords: [open source monitoring tool, open source apache hive monitoring tool, monitoring apache iceberg metrics]
---
> Collect and monitor the general performance metrics exposed by the Apache Iceberg.
## Pre-monitoring operations
If you want to monitor information in `Apache Iceberg` with this monitoring type, you need to open your `Hive Server2` in remoting mode.
**1、Enable metastore:**
```shell
hive --service metastore &
```
**2. Enable hive server2:**
```shell
hive --service hiveserver2 &
```
### Configure parameters
| Parameter name | Parameter Help describes the |
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). |
| Monitoring Name | A name that identifies this monitoring that needs to be unique. |
| Port | The default port provided by the database is 10002. |
| Enable HTTPS | Whether to access the website through HTTPS, please note that ⚠️ when HTTPS is enabled, the default port needs to be changed to 443 |
| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds |
| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful |
| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here |
### Collect metrics
#### metric Collection: basic
| Metric Name | metric unit | Metrics help describe |
|-------------|-------------|-----------------------------------------------------------|
| vm_name | None | The name of the virtual machine (VM) running HiveServer2. |
| vm_vendor | None | The vendor or provider of the virtual machine. |
| vm_version | None | The version of the virtual machine. |
| up_time | None | The duration for which HiveServer2 has been running. |
#### metric Collection: environment
| Metric Name | metric unit | Metrics help describe |
|----------------------|-------------|-------------------------------------------------------------------|
| https_proxyPort | None | The port number used for HTTPS proxy communication. |
| os_name | None | The name of the operating system on which HiveServer2 is running. |
| os_version | None | The version of the operating system. |
| os_arch | None | The architecture of the operating system. |
| java_runtime_name | None | The name of the Java runtime environment used by HiveServer2. |
| java_runtime_version | None | The version of the Java runtime environment. |
#### metric Collection: thread
| Metric Name | metric unit | Metrics help describe |
|----------------------|-------------|----------------------------------------------------------------------|
| thread_count | None | The current number of threads being used by HiveServer2. |
| total_started_thread | None | The total count of threads started by HiveServer2 since its launch. |
| peak_thread_count | None | The highest number of threads used by HiveServer2 at any given time. |
| daemon_thread_count | None | The number of daemon threads currently active in HiveServer2. |
#### metric Collection: code_cache
| Metric Name | metric unit | Metrics help describe |
|-------------|-------------|-------------------------------------------------------------------------|
| committed | MB | The amount of memory currently allocated for the memory pool. |
| init | MB | The initial amount of memory requested for the memory pool. |
| max | MB | The maximum amount of memory that can be allocated for the memory pool. |
| used | MB | The amount of memory currently being used by the memory pool. |
home/versioned_docs/version-1.6.x/help/imap.md
+47
View File
@@ -0,0 +1,47 @@
---
id: imap
title: Monitoring detailed mailbox info
sidebar_label: mailbox Monitor
keywords: [Open Source Monitoring System, Open Source Network Monitoring, mailbox Monitor]
---
> IMAP, or Internet Message Access Protocol, allows you to retrieve detailed information from your email server.
> You can click on `Create New QQ Email Monitoring` or `Create New Netease Email Monitoring` to configure, or select `More Actions` to import existing configurations.
## Enable IMAP Service
If you want to use this monitoring type to monitor your email information, please first enable the IMAP service in your email:
For example, in QQ Mail (other emails are similar):
1. Go to `Mail Settings`
2. Find and enable the `IMAP/SMTP option` in `General`
3. Obtain the IMAP server domain, port number, whether to use SSL, and authorization code from the help section
4. Use the above information to configure in HertzBeat and collect monitoring metrics
### Configuration Parameters
| Parameter Name | Parameter Help Description |
|:--------------------|------------------------------------------------------------------------------------------------------------|
| Monitoring Host | IMAP mail server domain. Note ⚠️ do not include protocol headers (e.g., https://, http://). |
| Task Name | The name that identifies this monitoring task, which needs to be unique. |
| Enable SSL | Whether to enable SSL. |
| Port | The port provided by the website. |
| Connection Timeout | The wait timeout for the port connection, in milliseconds, default is 6000 ms. |
| IMAP Email Address | The email address to be monitored. |
| Authorization Code | The authorization code provided by the email server. |
| Monitoring Interval | The interval time for periodic data collection, in seconds, the minimum interval can be set to 30 seconds. |
| Binding Tags | Classification management tags for monitoring resources. |
| Description Notes | Additional identification and description notes for this monitoring task, users can leave notes here. |
### Collection Metrics
Collect information on each folder in the email (custom folders can be configured), as the metrics collected for each folder are the same, only a common set of metrics is listed below
#### Metrics Collection: (Folder Name in Email)
| Metric Name | Metric Unit | Metric Help Description |
|----------------------|-------------|-------------------------------------------------------|
| Total message count | None | The total number of emails in this folder |
| Recent message count | None | The number of recently received emails in this folder |
| Unseen message count | None | The number of unread emails in this folder |
home/versioned_docs/version-1.6.x/help/influxdb.md
+65
View File
@@ -0,0 +1,65 @@
---
id: influxdb
title: Monitoring InfluxDB Database
sidebar_label: InfluxDB Database
keywords: [open source monitoring system, open source database monitoring, InfluxDB database monitoring]
---
## Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| Monitor Host | The IPv4, IPv6, or domain name of the target being monitored. Note⚠️: Do not include the protocol header (e.g., https://, http://). |
| Task Name | A unique identifier for this monitoring task. |
| Port | The port on which the database is exposed. Default is 8086. |
| URL | The database connection URL, usually constructed from the host. No need to add it separately. |
| Collection Interval | The interval at which data is collected during monitoring, in seconds. The minimum interval that can be set is 30 seconds. |
| Probe Enabled | Whether to perform a probe check for monitoring availability before adding or modifying the monitoring task. |
| Description | Additional notes and remarks about this monitoring task. Users can provide information and descriptions here. |
### Collected Metrics
#### Metric Set: influxdb_info
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|--------------------|
| build_date | N/A | Creation date |
| os | N/A | Operating system |
| cpus | N/A | CPUs |
| version | N/A | Version number |
#### Metric Set: http_api_request_duration_seconds
| Metric Name | Metric Unit | Metric Description |
|---------------|-------------|--------------------|
| handler | N/A | Handler |
| path | N/A | Path |
| response_code | N/A | Response code |
| method | N/A | Request method |
| user_agent | N/A | User agent |
| status | N/A | Status |
#### Metric Set: storage_compactions_queued
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|--------------------|
| bucket | N/A | Storage bucket |
| engine | N/A | Engine type |
| id | N/A | Identifier |
| level | N/A | Level |
| path | N/A | Data file path |
#### Metric Set: http_write_request_bytes
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|-------------------------|
| endpoint | N/A | Endpoint |
| org_id | N/A | Organization identifier |
| status | N/A | Status |
#### Metric Set: qc_requests_total
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|-------------------------|
| result | N/A | Result |
| org | N/A | Organization identifier |
home/versioned_docs/version-1.6.x/help/influxdb_promql.md
+61
View File
@@ -0,0 +1,61 @@
---
id: influxdb_promql
title: Monitoring InfluxDB-PromQL
sidebar_label: InfluxDB-PromQL
keywords: [ Open Source Monitoring System, InfluxDB Monitoring, InfluxDB-PromQL Monitoring ]
---
> Monitor InfluxDB by querying generic metrics data from Prometheus server using Prometheus PromQL. This approach is suitable when Prometheus is already monitoring InfluxDB and you need to fetch InfluxDB's monitoring data from Prometheus server.
## Configuration Parameters
| Parameter Name | Parameter help description |
|---------------------|----------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | IP, IPv6, or domain name of the target being monitored. Note ⚠️: Do not include protocol header (e.g., https://, http://). |
| Monitoring name | Name to identify this monitoring, ensuring uniqueness of names. |
| Port | Prometheus API port, default: 9090. |
| Relative path | Relative path of Prometheus to query PromQL, default: /api/v1/query |
| Request mode | Set the request method for API calls: GET, POST, PUT, DELETE, default: GET |
| Enable HTTPS | Whether to access the website via HTTPS, note ⚠️: enabling HTTPS generally requires changing the corresponding port to 443 |
| Username | Username for Basic or Digest authentication when accessing the API. |
| Password | Password for Basic or Digest authentication when accessing the API. |
| Content-Type | Resource type when carrying BODY request data. |
| Request BODY | Set the BODY request data, effective for PUT and POST request methods. |
| Collection interval | Interval for periodic data collection in seconds, the minimum interval that can be set is 30 seconds |
| Description remarks | Additional remarks and descriptions for this monitoring. Users can add notes here. |
### Metrics Collection
#### Metric Set: basic_influxdb_memstats_alloc
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------------------|
| instance | None | Instance to which the metric belongs |
| timestamp | None | Timestamp of metric collection |
| value | None | Metric value |
#### Metric Set: influxdb_database_numMeasurements
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------------------|
| job | None | Metric name |
| instance | None | Instance to which the metric belongs |
| database | None | Name of the database |
| timestamp | None | Timestamp of metric collection |
| value | None | Metric value |
#### Metric Set: influxdb_query_rate_seconds
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------------------|
| instance | None | Instance to which the metric belongs |
| timestamp | None | Timestamp of metric collection |
| value | None | Metric value |
#### Metric Set: influxdb_queryExecutor_queriesFinished_10s
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------------------|
| instance | None | Instance to which the metric belongs |
| timestamp | None | Timestamp of metric collection |
| value | None | Metric value |
home/versioned_docs/version-1.6.x/help/iotdb.md
+120
View File
@@ -0,0 +1,120 @@
---
id: iotdb
title: Monitoring Apache IoTDB Database
sidebar_label: IoTDB Database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring IotDB database metrics]
---
> Monitor the running status of the Apache IoTDB Internet of Things time series database (JVM-related), memory task clusters and other related Metrics.
## Operation before monitoring
You need to enable the `metrics` function in IoTDB, which will provide interface data in the form of prometheus metrics.
To enable the `metrics` function, refer to [Official Documentation](https://iotdb.apache.org/UserGuide/V0.13.x/Maintenance-Tools/Metric-Tool.html)
The main steps are as follows:
1. The metric collection is disabled by default, you need to modify the parameters in `conf/iotdb-metric.yml` first, then restart the server
```yaml
# Whether to start the monitoring module, the default is false
enableMetric: true
# Whether to enable operation delay statistics
enablePerformanceStat: false
# Data provision method, externally provide metrics data through jmx and prometheus protocol, optional parameters: [JMX, PROMETHEUS, IOTDB], IOTDB is closed by default.
metricReporterList:
- JMX
- PROMETHEUS
# The metric architecture used at the bottom layer, optional parameters: [MICROMETER, DROPWIZARD]
monitorType: MICROMETER
# Initialize the level of the metric, optional parameters: [CORE, IMPORTANT, NORMAL, ALL]
metricLevel: IMPORTANT
# Predefined metrics set, optional parameters: [JVM, LOGBACK, FILE, PROCESS, SYSTEM]
predefinedMetrics:
- JVM
- FILE
```
2. Restart IoTDB, open a browser or use curl to access http://servier_ip:9091/metrics, and you can see the metric data.
3. Add the corresponding IoTDB monitoring in HertzBeat.
### Configuration parameters
| Parameter name | Parameter help description |
|--------|----------------------------------------- --------------|
| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). |
| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. |
| Port | The port provided by the IoTDB Metric interface, which is 9091 by default. |
| Timeout | HTTP request query timeout |
| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful |
| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here |
### Collect metrics
#### Metric collection: cluster_node_status
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|---------------------------------|
| name | None | Node name IP |
| status | None | Node status, 1=online 2=offline |
#### Metric collection: jvm_memory_committed_bytes
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|------------------------------------------------|
| area | none | heap memory or nonheap memory |
| id | none | memory block |
| value | MB | The memory size currently requested by the JVM |
#### Metric collection: jvm_memory_used_bytes
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|-------------------------------|
| area | none | heap memory or nonheap memory |
| id | none | memory block |
| value | MB | JVM used memory size |
#### Metric collection: jvm_threads_states_threads
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|---------------------------------------------------------|
| state | none | thread state |
| count | None | The number of threads corresponding to the thread state |
#### Index collection: quantity business data
| Metric Name | Metric Unit | Metric Help Description |
|--|------|----------------|
| name | None | Business name timeSeries/storageGroup/device/deviceUsingTemplate |
| type | none | type total/normal/template/template |
| value | None | The current timeSeries/storageGroup/device/The number of devices that have activated the template |
#### Metric collection: cache_hit cache
| Metric Name | Metric Unit | Metric Help Description |
| ----------- |------|------------------------------ ----------------------|
| name | None | Cache name chunk/timeSeriesMeta/bloomFilter |
| value | % | chunk/timeSeriesMeta cache hit rate, bloomFilter interception rate |
#### Metric collection: queue task queue
| Metric Name | Metric Unit | Metric Help Description |
| ----------- |------|------------------------------ ---------------------|
| name | None | Queue name compaction_inner/compaction_cross/flush |
| status | none | status running/waiting |
| value | None | Number of tasks at current time |
#### Metric collection: thrift_connections
| Metric Name | Metric Unit | Metric Help Description |
|-------------|-------------|----------------------------------|
| name | None | name |
| connection | none | thrift current connection number |
home/versioned_docs/version-1.6.x/help/ipmi.md
+53
View File
@@ -0,0 +1,53 @@
---
id: ipmi
title: IPMI2 Monitoring
sidebar_label: Server Monitor
keywords: [open source monitoring tool, open source server Monitoring, IPMI Monitoring]
---
> Collect and monitor the general performance Metrics of Server using IPMI2.
**Protocol: IPMI**
## Pre-monitoring steps
1. The target server supports the **IPMI2 protocol**.
2. The **BMC** (Baseboard Management Controller) has been configured with a network interface, allowing access to the **IPMI port**.
3. **User accounts** have been configured, and appropriate **permissions** have been assigned to the accounts.
These are basic checks you can follow, and for further details on enabling and configuring IPMI over LAN, you can consult the specific user manual of the server manufacturer.
## Configuration Parameters
| Parameter Name | Parameter Description |
| -------------- |----------------------------------------------------------------------------------------------------------------|
| Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note: without protocol header (e.g., https://, http://). |
| Port | The port number of the server IPMI over LAN, default is 623. |
| Username | IPMI user name |
| Password | IPMI password |
### Collected Metrics
#### Metric Set: Chassis
| Metric Name | Unit | Metric Description |
| -------------------- | ---- | ------------------------------------------------------------ |
| System Power | none | Current Power State. Power is on. |
| Power Overload | none | Power overload. System shutdown because of power overload condition. |
| Power Interlock | none | Power Interlock. |
| Main Power Fault | none | Power fault. Fault detected in main power subsystem. |
| Power Control Fault | none | Power control fault. Controller attempted to turn system power on or off, but systemdid not enter desired state. |
| Power Restore Policy | none | Power restore policy. |
| Last Power Event | none | Last Power Event. |
| Cooling/Fan Fault | none | Cooling/fan fault detected. |
| Drive Fault | none | Drive Fault. |
| Front-Panel Lockout | none | Front Panel Lockout active (power off and reset via chassispush-buttons disabled.) |
#### Metric Set: Sensor
| Metric Name | Unit | Metric Description |
| -------------- | ---- | ------------------------------------------------------------ |
| Sensor ID | none | Sensor ID. |
| Entity ID | none | Indicates the physical entity that the sensor is monitoring or is otherwiseassociated with the sensor. |
| Sensor Type | none | Sensor Type. |
| Sensor Reading | none | Current Sensor Reading. |
home/versioned_docs/version-1.6.x/help/issue.md
+56
View File
@@ -0,0 +1,56 @@
---
id: issue
title: Common issues
sidebar_label: Common issues
---
## Monitoring common issues
1. **Page feedback：monitor.host: Monitoring Host must be ipv4, ipv6 or domain name**
> As shown in the information, the entered monitoring Host must be ipv4, ipv6 or domain name, and cannot carry a protocol header, such as http
2. **The website API and other monitoring feedback statusCode:403 or 401, but the opposite end service itself does not need authentication, and the direct access of the browser is OK**
> Please check whether it is blocked by the firewall. For example, BaoTa/aaPanel have set the blocking of `User-Agent=Apache-HttpClient` in the request header by default. If it is blocked, please delete this blocking rule. (user-agent has been simulated as a browser in the v1.0.beat5 version. This problem does not exist)
3. Ping connectivity monitoring exception when installing hertzbeat for package deployment.
The hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。
> The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened.
> When you install HertzBeat via DockerDocker root is enabled by default. No such problem.
> See [https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address](https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address)
### Docker Deployment common issues
1. **MYSQL, TDENGINE and HertzBeat are deployed on the same host by Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail**
The problems lies in Docker container failed to visit and connect localhost port. Because the docker default network mode is Bridge mode which can't access local machine through localhost.
> Solution A：Configure application.yml. Change database connection address from localhost to external IP of the host machine.
> Solution B：Use the Host network mode to start Docker, namely making Docker container and hosting share network. `docker run -d --network host .....`
2. **According to the process deploy，visit [http://ip:1157/](http://ip:1157/) no interface**
Please refer to the following points to troubleshoot issues：
> one：Whether the MySQL database and tdengine database as dependent services have been successfully started, whether the corresponding hertzbeat database has been created, and whether the SQL script has been executed.
> two：Check whether dependent service, IP account and password configuration is correct in HertzBeat's configuration file `application.yml`.
> three：`docker logs hertzbeat` Check whether the container log has errors. If you haven't solved the issue, report it to the communication group or community.
3. **Log an error TDengine connection or insert SQL failed**
> one：Check whether database account and password configured is correct, the database is created.
> two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server.
### Package Deployment common issues
1. **According to the process deploy，visit [http://ip:1157/](http://ip:1157/) no interface**
Please refer to the following points to troubleshoot issues:
> one：Whether the MySQL database and tdengine database as dependent services have been successfully started, whether the corresponding hertzbeat database has been created, and whether the SQL script has been executed.
> two：Check whether dependent services, IP account and password configuration is correct in HertzBeat's configuration file `hertzbeat/config/application.yml`.
> three： Check whether the running log has errors in `hertzbeat/logs/` directory. If you haven't solved the issue, report it to the communication group or community.
2. **Log an error TDengine connection or insert SQL failed**
> one：Check whether database account and password configured is correct, the database is created.
> two：If you install TDengine2.3+ version, you must execute `systemctl start taosadapter` to start adapter in addition to start the server.
home/versioned_docs/version-1.6.x/help/jetty.md
+94
View File
@@ -0,0 +1,94 @@
---
id: jetty
title: Monitoring Jetty Web Server
sidebar_label: Jetty Web Server
keywords: [open source monitoring tool, open source jetty web server monitoring tool, monitoring jetty metrics]
---
> Collect and monitor general performance metrics of Jetty application server
**Usage protocol: JMX**
## Pre-monitoring Operations
>
> You need to enable the `JMX` service in the JVM application. HertzBeat uses the JMX protocol to collect metrics for the JVM.
### Jetty application server opens JMX protocol steps
[Refer to official documentation](https://www.eclipse.org/jetty/documentation/jetty-10/operations-guide/index.html#og-jmx-remote)
1. Start the JMX JMX-REMOTE module in Jetty
```shell
java -jar $JETTY_HOME/start.jar --add-module=jmx
java -jar $JETTY_HOME/start.jar --add-module=jmx-remote
```
Successful command execution will create ``JETTY_BASE`/start.d/jmx-remote.ini` configuration file
2. Edit the ``JETTY_BASE`/start.d/jmx-remote.ini` configuration file to modify the JMX IP port and other parameters.
**`localhost` needs to be modified to expose the IP**
```text
## The host/address to bind the RMI server to.
# jetty.jmxremote.rmiserverhost=localhost
## The port the RMI server listens to (0 means a random port is chosen).
# jetty.jmxremote.rmiserverport=1099
## The host/address to bind the RMI registry to.
# jetty.jmxremote.rmiregistryhost=localhost
## The port the RMI registry listens to.
# jetty.jmxremote.rmiregistryport=1099
## The host name exported in the RMI stub.
-Djava.rmi.server.hostname=localhost
```
3. Restart Jetty Server.
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by JMX |
| Username | JMX connection user name, optional |
| Password | JMX connection password, optional |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metrics
#### Metrics Set：memory_pool
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| name | | metrics name |
| committed | kb | total size |
| init | kb | init size |
| max | kb | max size |
| used | kb | used size |
#### Metrics Set：class_loading
| Metric name | Metric unit | Metric help description |
|-----------------------|-------------|--------------------------|
| LoadedClassCount | | Loaded Class Count |
| TotalLoadedClassCount | | Total Loaded Class Count |
| UnloadedClassCount | | Unloaded Class Count |
#### Metrics Set：thread
| Metric name | Metric unit | Metric help description |
|-------------------------|-------------|----------------------------|
| TotalStartedThreadCount | | Total Started Thread Count |
| ThreadCount | | Thread Count |
| PeakThreadCount | | Peak Thread Count |
| DaemonThreadCount | | Daemon Thread Count |
| CurrentThreadUserTime | ms | Current Thread User Time |
| CurrentThreadCpuTime | ms | Current Thread Cpu Time |
home/versioned_docs/version-1.6.x/help/jvm.md
+76
View File
@@ -0,0 +1,76 @@
---
id: jvm
title: Monitoring JVM
sidebar_label: JVM Monitor
keywords: [open source monitoring tool, open source java jvm monitoring tool, monitoring jvm metrics]
---
> Collect and monitor the general performance Metrics of JVM.
**Protocol Use：JMX**
## JVM App Enable JMX Protocol
1. Add JVM `VM options` When Start Server ⚠️ customIP
Refer: [https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#remote](https://docs.oracle.com/javase/1.5.0/docs/guide/management/agent.html#remote)
```shell
-Djava.rmi.server.hostname=customIP
-Dcom.sun.management.jmxremote.port=9999
-Dcom.sun.management.jmxremote.ssl=false
-Dcom.sun.management.jmxremote.authenticate=false
```
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by JMX |
| Username | JMX connection user name, optional |
| Password | JMX connection password, optional |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metrics
#### Metrics Set：memory_pool
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| name | | metrics name |
| committed | kb | total size |
| init | kb | init size |
| max | kb | max size |
| used | kb | used size |
#### Metrics Set：code_cache (Only Support JDK8)
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| committed | kb | total size |
| init | kb | init size |
| max | kb | max size |
| used | kb | used size |
#### Metrics Set：class_loading
| Metric name | Metric unit | Metric help description |
|-----------------------|-------------|--------------------------|
| LoadedClassCount | | Loaded Class Count |
| TotalLoadedClassCount | | Total Loaded Class Count |
| UnloadedClassCount | | Unloaded Class Count |
#### Metrics Set：thread
| Metric name | Metric unit | Metric help description |
|-------------------------|-------------|----------------------------|
| TotalStartedThreadCount | | Total Started Thread Count |
| ThreadCount | | Thread Count |
| PeakThreadCount | | Peak Thread Count |
| DaemonThreadCount | | Daemon Thread Count |
| CurrentThreadUserTime | ms | Current Thread User Time |
| CurrentThreadCpuTime | ms | Current Thread Cpu Time |
home/versioned_docs/version-1.6.x/help/kafka.md
+89
View File
@@ -0,0 +1,89 @@
---
id: kafka
title: Monitor：Apache Kafka
sidebar_label: Apache Kafka
keywords: [open source monitoring tool, open source apache kafka monitoring tool, monitoring apache kafka metrics]
---
> Collect and monitor the general performance Metrics of Apache Kafka.
**Protocol Use：JMX**
## Kafka Enable JMX Protocol
1. Install Kafka
2. Modify `kafka-server-start.sh`
Append content in kafka-server-start.sh, Attention Replace Port And IP.
```shell
export JMX_PORT=9999;
export KAFKA_JMX_OPTS="-Djava.rmi.server.hostname=ip地址 -Dcom.sun.management.jmxremote.rmi.port=9999 -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false";
# Already Has
exec $base_dir/kafka-run-class.sh $EXTRA_ARGS kafka.Kafka "$@"
```
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by JMX |
| Username | JMX connection user name, optional |
| Password | JMX connection password, optional |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metrics
#### Metrics Set：server_info
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| Version | | Kafka Version |
| StartTimeMs | ms | Start Time |
| CommitId | | Version Commit ID |
#### Metrics Set：memory_pool
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| name | | metrics name |
| committed | kb | total size |
| init | kb | init size |
| max | kb | max size |
| used | kb | used size |
#### Metrics Set：active_controller_count
| Metric name | Metric unit | Metric help description |
|-------------|-------------|--------------------------------|
| Value | | server active controller count |
#### Metrics Set：broker_partition_count
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| Value | | broker partition count |
#### Metrics Set：broker_leader_count
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| Value | | broker leader count |
#### Metrics Set：broker_handler_avg_percent
| Metric name | Metric unit | Metric help description |
|-------------------|-------------|-------------------------|
| EventType | | event type |
| RateUnit | | rate unit |
| Count | | percent count |
| OneMinuteRate | % | One Minute Rate |
| FiveMinuteRate | % | Five Minute Rate |
| MeanRate | % | Mean Rate |
| FifteenMinuteRate | % | Fifteen Minute Rate |
home/versioned_docs/version-1.6.x/help/kafka_client.md
+57
View File
@@ -0,0 +1,57 @@
---
id: kafka_client
title: Monitoring： Kafka Monitoring (Client-based)
sidebar_label: Kafka Monitoring (Client-based)
keywords: [open-source monitoring system, open-source message middleware monitoring, Kafka monitoring]
---
> Collect and monitor general metrics for Kafka.
## Configuration Parameters
| Parameter Name | Help Description |
|------------------|---------------------------------------------------------------|
| Monitoring Host | The monitored peer's IPv4, IPv6, or domain name. Note: ⚠️ Do not include protocol headers (e.g., https://, http://). |
| Monitoring Port | The monitored service port. |
| Task Name | The identifier for this monitoring task, which must be unique. |
| Collection Interval | The interval for periodic data collection, in seconds. The minimum allowable interval is 30 seconds. |
| Description/Remarks | Additional information to describe and identify this monitoring task. Users can add remarks here. |
### Collected Metrics
#### Metric Set: topic_list
| Metric Name | Unit | Help Description |
|--------------|------|------------------|
| TopicName | None | Topic Name |
#### Metric Set: topic_detail
| Metric Name | Unit | Help Description |
|----------------------|------|------------------|
| TopicName | None | Topic Name |
| PartitionNum | None | Number of Partitions |
| PartitionLeader | None | Partition Leader |
| BrokerHost | None | Broker Host |
| BrokerPort | None | Broker Port |
| ReplicationFactorSize| None | Replication Factor Size |
| ReplicationFactor | None | Replication Factor |
#### Metric Set: topic_offset
| Metric Name | Unit | Help Description |
|---------------|------|------------------|
| TopicName | None | Topic Name |
| PartitionNum | None | Number of Partitions |
| earliest | None | Earliest Offset |
| latest | None | Latest Offset |
#### Metric Set：consumer_detail
| Metric Name | Unit | Help Description |
|-----------|--|------------------------------------|
| GroupId | None | Consumer Group Id |
| group_member_num | None | Number of Consumer Instances |
| Subscribed Topic Name | None | Topic Name Subscribed by the Group |
| offset_of_each_partition | None | Offsets for Each Partition |
| Lag | None | Lag of Consumer |
home/versioned_docs/version-1.6.x/help/kafka_promql.md
+66
View File
@@ -0,0 +1,66 @@
---
id: kafka_promql
title: Monitoring Kafka-PromQL
sidebar_label: Kafka-PromQL
keywords: [ Open Source Monitoring System, Open Source Middleware Monitoring, Kafka Monitoring, Kafka-PromQL Monitoring ]
---
> Monitor Kafka by querying generic metrics data from Prometheus server using Prometheus PromQL. This approach is suitable when Prometheus is already monitoring Kafka and you need to fetch Kafka's
> monitoring data from Prometheus server.
## Prerequisites
1. Deploy Kafka.
2. Deploy kafka_exporter.
3. Collect monitoring metrics exposed by kafka_exporter through Prometheus.
### Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|----------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | IP, IPv6, or domain name of the target being monitored. Note ⚠️: Do not include protocol header (e.g., https://, http://). |
| Monitoring name | Name to identify this monitoring, ensuring uniqueness of names. |
| Port | Prometheus API port, default: 9090. |
| Relative path | Relative path of Prometheus to query PromQL, default: /api/v1/query |
| Request mode | Set the request method for API calls: GET, POST, PUT, DELETE, default: GET |
| Enable HTTPS | Whether to access the website via HTTPS, note ⚠️: enabling HTTPS generally requires changing the corresponding port to 443 |
| Username | Username for Basic or Digest authentication when accessing the API. |
| Password | Password for Basic or Digest authentication when accessing the API. |
| Content-Type | Resource type when carrying BODY request data. |
| Request BODY | Set the BODY request data, effective for PUT and POST request methods. |
| Collection interval | Interval for periodic data collection in seconds, the minimum interval that can be set is 30 seconds |
| Description remarks | Additional remarks and descriptions for this monitoring. Users can add notes here. |
### Metrics Collection
#### Metric Set: kafka_brokers
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------------------|
| __name__ | None | Metric name |
| instance | None | Instance to which the metric belongs |
| timestamp | None | Timestamp of metric collection |
| value | None | Metric value |
#### Metric Set: kafka_topic_partitions
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------------------|
| __name__ | None | Metric name |
| instance | None | Instance to which the metric belongs |
| timestamp | None | Timestamp of metric collection |
| value | None | Metric value |
#### Metric Set: kafka_server_brokertopicmetrics_bytesinpersec
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------------------|
| __name__ | None | Metric name |
| instance | None | Instance to which the metric belongs |
| timestamp | None | Timestamp of metric collection |
| value | None | Metric value |
### Other Kafka Monitoring Methods Supported by HertzBeat
1. If Kafka is enabled with JMX monitoring, you can use [Kafka](kafka) Monitoring.
2. If Kafka cluster deploys kafka_exporter to expose monitoring metrics, you can refer to [Prometheus task](prometheus) to configure the Prometheus collection task to monitor kafka.
home/versioned_docs/version-1.6.x/help/kingbase.md
+55
View File
@@ -0,0 +1,55 @@
---
id: kingbase
title: Monitoring：Kingbase database monitoring
sidebar_label: Kingbase database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring kingbase database metrics]
---
> Collect and monitor the general performance Metrics of Kingbase database. Support Kingbase V8R6+.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by the database. The default is 5432 |
| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms |
| Database name | Database instance name, optional |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|-------------------------------------------|
| server_version | none | Version number of the database server |
| port | none | Database server exposure service port |
| server_encoding | none | Character set encoding of database server |
| data_directory | none | Database storage data disk address |
| max_connections | connections | Database maximum connections |
#### Metric set：state
| Metric name | Metric unit | Metric help description |
|----------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | none | Database name, or share-object is a shared object |
| conflicts | times | The number of queries canceled in the database due to a conflict with recovery |
| deadlocks | number | Number of deadlocks detected in the database |
| blks_read | times | The number of disk blocks read in the database |
| blks_hit | times | Times the disk block has been found to be in the buffer, so there is no need to read it once (This only includes hits in the Kingbase buffer, not in the operating system file system buffer) |
| blk_read_time | ms | Time spent by the backend reading data file blocks in the database |
| blk_write_time | ms | Time spent by the backend writing data file blocks in the database |
| stats_reset | none | The last time these statistics were reset |
#### Metric set：activity
| Metric name | Metric unit | Metric help description |
|-------------|-------------|--------------------------------------|
| running | connections | Number of current client connections |
home/versioned_docs/version-1.6.x/help/kubernetes.md
+95
View File
@@ -0,0 +1,95 @@
---
id: kubernetes
Title: Monitoring Kubernetes
sidebar_label: Kubernetes Monitor
keywords: [open source monitoring tool, open source kubernetes monitoring tool, monitoring kubernetes metrics]
---
> Collect and monitor the general performance metrics of Kubernetes.
## Pre-monitoring operations
If you want to monitor the information in 'Kubernetes', you need to obtain an authorization token that can access the API Server, so that the collection request can obtain the corresponding information.
Refer to the steps to obtain token
### method one
1. Create a service account and bind the default cluster-admin administrator cluster role
```kubectl create serviceaccount dashboard-admin -n kube-system```
2. User Authorization
```shell
kubectl create clusterrolebinding dashboard-admin --clusterrole=cluster-admin --serviceaccount=kube-system:dashboard-admin
kubectl -n kube-system get secret | grep dashboard-admin | awk '{print $1}'
kubectl describe secret {secret} -n kube-system
```
### method two
```shell
kubectl create serviceaccount cluster-admin
kubectl create clusterrolebinding cluster-admin-manual --clusterrole=cluster-admin --serviceaccount=default:cluster-admin
kubectl create token --duration=1000h cluster-admin
```
### Configure parameters
| Parameter name | Parameter Help describes the |
|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
| Monitor Host | THE MONITORED PEER IPV4, IPV6 OR DOMAIN NAME. Note ⚠️ that there are no protocol headers (eg: https://, http://). |
| Monitoring Name | A name that identifies this monitoring that needs to be unique. |
| APiServer port | K8s APiServer port, default 6443 |
| token | Authorize the Access Token |
| URL | The database connection URL is optional, if configured, the database name, user name and password parameters in the URL will override the parameter | configured above |
| The acquisition interval is | Monitor the periodic data acquisition interval, in seconds, and the minimum interval that can be set is 30 seconds |
| Whether to probe the | Whether to check the availability of the monitoring before adding a monitoring is successful, and the new modification operation | will continue only if the probe is successful |
| Description Comment | For more information identifying and describing the remarks for this monitoring, users can remark the information here |
### Collect metrics
#### metric collection: nodes
| Metric Name | metric unit | Metrics help describe |
|--------------------|-------------|-----------------------|-----------|
| node_name | None | Node name |
| is_ready | None | Node Status |
| capacity_cpu | None | CPU capacity |
| allocatable_cpu | None | CPU | allotted |
| capacity_memory | None | Memory capacity |
| allocatable_memory | None | Memory | allocated |
| creation_time | None | Node creation time |
#### metric Collection: namespaces
| Metric Name | metric unit | Metrics help describe |
|---------------|-------------|-----------------------|
| namespace | None | namespace name |
| status | None | Status |
| creation_time | None | Created |
#### metric collection: pods
| Metric Name | metric unit | Metrics help describe |
|---------------|-------------|-------------------------------|--------------------------|
| pod | None | Pod name |
| namespace | None | The namespace | to which the pod belongs |
| status | None | Pod status |
| restart | None | Number of restarts |
| host_ip | None | The IP address of the host is |
| pod_ip | None | pod ip |
| creation_time | None | Pod creation time |
| start_time | None | Pod startup time |
#### metric Collection: services
| Metric Name | metric unit | Metrics help describe |
|---------------|-------------|-----------------------------------------------------------|------------------------------|
| service | None | Service Name |
| namespace | None | The namespace | to which the service belongs |
| type | None | Service Type ClusterIP NodePort LoadBalancer ExternalName |
| cluster_ip | None | cluster ip |
| selector | None | tag selector matches |
| creation_time | None | Created |
home/versioned_docs/version-1.6.x/help/linux.md
+81
View File
@@ -0,0 +1,81 @@
---
id: linux
title: Monitoring：Linux operating system monitoring
sidebar_label: Linux operating system
keywords: [open source monitoring tool, open source linux monitoring tool, monitoring linux metrics]
---
> Collect and monitor the general performance Metrics of Linux operating system.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by Linux SSH. The default is 22 |
| Username | SSH connection user name, optional |
| Password | SSH connection password, optional |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|-------------|-------------|--------------------------|
| hostname | none | Host name |
| version | none | Operating system version |
| uptime | none | System running time |
#### Metric set：cpu
| Metric name | Metric unit | Metric help description |
|----------------|-------------|------------------------------------------------|
| info | none | CPU model |
| cores | cores | Number of CPU cores |
| interrupt | number | Number of CPU interrupts |
| load | none | Average load of CPU in the last 1/5/15 minutes |
| context_switch | number | Number of current context switches |
| usage | % | CPU usage |
#### Metric set：memory
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------------------|
| total | Mb | Total memory capacity |
| used | Mb | User program memory |
| free | Mb | Free memory capacity |
| buff_cache | Mb | Memory occupied by cache |
| available | Mb | Remaining available memory capacity |
| usage | % | Memory usage |
#### Metric set：disk
| Metric name | Metric unit | Metric help description |
|---------------|-------------|----------------------------------------|
| disk_num | blocks | Total number of disks |
| partition_num | partitions | Total number of partitions |
| block_write | blocks | Total number of blocks written to disk |
| block_read | blocks | Number of blocks read from disk |
| write_rate | iops | Rate of writing disk blocks per second |
#### Metric set：interface
| Metric name | Metric unit | Metric help description |
|----------------|-------------|------------------------------|
| interface_name | none | Network card name |
| receive_bytes | byte | Inbound data traffic(bytes) |
| transmit_bytes | byte | Outbound data traffic(bytes) |
#### Metric set：disk_free
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-------------------------|
| filesystem | none | File system name |
| used | Mb | Used disk size |
| available | Mb | Available disk size |
| usage | % | usage |
| mounted | none | Mount point directory |
home/versioned_docs/version-1.6.x/help/linux_script.md
+101
View File
@@ -0,0 +1,101 @@
---
id: linux_script
title: Monitoring：Using Scripts to Monitor Linux Operating System
sidebar_label: Using Scripts to Monitor Linux OS
keywords: [open source monitoring system, open source network monitoring, using scripts to monitor Linux OS]
---
## Preparation
>
> To monitor the local machine, simply deploy HertzBeat. To monitor other hosts, you need to deploy a collector on the target host. Refer to [this link](https://github.com/apache/hertzbeat?tab=readme-ov-file#2install-via-package) for step 5 of the installation process.
If the collector is installed using Docker, it will cause the collector to be unable to monitor the process information on the host machine, because Docker containers run in an isolated environment, with each container having its own process space.
> When creating a monitoring task and selecting a collector, choose the corresponding collector deployed on the target host.
### Configuration Parameters
| Parameter Name | Parameter Description |
|:---------------|-----------------------------------------------------|---|
| Monitor Host | The IPv4, IPv6, or domain of the monitored endpoint. Note ⚠️ Do not include protocol headers (e.g., https://, http://). |
| Task Name | The name identifying this monitoring task, which needs to be unique. |
| Collector | Specifies which collector will be used for data collection in this monitoring task. |
| Monitoring Interval | The time interval for periodic data collection, in seconds. |
| Binding Tag | Classification management tags for monitoring resources. |
| Description Notes | Additional notes to describe this monitoring task. Users can add remarks here. |
### Metrics Collection
#### Metric Set: basic
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|--------------------------|
| hostname | None | Name of the host |
| version | None | Operating system version |
| uptime | None | System uptime |
#### Metric Set: cpu
| Metric Name | Metric Unit | Metric Description |
|----------------|-------------|-----------------------------------------------|
| info | None | CPU model |
| cores | Number | Number of CPU cores |
| interrupt | Count | Number of CPU interrupts |
| load | None | Average CPU load over the last 1/5/15 minutes |
| context_switch | Count | Current number of context switches |
| usage | % | CPU usage percentage |
#### Metric Set: memory
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|------------------------------|
| total | Mb | Total memory capacity |
| used | Mb | Memory used by user programs |
| free | Mb | Free memory capacity |
| buff_cache | Mb | Memory used by cache |
| available | Mb | Available memory capacity |
| usage | % | Memory usage percentage |
#### Metric Set: disk
| Metric Name | Metric Unit | Metric Description |
|---------------|-------------|-------------------------------------------|
| disk_num | Count | Total number of disks |
| partition_num | Count | Total number of partitions |
| block_write | Count | Total number of blocks written to disk |
| block_read | Count | Total number of blocks read from disk |
| write_rate | iops | Rate of blocks written to disk per second |
#### Metric Set: interface
| Metric Name | Metric Unit | Metric Description |
|----------------|-------------|-------------------------------|
| interface_name | None | Network interface name |
| receive_bytes | byte | Inbound data traffic (bytes) |
| transmit_bytes | byte | Outbound data traffic (bytes) |
#### Metric Set: disk_free
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|------------------------|
| filesystem | None | Name of the filesystem |
| used | Mb | Used disk size |
| available | Mb | Available disk size |
| usage | % | Disk usage percentage |
| mounted | None | Mount point directory |
#### Metric Set: Top 10 Programs by CPU Usage
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|-------------------------|
| id | None | Process ID |
| cpu | % | CPU usage percentage |
| ws | % | Memory usage percentage |
| command | None | Executed command |
#### Metric Set: Top 10 Programs by Memory Usage
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|-------------------------|
| id | None | Process ID |
| cpu | % | CPU usage percentage |
| ws | % | Memory usage percentage |
| command | None | Executed command |
home/versioned_docs/version-1.6.x/help/mariadb.md
+59
View File
@@ -0,0 +1,59 @@
---
id: mariadb
title: Monitoring：MariaDB database monitoring
sidebar_label: MariaDB database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring mariadb database metrics]
---
> Collect and monitor the general performance Metrics of MariaDB database. Support MariaDB5+.
## Attention, Need Add MYSQL jdbc driver jar
- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.1.0.jar. [https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0](https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0)
- Copy the jar package to the `hertzbeat/ext-lib` directory.
- Restart the HertzBeat service.
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by the database. The default is 3306 |
| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms |
| Database name | Database instance name, optional |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|------------------------------------|
| version | none | Database version |
| port | none | Database exposure service port |
| datadir | none | Database storage data disk address |
| max_connections | none | Database maximum connections |
#### Metric set：status
| Metric name | Metric unit | Metric help description |
|-------------------|-------------|------------------------------------|
| threads_created | none | MariaDB created total connections |
| threads_connected | none | MariaDB connected connections |
| threads_cached | none | MariaDB current cached connections |
| threads_running | none | MariaDB current active connections |
#### Metric set：innodb
| Metric name | Metric unit | Metric help description |
|---------------------|-------------|------------------------------------------------------|
| innodb_data_reads | none | innodb average number of reads from files per second |
| innodb_data_writes | none | innodb average number of writes from file per second |
| innodb_data_read | KB | innodb average amount of data read per second |
| innodb_data_written | KB | innodb average amount of data written per second |
home/versioned_docs/version-1.6.x/help/memcached.md
+67
View File
@@ -0,0 +1,67 @@
---
id: memcached
title: Monitoring Memcached
sidebar_label: Memcached Monitor
keywords: [ open source monitoring tool, open source Memcached monitoring tool, monitoring memcached metrics ]
---
> Collect and monitor the general performance Metrics of Memcached.
**Protocol Use：Memcached**
```text
The default YML configuration for the memcache version is in compliance with 1.4.15.
You need to use the stats command to view the parameters that your memcache can monitor
```
**1、Obtain usable parameter indicators through commands such as stats、stats setting、stats settings.
```shell
# telnet ip port
[root@server ~]# telnet localhost 11211
Trying ::1...
Connected to localhost.
Escape character is '^]'.
stats
STAT pid 15168
STAT uptime 11691
STAT time 1702569246
STAT version 1.4.15
...
```
**There is help_doc: [https://www.runoob.com/memcached/memcached-stats.html](https://www.runoob.com/memcached/memcached-stats.html)**
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by Memcached |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metrics
#### Metrics Set：server_info
| Metric name | Metric unit | Metric help description |
|------------------|-------------|---------------------------------------------------|
| pid | | Memcache server process ID |
| uptime | s | The number of seconds the server has been running |
| version | | Memcache version |
| curr_connections | | Current number of connections |
| auth_errors | | Number of authentication failures |
| threads | | Current number of threads |
| item_size | byte | The size of the item |
| item_count | | Number of items |
| curr_items | | The total number of data currently stored |
| total_items | | The total number of data stored since startup |
| bytes | byte | The current number of bytes occupied by storage |
| cmd_get | | Get command request count |
| cmd_set | | Set command request count |
| cmd_flush | | Flush command request count |
| get_misses | | Get command misses |
| delete_misses | | Delete command misses |
home/versioned_docs/version-1.6.x/help/modbus.md
+80
View File
@@ -0,0 +1,80 @@
---
id: modbus
title: Monitoring Modbus
sidebar_label: Modbus Monitor
keywords: [ open source monitoring tool, Modbus monitoring ]
---
> The response of Modbus service and other related indicators are monitored.
## Configuration Parameters
| Parameter Name | Parameter Help Description |
|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| Host of Modbus Service | The IPv4, IPv6, or domain name of the Modbus device to be monitored. Note ⚠️ do not include the protocol header (e.g., https://, http://). |
| Task Name | A name that identifies this monitoring task; the name must be unique. |
| Port | The port used for Modbus network communication. |
| Slave ID (slaveId) | The ID of the slave device in the Modbus network. |
| Holding Register Address | Used for categorizing and managing monitored resources. |
| Coil Register Address | Additional notes and descriptions for this monitoring task; users can add remarks here. |
| Timeout | The allowed time for collecting a response. |
### Collected Metrics
#### Metric Set: holding-register
1. The number of parameters must match the total number of coil register addresses specified in the parameters.
2. Alias format for parameters: holding-register:m or holding-register:m-n
Parameter example:
Coil register addresses:
```text
1,2[3]
```
Parameter alias names:
```yaml
aliasFields:
- responseTime
- holding-register:0
- holding-register:1-0
- holding-register:1-1
- holding-register:1-2
```
| Metric Name | Metric Unit | Metric Help Description |
|----------------------------|--------------|-----------------------------------------------------------------|
| Response Time | Milliseconds | The time required by the Modbus server to respond to a request. |
| Holding Register Parameter | | Setpoint for analog output |
#### Metric Set: coil
1. The number of parameters must match the total number of coil register addresses specified in the parameters.
2. Alias format for parameters: coil:m or coil:m-n
Parameter example:
Coil register addresses:
```text
1,2[3]
```
Parameter alias names:
```yaml
aliasFields:
- responseTime
- coil:0
- coil:1-0
- coil:1-1
- coil:1-2
```
| Metric Name | Metric Unit | Metric Help Description |
|---------------|--------------|-----------------------------------------------------------------|
| Response Time | Milliseconds | The time required by the Modbus server to respond to a request. |
| Coil Status | | Coil status (0 or 1) |
home/versioned_docs/version-1.6.x/help/mongodb.md
+95
View File
@@ -0,0 +1,95 @@
---
id: mongodb
title: Monitoring:MongoDB
sidebar_label: MongoDB database
keywords: [ open source monitoring tool, open source database monitoring tool, monitoring MongoDB database metrics ]
---
> Collect and monitor the general performance Metrics of MongoDB database.
## Configuration parameter
| Parameter name | Parameter help description |
|------------------------|-------------------------------------------------------------------------------------------------------------------------|
| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://). |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique. |
| Port | Port provided by the database. The default is 27017. |
| Username | Username for MongoDB,Optional. |
| Password | Password for MongoDB,Optional. |
| database | Database name. |
| authenticationDatabase | Credentials Storage Database. |
| Connect Timeout(ms) | Set connection timeout for MongoDB, unit: ms, default: 6000ms. |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Bind Tags | Used to classify and manage monitoring resources. |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here. |
### Collection Metric
#### Metric set:Build Info
| Metric name | Metric unit | Metric help description |
|------------------|-------------|-----------------------------------------------------------------------------------------|
| version | none | The version number of the MongoDB server. |
| gitVersion | none | The Git version of the MongoDB codebase. |
| sysInfo | none | System information, typically includes details about the operating system and platform. |
| loaderFlags | none | Loader flags used to link MongoDB binaries |
| compilerFlags | none | Compiler flags used when compiling MongoDB. |
| allocator | none | The memory allocator used by MongoDB. |
| javascriptEngine | none | The JavaScript engine used by MongoDB. |
#### Metric set:Server Document
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-----------------------------------|
| deleted | none | The number of documents deleted. |
| inserted | none | The number of documents inserted. |
| returned | none | The number of documents returned. |
| updated | none | The number of documents updated. |
#### Metric set:Server Operation
| Metric name | Metric unit | Metric help description |
|----------------|-------------|------------------------------------------------------------------|
| scanAndOrder | none | The number of times a query required both scanning and ordering. |
| writeConflicts | none | The number of write conflicts that occurred. |
#### Metric set: Max Connections
| Metric name | Metric unit | Metric help description |
|------------------|-------------|--------------------------------------------|
| deletedDocuments | none | Number of deleted documents. |
| passes | none | Total number of passes for TTL operations. |
#### Metric set:System Info
| Metric name | Metric unit | Metric help description |
|-------------|-------------|------------------------------------------------------|
| currentTime | none | Current system time. |
| hostname | none | Hostname of the server. |
| cpuAddrSize | MB | Size of CPU address in bits. |
| memSizeMB | MB | Total size of system memory in megabytes. |
| memLimitMB | MB | Memory limit for the MongoDB process in megabytes. |
| numCores | none | Total number of CPU cores. |
| cpuArch | none | CPU architecture. |
| numaEnabled | none | Whether NUMA (Non-Uniform Memory Access) is enabled. |
#### Metric set:OS Info
| Metric name | Metric unit | Metric help description |
|-------------|-------------|----------------------------------|
| type | none | Type of the operating system. |
| name | none | Name of the operating system. |
| version | none | Version of the operating system. |
#### Metric set：Extra Info
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|--------------------------------------------------------|
| versionString | none | String describing the version of the operating system. |
| libcVersion | none | Version of the C standard library (libc). |
| kernelVersion | none | Version of the operating system kernel. |
| cpuFrequencyMHz | none | Frequency of the CPU in megahertz. |
| cpuFeatures | none | Features supported by the CPU. |
| pageSize | none | Size of a memory page in bytes. |
| numPages | none | Total number of memory pages. |
| maxOpenFiles | none | Maximum number of open files allowed. |
home/versioned_docs/version-1.6.x/help/mongodb_atlas.md
+77
View File
@@ -0,0 +1,77 @@
---
id: mongodb_atlas
title: Monitoring MongoDB Atlas Database
sidebar_label: MongoDB Atlas Database
keywords: [open-source monitoring system, open-source database monitoring, MongoDB Atlas database monitoring]
---
> Collect and monitor general performance metrics of MongoDB Atlas databases.
## Configuration Parameters
| Parameter Name | Parameter Description |
|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| Target Host | The IP address, IPv4, IPv6, or domain name of the target to be monitored. Note: ⚠️ Do not include protocol headers (e.g., https://, http://). |
| Task Name | The name identifying this monitor, which must be unique. |
| Username | MongoDB username, optional. |
| Password | MongoDB password, optional. |
| Database | Name of the database. |
| Authentication Database | The name of the database storing user credentials. |
| Connection Timeout | Timeout for MongoDB connection when no response is received, in milliseconds (ms). Default is 6000 ms. |
| Cluster Mode | Value for MongoDB Atlas cluster: mongodb-atlas |
| Collection Interval | Interval for periodic data collection, in seconds. The minimum interval is 30 seconds. |
| Binding Tags | Used for categorizing and managing monitoring resources. |
| Description/Remarks | Additional labels and description for this monitor; users can add notes here. |
### Collection Metrics
#### Metric Set: Build Information
| Metric Name | Unit | Metric Description |
|------------------|------|-----------------------------------|
| version | None | MongoDB version information |
| gitVersion | None | Source code git version |
| sysInfo | None | System information |
| allocator | None | Memory allocator used by MongoDB |
| javascriptEngine | None | JavaScript engine used by MongoDB |
#### Metric Set: Server Document
| Metric Name | Unit | Metric Description |
|-------------|------|---------------------------------------------------|
| delete | None | Number of deletions |
| insert | None | Number of insertions |
| update | None | Number of updates |
| query | None | Number of queries |
| getmore | None | Number of requests for remaining cursor documents |
| command | None | Total number of command operations |
#### Metric Set: Network Operations
| Metric Name | Unit | Metric Description |
|-------------|------|-----------------------------------------------------|
| Bytes In | None | Number of times a query needs to scan and sort data |
| Bytes Out | None | Number of write conflicts |
| Request Num | None | Number of requests |
#### Metric Set: Connection Information
| Metric Name | Unit | Metric Description |
|---------------------------|------|--------------------------------------|
| Current Connections | None | Number of current active connections |
| Available Connections | None | Number of available connections |
| Total Created Connections | None | Total number of connections created |
#### Metric Set: Database Statistics
| Metric Name | Unit | Metric Description |
|-------------------|-------|---------------------------|
| Database Name | None | Name of the database |
| Collections | None | Number of collections |
| Views | None | Number of views |
| Objects | None | Number of documents |
| Document Avg Size | Bytes | Average size of documents |
| Document Size | Bytes | Total size of documents |
| Storage Size | Bytes | Size of storage used |
| Indexes | None | Number of indexes |
| Index Size | Bytes | Total size of indexes |
home/versioned_docs/version-1.6.x/help/mqtt.md
+44
View File
@@ -0,0 +1,44 @@
---
id: mqtt
title: Monitoring MQTT Connection
sidebar_label: MQTT Connection
keywords: [ Open Source Monitoring System, MQTT Connection Monitoring ]
---
> Monitor MQTT connection status, supporting MQTT5 and MQTT3.1.1 protocols.
**Protocol used: mqtt**
:::tip
To check if topics can be subscribed to normally, HertzBeat will subscribe to a topic and then immediately unsubscribe; to verify if messages can be published correctly, HertzBeat will send a test
message to a topic (if the test message parameter is empty, this check will not be performed).
Please ensure that these operations will not affect your system.
:::
## Configuration Parameters
| Parameter Name | Parameter Description |
|------------------------|------------------------------------------------------------------------------------------------------------------------------------|
| Target Host | The monitored target's IPv4, IPv6, or domain name. Note ⚠️: Do not include protocol headers (e.g., https://, http://). |
| Task Name | The name of this monitoring task, which needs to be unique. |
| Port | The port where the MQTT service is open, default is 1883. |
| Protocol Version | The MQTT protocol version, supporting MQTT5 and MQTT3.1.1. |
| Connection Timeout(ms) | Connection timeout in milliseconds, default is 6000 ms. |
| Client Id | MQTT client ID, default is `hertzbeat-mqtt-client`. |
| Topic | The topic to be monitored. |
| Test Message | Message content used to test whether a topic can be published to normally (optional; if empty, `canPublish` will always be false). |
| Username | MQTT authentication username (optional). |
| Password | MQTT authentication password (optional). |
| Intervals | Interval for periodic data collection, in seconds; the minimum interval that can be set is 30 seconds. |
| Binding Tag | Used for classification and management of monitoring resources. |
| Description | Additional notes to identify and describe this monitoring task, users can leave notes here. |
### Collected Metrics
#### Metric Set: Summary
| Metric Name | Unit | Metric Description |
|--------------|------|---------------------------------------------------------|
| responseTime | none | Response time |
| canPublish | none | Whether messages can be published to the topic normally |
| canSubscribe | none | Whether the topic can be subscribed to normally |
home/versioned_docs/version-1.6.x/help/mysql.md
+59
View File
@@ -0,0 +1,59 @@
---
id: mysql
title: Monitoring：MySQL database monitoring
sidebar_label: MySQL database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring mysql database metrics]
---
> Collect and monitor the general performance Metrics of MySQL database. Support MYSQL5+.
## Attention, Need Add MYSQL jdbc driver jar
- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.1.0.jar. [https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0](https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0)
- Copy the jar package to the `hertzbeat/ext-lib` directory.
- Restart the HertzBeat service.
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by the database. The default is 3306 |
| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms |
| Database name | Database instance name, optional |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|------------------------------------|
| version | none | Database version |
| port | none | Database exposure service port |
| datadir | none | Database storage data disk address |
| max_connections | none | Database maximum connections |
#### Metric set：status
| Metric name | Metric unit | Metric help description |
|-------------------|-------------|----------------------------------|
| threads_created | none | MySql created total connections |
| threads_connected | none | MySql connected connections |
| threads_cached | none | MySql current cached connections |
| threads_running | none | MySql current active connections |
#### Metric set：innodb
| Metric name | Metric unit | Metric help description |
|---------------------|-------------|------------------------------------------------------|
| innodb_data_reads | none | innodb average number of reads from files per second |
| innodb_data_writes | none | innodb average number of writes from file per second |
| innodb_data_read | KB | innodb average amount of data read per second |
| innodb_data_written | KB | innodb average amount of data written per second |
home/versioned_docs/version-1.6.x/help/nacos.md
+94
View File
@@ -0,0 +1,94 @@
---
id: nacos
title: Monitoring：Nacos Server monitoring
sidebar_label: Nacos Server
keywords: [open source monitoring tool, open source middleware monitoring tool, monitoring Nacos Server metrics]
---
> HertzBeat monitors metrics of the Nacos Server by calling the Nacos Metrics Api.
## PreRequisites
### Deploy Nacos cluster to expose metrics data
1. Deploy the Nacos cluster according to [deployment document](https://nacos.io/en-us/docs/deployment.html).
2. Configure the application. properties file to expose metrics data.
```properties
management.endpoints.web.exposure.include=*
```
3. Access ```{ip}:8848/nacos/actuator/prometheus``` to see if metrics data can be accessed.
More information see [Nacos monitor guide](https://nacos.io/en-us/docs/monitor-guide.html).
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|-------------------------------------------------------------------------------------------------------------------------|
| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Target name | Identify the name of this monitoring. The name needs to be unique |
| Nacos Port | Port provided by the Nacos Server. The default is 8848 |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：jvm
| Metric name | Metric unit | Metric help description |
|----------------------------|-------------|-------------------------|
| system_cpu_usage | none | cpu usage |
| system_load_average_1m | none | load |
| jvm_memory_used_bytes | byte | jvm memory used |
| jvm_memory_max_bytes | byte | jvm max memory |
| jvm_gc_pause_seconds_count | none | gc count |
| jvm_gc_pause_seconds_sum | second | gc time |
| jvm_threads_daemon | none | jvm threads count |
#### Metric set：Nacos
| Metric name | Metric unit | Metric help description |
|----------------------------------------|-------------|-----------------------------------------|
| http_server_requests_seconds_count | second | http requests count |
| http_server_requests_seconds_sum | second | http requests time |
| nacos_timer_seconds_sum | second | Nacos config notify time |
| nacos_timer_seconds_count | none | Nacos config notify count |
| nacos_monitor`{name="longPolling"}` | none | Nacos config connection count |
| nacos_monitor`{name="configCount"}` | none | Nacos configuration file count |
| nacos_monitor`{name="dumpTask"}` | none | Nacos config dump task count |
| nacos_monitor`{name="notifyTask"}` | none | Nacos config notify task count |
| nacos_monitor`{name="getConfig"}` | none | Nacos config read configuration count |
| nacos_monitor`{name="publish"}` | none | Nacos config update configuration count |
| nacos_monitor`{name="ipCount"}` | none | Nacos naming ip count |
| nacos_monitor`{name="domCount"}` | none | Nacos naming domain count(1.x version) |
| nacos_monitor`{name="serviceCount"}` | none | Nacos naming domain count(2.x version) |
| nacos_monitor`{name="failedPush"}` | none | Nacos naming push fail count |
| nacos_monitor`{name="avgPushCost"}` | second | Nacos naming push cost time(average) |
| nacos_monitor`{name="leaderStatus"}` | none | Nacos naming if node is leader |
| nacos_monitor`{name="maxPushCost"}` | second | Nacos naming push cost time(max) |
| nacos_monitor`{name="mysqlhealthCheck"}` | none | Nacos naming mysql health check count |
| nacos_monitor`{name="httpHealthCheck"}` | none | Nacos naming http health check count |
| nacos_monitor`{name="tcpHealthCheck"}` | none | Nacos naming tcp health check count |
#### Metric set：Nacos exception
| Metric name | Metric unit | Metric help description |
|----------------------------------------------------|-------------|------------------------------------------------|
| nacos_exception_total`{name="db"}` | none | database exception |
| nacos_exception_total`{name="configNotify"}` | none | Nacos config notify exception |
| nacos_exception_total`{name="unhealth"}` | none | Nacos config server health check exception |
| nacos_exception_total`{name="disk"}` | none | Nacos naming write disk exception |
| nacos_exception_total`{name="leaderSendBeatFailed"}` | none | Nacos naming leader send heart beat fail count |
| nacos_exception_total`{name="illegalArgument"}` | none | request argument illegal count |
| nacos_exception_total`{name="nacos"}` | none | Nacos inner exception |
#### Metric set：client
| Metric name | Metric unit | Metric help description |
|----------------------------------------|-------------|-----------------------------------|
| nacos_monitor`{name="subServiceCount"}` | none | subscribed services count |
| nacos_monitor`{name="pubServiceCount"}` | none | published services count |
| nacos_monitor`{name="configListenSize"}` | none | listened configuration file count |
| nacos_client_request_seconds_count | none | request count |
| nacos_client_request_seconds_sum | second | request time |
home/versioned_docs/version-1.6.x/help/nebulagraph.md
+72
View File
@@ -0,0 +1,72 @@
---
id: nebulaGraph
title: Monitoring NebulaGraph
sidebar_label: NebulaGraph Database
keywords: [ open source monitoring tool, open source NebulaGraph monitoring tool, monitoring NebulaGraph metrics ]
---
> Collect and monitor the general performance Metrics of nebulaGraph.
**Protocol Use：nebulaGraph**
```text
The monitoring has two parts,nebulaGraph_stats and rocksdb_stats.
nebulaGraph_stats is nebulaGraph's statistics, and rocksdb_stats is rocksdb's statistics.
```
**1、Obtain available parameters through the stats and rocksdb stats interfaces.**
1.1、 If you only need to get nebulaGraph_stats, you need to ensure that you have access to stats, or you'll get errors.
The default port is 19669 and the access address is [http://ip:19669/stats](http://ip:19669/stats)
1.2、If you need to obtain additional parameters for rocksdb stats, you need to ensure that you have access to rocksdb
stats, otherwise an error will be reported.
Once you connect to NebulaGraph for the first time, you must first register your Storage service in order to properly
query your data.
**There is help_doc: [https://docs.nebula-graph.com.cn/3.4.3/4.deployment-and-installation/connect-to-nebula-graph/](https://docs.nebula-graph.com.cn/3.4.3/4.deployment-and-installation/connect-to-nebula-graph/)**
**[https://docs.nebula-graph.com.cn/3.4.3/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts/](https://docs.nebula-graph.com.cn/3.4.3/2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts/)**
The default port is 19779 and the access address is:[http://ip:19779/rocksdb_stats](http://ip:19779/rocksdb_stats)
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| graphPort | Port of the Graph service provided by Nebula Graph |
| timePeriod | The value can be 5 seconds, 60 seconds, 600 seconds, or 3600 seconds, indicating the last 5 seconds, last 1 minute, last 10 minutes, and last 1 hour, respectively. |
| storagePort | Port of the storage service provided by Nebula Graph |
| Timeout | Allow collection response time |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metrics
#### Metrics Set：nebulaGraph_stats
Too many indicators, related links are as follows
**[https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/](https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/1.query-performance-metrics/)**
| Metric name | Metric unit | Metric help description |
|---------------------------------------|-------------|--------------------------------------------------------------|
| num_queries_hit_memory_watermark_rate | | The rate of statements that reached the memory watermark. |
| num_queries_hit_memory_watermark_sum | | The sum of statements that reached the memory watermark. |
| num_reclaimed_expired_sessions_sum | | Number of expired sessions actively reclaimed by the server. |
| ... | | ... |
#### Metrics Set：rocksdb_stats
Too many indicators, related links are as follows
**[https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/](https://docs.nebula-graph.com.cn/3.4.3/6.monitor-and-metrics/2.rocksdb-statistics/)**
| Metric name | Metric unit | Metric help description |
|----------------------------|-------------|-------------------------------------------------------------|
| rocksdb.backup.read.bytes | | Number of bytes read during the RocksDB database backup. |
| rocksdb.backup.write.bytes | | Number of bytes written during the RocksDB database backup. |
| ... | | ... |
home/versioned_docs/version-1.6.x/help/nebulagraph_cluster.md
+91
View File
@@ -0,0 +1,91 @@
---
id: nebulagraph_cluster
title: Monitoring NebulaGraph Cluster
sidebar_label: NebulaGraph Cluster
keywords: [ Open Source Monitoring System, Open Source Database Monitoring, Open Source Graph Database Monitoring, NebulaGraph Cluster Monitoring ]
---
> Monitor basic information, nodes, tasks, etc., of the NebulaGraph cluster.
**Protocol Use：ngql**
## Configuration parameters
| Parameter Name | Parameter help description |
|---------------------|--------------------------------------------------------------------------------------------------------------------|
| Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note ⚠️ without the protocol header (eg: https://, http://). |
| Task Name | Identifies the name of this monitor, ensuring uniqueness of the name. |
| Graph Port | The port where the graph service is open, default is 9669. |
| Connection Timeout | Timeout for connecting to the graph service, in milliseconds, default is 6000 milliseconds. |
| Username | Database connection username. |
| Password | Database connection password. |
| Collection Interval | Interval for periodically collecting data, in seconds. The minimum interval that can be set is 30 seconds. |
| Bind Labels | Used to categorize and manage monitored resources. |
| Description | Additional information for identifying and describing this monitor. Users can add remarks here. |
### Collection Metric
#### Metric Set: Base info
| Metric Name | Metric Unit | Metric help description |
|--------------|-------------|-------------------------|
| responseTime | None | Response time |
| charset | None | Character set |
| collation | None | Character set collation |
#### Metric Set: Session
| Metric Name | Metric Unit | Metric help description |
|---------------------|-------------|----------------------------------|
| session | None | Number of sessions |
| running_query_count | None | Number of queries being executed |
#### Metric Set: Jobs
| Metric Name | Metric Unit | Metric help description |
|--------------|-------------|-------------------------------------------|
| queue_jobs | None | Number of pending background tasks |
| running_jobs | None | Number of background tasks being executed |
#### Metric Set: Cluster node info
| Metric Name | Metric Unit | Metric help description |
|----------------------|-------------|---------------------------------|
| total_storage_node | None | Number of storage nodes |
| offline_storage_node | None | Number of offline storage nodes |
| total_meta_node | None | Number of meta nodes |
| offline_meta_node | None | Number of offline meta nodes |
| total_graph_node | None | Number of graph nodes |
| offline_graph_node | None | Number of offline graph nodes |
#### Metric Set: Storage Nodes
| Metric Name | Metric Unit | Metric help description |
|-----------------------|-------------|-------------------------------------------------------|
| host | None | Node address |
| port | None | Port |
| status | None | Status (ONLINE/OFFLINE) |
| leaderCount | None | Number of leader partitions on the current node |
| leaderDistribution | None | Distribution of leader partitions on the current node |
| partitionDistribution | None | Distribution of partitions on the current node |
| version | None | Version |
#### Metric Set: Meta Nodes
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| host | None | Node address |
| port | None | Port |
| status | None | Status (ONLINE/OFFLINE) |
| version | None | Version |
#### Metric Set: Graph Nodes
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| host | None | Node address |
| port | None | Port |
| status | None | Status (ONLINE/OFFLINE) |
| version | None | Version |
> If you need to customize monitoring templates to collect data from NebulaGraph clusters, please refer to: [NGQL Custom Monitoring](../advanced/extend-ngql.md)
home/versioned_docs/version-1.6.x/help/nginx.md
+156
View File
@@ -0,0 +1,156 @@
---
id: nginx
title: Monitoring Nginx
sidebar_label: Nginx Monitor
keywords: [open source monitoring tool, open source java monitoring tool, monitoring nginx metrics]
---
> Collect and monitor the general performance Metrics of Nginx.
**Protocol Use：Nginx**
## Need Enable `ngx_http_stub_status_module` And `ngx_http_reqstat_module` Module
If you want to monitor information in 'Nginx' with this monitoring type, you need to modify your nginx configure file for enable the module monitor.
### Enable `ngx_http_stub_status_module`
1. Check if `ngx_http_stub_status_module` has been added
```shell
nginx -V
```
View whether it contains `--with-http_stub_status_module`, if not, you need to recompile and install Nginx.
2. Compile and install Nginx, add `ngx_http_stub_status_module` module
Download Nginx and unzip it, execute the following command in the directory
```shell
./configure --prefix=/usr/local/nginx --with-http_stub_status_module
make && make install
```
3. Modify Nginx configure file
Modify the `nginx.conf` file and add the monitoring module exposed endpoint, as follows:
```shell
# modify nginx.conf
server {
listen 80; # port
server_name localhost;
location /nginx-status {
stub_status on;
access_log on;
#allow 127.0.0.1; #only allow requests from localhost
#deny all; #deny all other hosts
}
}
```
4. Reload Nginx
```shell
nginx -s reload
```
5. Access `http://localhost/nginx-status` in the browser to view the Nginx monitoring status information.
### Enable `ngx_http_reqstat_module`
1. Install `ngx_http_reqstat_module`
```shell
# install `ngx_http_reqstat_module`
wget https://github.com/zls0424/ngx_req_status/archive/master.zip -O ngx_req_status.zip
unzip ngx_req_status.zip
patch -p1 < ../ngx_req_status-master/write_filter.patch
./configure --prefix=/usr/local/nginx --add-module=/path/to/ngx_req_status-master
make -j2
make install
```
2. Modify Nginx configure file
update `nginx.conf` file, add status module exposed endpoint, as follows:
```shell
# modify nginx.conf
http {
req_status_zone server_name $server_name 256k;
req_status_zone server_addr $server_addr 256k;
req_status server_name server_addr;
server {
location /req-status {
req_status_show on;
#allow 127.0.0.1; #only allow requests from localhost
#deny all; #deny all other hosts
}
}
}
```
3. Reload Nginx
```shell
nginx -s reload
```
4. Access `http://localhost/req-status` in the browser to view the Nginx monitoring status information.
**Refer Doc: [https://github.com/zls0424/ngx_req_status](https://github.com/zls0424/ngx_req_status)**
**⚠️Attention: The endpoint path of the monitoring module is `/nginx-status` `/req-status`**
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by Nginx |
| Timeout | Allow collection response time |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metrics
#### Metrics Set：nginx_status
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-----------------------------------------|
| accepts | | Accepted connections |
| handled | | Successfully processed connections |
| active | | Currently active connections |
| dropped | | Discarded connections |
| requests | | Client requests |
| reading | | Connections performing read operations |
| writing | | Connections performing write operations |
| waiting | | Waiting connections |
#### Metrics Set：req_status
| Metric name | Metric unit | Metric help description |
|-------------|-------------|--------------------------------|
| zone_name | | Group category |
| key | | Group name |
| max_active | | Maximum concurrent connections |
| max_bw | kb | Maximum bandwidth |
| traffic | kb | Total traffic |
| requests | | Total requests |
| active | | Current concurrent connections |
| bandwidth | kb | Current bandwidth |
home/versioned_docs/version-1.6.x/help/ntp.md
+37
View File
@@ -0,0 +1,37 @@
---
id: ntp
title: Monitoring NTP
sidebar_label: NTP Monitor
keywords: [ open source monitoring tool, open source NTP monitoring tool, monitoring NTP metrics ]
---
> Collect and monitor the general performance Metrics of NTP.
**Protocol Use：NTP**
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metrics
#### Metrics Set：summary
| Metric name | Metric unit | Metric help description |
|--------------|-------------|------------------------------------------------------------------------------------------|
| responseTime | ms | The time it takes for the NTP server to respond to a request). |
| time | ms | The current time reported by the NTP server). |
| date | | The date corresponding to the current time reported by the NTP server). |
| offset | ms | The time difference between the NTP server's clock and the client's clock). |
| delay | ms | The time it takes for a request to reach the NTP server and for the response to return). |
| version | | The version number of the NTP protocol used by the server). |
| mode | | The operating mode of the NTP server, such as client, server, or broadcast). |
| stratum | | The stratumevel of the NTP server, indicating its distance from a reference clock). |
| referenceId | | An identifier that indicates the reference clock or time source used by the NTP server). |
| precision | | The precision of the NTP server's clock, indicating its accuracy). |
home/versioned_docs/version-1.6.x/help/nvidia.md
+37
View File
@@ -0,0 +1,37 @@
---
id: nvidia
title: NVIDIA Monitoring
sidebar_label: NVIDIA Monitoring
keywords: [Open Source Monitoring System, NVIDIA Monitoring]
---
> Collect and monitor general performance metrics of NVIDIA operating systems.
> NVIDIA monitoring requires the nvidia-smi command, which is installed together with the NVIDIA GPU driver. So when monitoring NVIDIA, we need to install the NVIDIA GPU driver.
## Configuration Parameters
| Parameter Name | Description |
|------------------|-------------------------------------------------------------|
| Monitoring Host | The IP address (IPv4/IPv6) or domain name of the monitored endpoint. Note ⚠️ do not include protocol headers (e.g., https://, http://). |
| Task Name | The name identifying this monitoring task, which needs to be unique. |
| Port | The port exposed for Linux SSH, default is 22. |
| Username | SSH connection username, optional. |
| Password | SSH connection password, optional. |
| Collection Interval | Interval for periodically collecting monitoring data, in seconds. The minimum interval is 30 seconds. |
| Probe Before Monitoring | Whether to probe the monitoring endpoint to check its availability before adding it. Monitoring is added or modified only if the probe succeeds. |
| Description/Remarks | Additional notes and descriptions for this monitoring task. Users can add relevant information here. |
### Collected Metrics
#### Metric Set: basic
| Metric Name | Unit | Description |
|------------------------|--------|------------------|
| index | None | GPU index |
| name | None | GPU name |
| utilization.gpu[%] | None | GPU utilization |
| utilization.memory[%] | None | Memory utilization |
| memory.total[MiB] | MiB | Total memory |
| memory.used[MiB] | MiB | Used memory |
| memory.free[MiB] | MiB | Free memory |
| temperature.gpu | None | GPU temperature |
home/versioned_docs/version-1.6.x/help/oceanbase.md
+59
View File
@@ -0,0 +1,59 @@
---
id: oceanbase
title: Monitoring：OceanBase database monitoring
sidebar_label: OceanBase database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring oceanbase database metrics]
---
> Collect and monitor the general performance Metrics of OceanBase database. Support OceanBase 4.0+.
## Attention, Need Add MYSQL jdbc driver jar
- Download the MYSQL jdbc driver jar package, such as mysql-connector-java-8.1.0.jar. [https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0](https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0)
- Copy the jar package to the `hertzbeat/ext-lib` directory.
- Restart the HertzBeat service.
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by the database. The default is 2881 |
| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 6000ms |
| Database name | Database instance name, optional |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|------------------------------------|
| version | none | Database version |
| port | none | Database exposure service port |
| datadir | none | Database storage data disk address |
| max_connections | none | Database maximum connections |
#### Metric set：status
| Metric name | Metric unit | Metric help description |
|-------------------|-------------|----------------------------------|
| threads_created | none | OceanBase created total connections |
| threads_connected | none | OceanBase connected connections |
| threads_cached | none | OceanBase current cached connections |
| threads_running | none | OceanBase current active connections |
#### Metric set：innodb
| Metric name | Metric unit | Metric help description |
|---------------------|-------------|------------------------------------------------------|
| innodb_data_reads | none | innodb average number of reads from files per second |
| innodb_data_writes | none | innodb average number of writes from file per second |
| innodb_data_read | KB | innodb average amount of data read per second |
| innodb_data_written | KB | innodb average amount of data written per second |
home/versioned_docs/version-1.6.x/help/openai.md
+83
View File
@@ -0,0 +1,83 @@
---
id: openai
title: Monitoring OpenAI Account Status
sidebar_label: OpenAI Account Status
keywords: [open source monitoring system, open source network monitoring, OpenAI account monitoring]
---
## Preparation
### Obtain Session Key
>
> 1. Open Chrome browser's network request interface
> `Mac: cmd + option + i`
> `Windows: ctrl + shift + i`
> 2. Visit [https://platform.openai.com/usage](https://platform.openai.com/usage)
> 3. Find the request to [https://api.openai.com/dashboard/billing/usage](https://api.openai.com/dashboard/billing/usage)
> 4. Find the Authorization field in the request headers, and copy the content after `Bearer`. For example: `sess-123456`
### Notes
> 1. Please ensure that HertzBeat has external network access capability. If unsure, you can try detecting by creating HTTP API monitoring for openai.com in HertzBeat.
> 2. The monitoring period should be at least greater than 120 seconds to avoid sending requests too frequently, resulting in return status code 429 (Too Many Requests).
### Configuration Parameters
| Parameter Name | Parameter Description |
|:------------------|------------------------------------------------------------------------------------------------|
| Monitoring Host | Fill in api.openai.com here. |
| Task Name | Identify the name of this monitoring, ensuring uniqueness. |
| Session Key | The session key obtained in the preparation step. |
| Collector | Configure which collector to use for scheduling collection for this monitoring. |
| Monitoring Period | Interval time for periodic data collection, in seconds, with a minimum interval of 30 seconds. |
| Bound Tags | Tags for managing classification of monitoring resources. |
| Description | Additional identification and description for this monitoring, users can leave remarks here. |
### Collection Metrics
#### Metric Set: Credit Grants
| Metric Name | Metric Unit | Metric Description |
|----------------------|-------------|--------------------------------------|
| Total Granted | USD ($) | Total granted credit limit |
| Total Used | USD ($) | Total used credit limit |
| Total Available | USD ($) | Total available credit limit |
| Total Paid Available | USD ($) | Total payable available credit limit |
#### Metric Set: Model Cost
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|------------------------|
| Model Name | None | Name of the model |
| Cost | USD ($) | Expenses for the model |
#### Metric Set: Billing Subscription
| Metric Name | Metric Unit | Metric Description |
|--------------------------|-------------|-----------------------------------------|
| Has Payment Method | None | Whether payment method is available |
| Canceled | None | Whether subscription is cancelled |
| Canceled At | None | Time of subscription cancellation |
| Delinquent | None | Whether subscription is overdue |
| Soft Limit | Times | Maximum usage limit in a certain period |
| Hard Limit | Times | Maximum usage limit |
| System Hard Limit | Times | System hard limit usage |
| Soft Limit USD | USD ($) | Soft limit charge |
| Hard Limit USD | USD ($) | Hard limit charge |
| System Hard Limit USD | USD ($) | System hard limit charge |
| Plan | None | Subscription plan |
| Primary | None | Whether it's a primary subscription |
| Billing Mechanism | None | Settlement mechanism |
| Is Arrears Eligible | None | Whether eligible for overdue |
| Max Balance | USD ($) | Maximum balance |
| Auto Recharge Eligible | None | Whether eligible for auto recharge |
| Auto Recharge Enabled | None | Whether auto recharge is enabled |
| Auto Recharge Threshold | USD ($) | Auto recharge threshold |
| Auto Recharge To Balance | USD ($) | Auto recharge amount |
| Trust Tier | None | Credit level |
| Account Name | None | Account name |
| Po Number | None | Purchase order |
| Billing Email | None | Billing email |
| Tax IDs | None | Tax IDs |
| Billing Address | None | Billing address |
| Business Address | None | Business address |
home/versioned_docs/version-1.6.x/help/opengauss.md
+55
View File
@@ -0,0 +1,55 @@
---
id: opengauss
title: OpenGauss Database Monitor
sidebar_label: OpenGauss Database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring opengauss database metrics]
---
> Collect and monitor the general performance Metrics of OpenGauss database.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by the database. The default is 5432 |
| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms |
| Database name | Database instance name, optional |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|-------------------------------------------|
| server_version | none | Version number of the database server |
| port | none | Database server exposure service port |
| server_encoding | none | Character set encoding of database server |
| data_directory | none | Database storage data disk address |
| max_connections | connections | Database maximum connections |
#### Metric set：state
| Metric name | Metric unit | Metric help description |
|----------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | none | Database name, or share-object is a shared object |
| conflicts | times | The number of queries canceled in the database due to a conflict with recovery |
| deadlocks | number | Number of deadlocks detected in the database |
| blks_read | times | The number of disk blocks read in the database |
| blks_hit | times | Times the disk block has been found to be in the buffer, so there is no need to read it once (This only includes hits in the PostgreSQL buffer, not in the operating system file system buffer) |
| blk_read_time | ms | Time spent by the backend reading data file blocks in the database |
| blk_write_time | ms | Time spent by the backend writing data file blocks in the database |
| stats_reset | none | The last time these statistics were reset |
#### Metric set：activity
| Metric name | Metric unit | Metric help description |
|-------------|-------------|--------------------------------------|
| running | connections | Number of current client connections |
home/versioned_docs/version-1.6.x/help/opensuse.md
+107
View File
@@ -0,0 +1,107 @@
---
id: opensuse
title: Monitoring OpenSUSE Operating System Monitoring
sidebar_label: OpenSUSE OS
keywords: [open source monitoring system, open source operating system monitoring, OpenSUSE OS monitoring]
---
> Collect and monitor general performance metrics of the OpenSUSE operating system.
## Configuration Parameters
| Parameter Name | Parameter Help Description |
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| Monitored Host | The IPV4, IPV6, or domain name of the host being monitored. Note ⚠️ No protocol header (e.g., https://, http://). |
| Task Name | The name that identifies this monitoring, which must be unique. |
| Port | The port provided by Linux SSH, default is 22. |
| Timeout | Sets the connection timeout in milliseconds, default is 6000 ms. |
| Connection Reuse | Sets whether SSH connections are reused, default is :false. If false, a new connection is created each time information is retrieved. |
| Username | SSH connection username, optional. |
| Password | SSH connection password, optional. |
| Collector | Configures which collector is used to schedule data collection for this monitoring. |
| Monitoring Period | The interval time for periodic data collection in seconds, with a minimum interval of 30 seconds. |
| Binding Tags | Used for categorized management of monitoring resources. |
| Description | Additional notes and descriptions for this monitoring, where users can make notes. |
| Key | The key required to connect to the server. |
### Collection Metrics
#### Metric Set: System Basic Information
| Metric Name | Unit | Metric Help Description |
|----------------|------|--------------------------|
| Host Name | None | Host name |
| System Version | None | Operating system version |
| Uptime | None | Uptime |
#### Metric Set: CPU Information
| Metric Name | Unit | Metric Help Description |
|----------------|-------|-----------------------------------------------|
| info | None | CPU model |
| cores | Cores | Number of CPU cores |
| interrupt | Count | Number of CPU interrupts |
| load | None | Average CPU load over the last 1/5/15 minutes |
| context_switch | Count | Number of context switches |
| usage | % | CPU usage rate |
#### Metric Set: Memory Information
| Metric Name | Unit | Metric Help Description |
|-------------|------|-------------------------------------|
| total | Mb | Total memory capacity |
| used | Mb | Memory used by user programs |
| free | Mb | Free memory capacity |
| buff_cache | Mb | Memory used for cache |
| available | Mb | Remaining available memory capacity |
| usage | % | Memory usage rate |
#### Metric Set: Disk Information
| Metric Name | Unit | Metric Help Description |
|---------------|-------|----------------------------------------|
| disk_num | Count | Total number of disks |
| partition_num | Count | Total number of partitions |
| block_write | Count | Total number of blocks written to disk |
| block_read | Count | Total number of blocks read from disk |
| write_rate | iops | Disk block write rate per second |
#### Metric Set: Network Card Information
| Metric Name | Unit | Metric Help Description |
|----------------|------|-------------------------|
| interface_name | None | Network card name |
| receive_bytes | Mb | Inbound data traffic |
| transmit_bytes | Mb | Outbound data traffic |
#### Metric Set: File System
| Metric Name | Unit | Metric Help Description |
|-------------|------|-------------------------|
| filesystem | None | Name of the file system |
| used | Mb | Used disk size |
| available | Mb | Available disk size |
| usage | % | Usage rate |
| mounted | None | Mount point directory |
#### Metric Set: Top 10 CPU Processes
Statistics for the top 10 processes using the CPU. Statistics include: Process ID, CPU usage, memory usage, executed command.
| Metric Name | Unit | Metric Help Description |
|-------------|------|-------------------------|
| pid | None | Process ID |
| cpu_usage | % | CPU usage rate |
| mem_usage | % | Memory usage rate |
| command | None | Executed command |
#### Metric Set: Top 10 Memory Processes
Statistics for the top 10 processes using memory. Statistics include: Process ID, memory usage, CPU usage, executed command.
| Metric Name | Unit | Metric Help Description |
|-------------|------|-------------------------|
| pid | None | Process ID |
| mem_usage | % | Memory usage rate |
| cpu_usage | % | CPU usage rate |
| command | None | Executed command |
home/versioned_docs/version-1.6.x/help/oracle.md
+69
View File
@@ -0,0 +1,69 @@
---
id: oracle
title: Monitoring：ORACLE database monitoring
sidebar_label: ORACLE database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring oracle database metrics]
---
> Collect and monitor the general performance Metrics of ORACLE database.
## Attention, Need Add ORACLE jdbc driver jar
- Download the ORACLE jdbc driver jar package, such as [ojdbc8.jar](https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc8/23.4.0.24.05/ojdbc8-23.4.0.24.05.jar) [oracle-i18n](https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar)
- Copy the jar package to the `hertzbeat/ext-lib` directory.
- Restart the HertzBeat service.
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by the database. The default is 1521 |
| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms |
| Database name | Database instance name, optional |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|------------------|-------------|-------------------------|
| database_version | none | Database version |
| database_type | none | Database type |
| hostname | none | Host name |
| instance_name | none | Database instance name |
| startup_time | none | Database start time |
| status | none | Database status |
#### Metric set：tablespace
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|-------------------------|
| file_id | none | File ID |
| file_name | none | File name |
| tablespace_name | none | Table space name |
| status | none | Status |
| bytes | MB | Size |
| blocks | none | Number of blocks |
#### Metric set：user_connect
| Metric name | Metric unit | Metric help description |
|-------------|-------------|---------------------------|
| username | none | Username |
| counts | number | Current connection counts |
#### Metric set：performance
| Metric name | Metric unit | Metric help description |
|-------------|-------------|-----------------------------|
| qps | QPS | I/O Requests per second |
| tps | TPS | User transaction per second |
| mbps | MBPS | I/O Megabytes per second |
home/versioned_docs/version-1.6.x/help/ping.md
+36
View File
@@ -0,0 +1,36 @@
---
id: ping
title: Monitoring：PING connectivity
sidebar_label: PING connectivity
keywords: [open source monitoring tool, open source network monitoring tool, monitoring ping metrics]
---
> Ping the opposite end HOST address and judge its connectivity.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Ping timeout | Set the timeout when Ping does not respond to data, unit:ms, default: 3000ms |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：summary
| Metric name | Metric unit | Metric help description |
|--------------|-------------|-------------------------|
| responseTime | ms | Website response time |
### Common Problem
1. Ping connectivity monitoring exception when installing hertzbeat for package deployment.
The hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。
> The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened.
> When you install HertzBeat via DockerDocker root is enabled by default. No such problem.
> See [https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address](https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address)
home/versioned_docs/version-1.6.x/help/plugin.md
+111
View File
@@ -0,0 +1,111 @@
---
id: plugin
title: Custom plugin(Beta)
sidebar_label: Custom plugin(Beta)
---
## Introduction
In the current usage of `HertzBeat`, interaction with external systems only occurs after an alert through the notification feature. The plugin functionality allows users to add custom operations at various stages of the `HertzBeat` lifecycle, such as executing `SQL` or `shell` scripts after an alert, or sending collected monitoring data to other systems. Users can develop plugins following the custom plugin development process, package them, and then upload and enable them using the `Plugin Management` - `Upload Plugin` feature, thereby adding custom functionality without restarting `HertzBeat`.
:::warning
In the current version, custom plugins are a test feature and may have some limitations and instability. The plugin functionality might be restructured in future versions.
:::
### Supported Plugin Types
1. `Post-Alert` Plugin
- Purpose: Execute custom operations after an alert
- Implementing Interface: `org.apache.hertzbeat.plugin.PostAlertPlugin`
2. `Post-Collect` Plugin
- Purpose: Execute custom operations after data collection
- Implementing Interface: `org.apache.hertzbeat.plugin.PostCollectPlugin`
:::tip
To ensure that plugin functionality is clear and easy to manage, we recommend and only support one implementation of one plugin type interface in a plugin.
:::
If you want to set trigger methods during collection, program startup, etc., please submit a `Task` at `https://github.com/apache/hertzbeat/issues/new/choose`.
### Development Steps (Example: Implementing a Post-Alert Plugin)
1. Clone the main branch code `git clone https://github.com/apache/hertzbeat.git`, and locate the `Plugin` interface in the `plugin` module.
![plugin-1.png](/img/docs/help/plugin-1.png)
2. In the `org.apache.hertzbeat.plugin.impl` directory (create it if it does not exist), create an implementation class of `org.apache.hertzbeat.plugin.PostAlertPlugin`, such as `org.apache.hertzbeat.plugin.impl.DemoPlugin`. In the implementation class, receive the `Alert` class as a parameter, implement the `execute` method, and define custom logic. Here, we simply print the object.
```java
package org.apache.hertzbeat.plugin.impl;
import org.apache.hertzbeat.common.entity.alerter.Alert;
import org.apache.hertzbeat.common.entity.plugin.PluginContext;
import org.apache.hertzbeat.plugin.PostAlertPlugin;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class DemoPlugin implements PostAlertPlugin {
private static final Logger log = LoggerFactory.getLogger(DemoPlugin.class);
@Override
public void execute(Alert alert, PluginContext pluginContext) {
log.info("DemoPlugin alert: {}", alert);
log.info("DemoPlugin pluginContext: {}", pluginContext);
}
}
```
3. Add the fully qualified name of the implementation class to the `META-INF/services/org.apache.hertzbeat.plugin.PostAlertPlugin` file (create it if it does not exist). Each fully qualified name should be on a separate line.
```shell
org.apache.hertzbeat.plugin.impl.DemoPluginImpl
```
4. Package the `hertzbeat-plugin` module.
```shell
cd plugin
mvn package
```
5. Use the `Plugin Management` - `Upload Plugin` feature to upload the plugin package ending with `-jar-with-lib.jar`, and enable the plugin to execute custom operations after an alert.
### Defining Plugin Parameters
The plugin feature supports custom parameters, and you can fill in the required parameters for the plugin during runtime using the `Plugin Management` - `Edit Parameters` feature.
Below is an example of defining a plugin with two parameters, detailing the process of defining plugin parameters:
1. Add a parameter definition file in the `define` directory. Note that the parameter definition file must be a YAML file starting with `define`, such as `define-demo.yml`.
2. Define parameters in `define-demo.yml` as shown below:
```yaml
params:
- field: host
# name-param field display i18n name
name:
zh-CN: 目标 Host
en-US: Target Host
# type-param field type(most mapping the html input type)
type: text
# required-true or false
required: true
# field-param field key
- field: port
# name-param field display i18n name
name:
zh-CN: 端口
en-US: Port
# type-param field type(most mapping the html input type)
type: number
# when type is number, range is required
range: '[0,65535]'
```
3. Use the parameters in the plugin logic
```java
@Override
public void execute(Alert alert, PluginContext pluginContext) {
log.info("param host:{}",pluginContext.getString("host"));
log.info("param port:{}",pluginContext.getInteger("port"));
}
```
home/versioned_docs/version-1.6.x/help/pop3.md
+47
View File
@@ -0,0 +1,47 @@
---
id: pop3
title: Monitoring POP3
sidebar_label: POP3 Monitor
keywords: [open source monitoring tool, open source java monitoring tool, monitoring POP3 metrics]
---
> Collect and monitor the general performance Metrics of POP3.
**Protocol Use：POP3**
## Enable POP3 Service
If you want to monitor information in 'POP3' with this monitoring type, you just need to open `POP3` service in your mail server.
**1、Open `POP3` Service:**
```text
Using QQ Mail as an example [similar for other email services]:
1. Click the "Settings" option
2. Select "Account"
3. Find the option to enable SMTP/POP3/IMAP, and turn it on
4. Obtain the POP3 server domain name, port number, and authorization code [provided by QQ Mail after enabling SMTP/POP3/IMAP services]
5. Connect to the POP3 server using the POP3 server domain name, port number, QQ email account, and authorization code to collect monitoring metrics
```
### Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by POP3 |
| SSL | POP3 If enabled SSL |
| Timeout | Allow collection response time |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metrics
#### Metrics Set：email_status
| Metric name | Metric unit | Metric help description |
|--------------|-------------|-----------------------------------------|
| email_count | | Number of emails |
| mailbox_size | kb | The total size of emails in the mailbox |
home/versioned_docs/version-1.6.x/help/port.md
+28
View File
@@ -0,0 +1,28 @@
---
id: port
title: Monitoring：TCP port availability
sidebar_label: TCP Port availability
keywords: [open source monitoring tool, open source port monitoring tool, monitoring TCP port metrics]
---
> Judge whether the exposed port of the opposite end service is available, then judge whether the opposite end service is available, and collect Metrics such as response time for monitoring.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Ports provided by website, http generally defaults to 80 and https generally defaults to 443 |
| Connection timeout | Waiting timeout for port connection, unit:ms, default: 3000ms |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：summary
| Metric name | Metric unit | Metric help description |
|--------------|-------------|-------------------------|
| responseTime | ms | Website response time |
home/versioned_docs/version-1.6.x/help/postgresql.md
+55
View File
@@ -0,0 +1,55 @@
---
id: postgresql
title: Monitoring：PostgreSQL database monitoring
sidebar_label: PostgreSQL database
keywords: [open source monitoring tool, open source database monitoring tool, monitoring postgresql database metrics]
---
> Collect and monitor the general performance Metrics of PostgreSQL database. Support PostgreSQL 10+.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by the database. The default is 5432 |
| Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms |
| Database name | Database instance name, optional |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
| URL | Database connection URL，optional，If configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
### Collection Metric
#### Metric set：basic
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|-------------------------------------------|
| server_version | none | Version number of the database server |
| port | none | Database server exposure service port |
| server_encoding | none | Character set encoding of database server |
| data_directory | none | Database storage data disk address |
| max_connections | connections | Database maximum connections |
#### Metric set：state
| Metric name | Metric unit | Metric help description |
|----------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | none | Database name, or share-object is a shared object |
| conflicts | times | The number of queries canceled in the database due to a conflict with recovery |
| deadlocks | number | Number of deadlocks detected in the database |
| blks_read | times | The number of disk blocks read in the database |
| blks_hit | times | Times the disk block has been found to be in the buffer, so there is no need to read it once (This only includes hits in the PostgreSQL buffer, not in the operating system file system buffer) |
| blk_read_time | ms | Time spent by the backend reading data file blocks in the database |
| blk_write_time | ms | Time spent by the backend writing data file blocks in the database |
| stats_reset | none | The last time these statistics were reset |
#### Metric set：activity
| Metric name | Metric unit | Metric help description |
|-------------|-------------|--------------------------------------|
| running | connections | Number of current client connections |
home/versioned_docs/version-1.6.x/help/prestodb.md
+74
View File
@@ -0,0 +1,74 @@
---
id: presto
title: Monitoring PrestoDB Database
sidebar_label: PrestoDB Database
keywords: [ open source monitoring system, open source database monitoring, presto database monitoring]
---
> Collect and monitor general performance metrics of PrestoDB Atlas databases.
## Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| Target Host | The IP address, IPv4, IPv6, or domain name of the target to be monitored. Note: ⚠️ Do not include protocol headers (e.g., https://, http://). |
| port | Port |
| Task Name | The name identifying this monitor, which must be unique. |
| Connection Timeout | Timeout for PrestoDB connection when no response is received, in milliseconds (ms). Default is 6000 ms. |
| Collection Interval | Interval for periodic data collection, in seconds. The minimum interval is 30 seconds. |
| Binding Tags | Used for categorizing and managing monitoring resources. |
| Description/Remarks | Additional labels and description for this monitor; users can add notes here. |
### Collection Metrics
#### Metric Set: Cluster Status
| Metric Name | Unit | Metric Description |
|----------------|------|--------------------|
| activeWorkers | None | Active Workers |
| runningQueries | None | Running Queries |
| queuedQueries | None | Queued Queries |
| blockedQueries | None | Blocked Queries |
| runningDrivers | None | Running Drivers |
| runningTasks | None | Running Tasks |
### Metrics Collection: Node Information
| Metric Name | Unit | Metric Description |
|----------------------|------|----------------------------------------------------|
| `uri` | None | Node link |
| `recentRequests` | None | Number of requests in the recent period |
| `recentFailures` | None | Number of failed requests in the recent period |
| `recentSuccesses` | None | Number of successful requests in the recent period |
| `lastRequestTime` | None | Time of the most recent request |
| `lastResponseTime` | None | Time of the most recent response |
| `age` | None | Duration of operation |
| `recentFailureRatio` | None | Failure rate in the recent period |
#### Metric Set: Node Status
| Metric Name | Unit | Metric Description |
|-----------------|------|-----------------------|
| nodeId | None | Node ID |
| nodeVersion | None | Node Version |
| environment | None | Environment |
| coordinator | None | Is Coordinator |
| uptime | None | Uptime |
| externalAddress | None | External Address |
| internalAddress | None | Internal Address |
| processors | None | Processors |
| processCpuLoad | None | Process CPU Load |
| systemCpuLoad | None | System CPU Load |
| heapUsed | MB | Heap Memory Used |
| heapAvailable | MB | Heap Memory Available |
| nonHeapUsed | MB | Non-Heap Memory Used |
#### Metric Set: Task Query
| Metric Name | Unit | Metric Description |
|---------------|------|--------------------|
| taskId | None | Task ID |
| version | None | Version |
| state | None | State |
| self | None | Self |
| lastHeartbeat | None | Last Heartbeat |
home/versioned_docs/version-1.6.x/help/process.md
+87
View File
@@ -0,0 +1,87 @@
---
id: process
title: Monitoring Linux Process Monitoring
sidebar_label: Process
keywords: [Open Source Monitoring System, Operating System Process Monitoring, Process Monitoring]
---
> Collect and monitor basic information of processes on Linux systems, including CPU usage, memory usage, physical memory, IO, etc.
## Configuration Parameters
| Parameter Name | Parameter Description |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------|
| Target Host | The IPv4, IPv6, or domain name of the monitored endpoint. Note ⚠️: Do not include the protocol header (e.g., https://, http://). |
| Task Name | Identifies the name of this monitoring, ensuring uniqueness. |
| Port | SSH port of the Linux system, default: 22 |
| Timeout | Sets the timeout for the connection in milliseconds, default is 6000 milliseconds. |
| Reuse Connection | Sets whether SSH connection is reused, default is false. When false, a new connection is created for each information retrieval. |
| Username | Username for the server. |
| Password | Password for the server. |
| Process Name | Name or part of the name of the process to be monitored. |
| Collector | Specifies which collector to use for scheduling this monitoring. |
| Monitoring Interval | Interval for periodic data collection, in seconds. Minimum interval that can be set is 30 seconds. |
| Tags | Used for categorizing and managing monitoring resources. |
| Description | Additional notes and descriptions for identifying this monitoring. Users can add remarks here. |
| Private Key | Private key required for connecting to the server. |
### Metrics Collected
#### Metric Set: Process Basic Information
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|--------------------|
| PID | NONE | Process ID |
| User | NONE | User |
| CPU | NONE | CPU Usage |
| MEM | NONE | Memory Usage |
| rss | NONE | Physical Memory |
| cmd | NONE | Command |
#### Metric Set: Memory Usage Information
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|--------------------|
| PID | NONE | Process ID |
| detail | NONE | Detailed metrics |
Includes metrics for:
- Peak Virtual Memory
- Current Virtual Memory Usage
- Locked Memory
- Fixed Memory
- Peak Physical Memory
- Current Physical Memory Usage
- Data Segment Size
- Stack Size
- Code Size
- Shared Library Size
- Page Table Entry Size
#### Metric Set: Other Monitoring Information
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|-----------------------------------|
| PID | NONE | Process ID |
| path | NONE | Execution Path |
| date | NONE | Start Time |
| fd_count | NONE | Number of File Descriptors Opened |
#### Metric Set: IO
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|--------------------|
| PID | NONE | Process ID |
| metric | NONE | Metric Name |
| value | NONE | Metric Value |
Includes metrics for:
- rchar (Total bytes read by the process from disk or other files)
- wchar (Total bytes written by the process to disk or other files)
- syscr (Number of read operations initiated by the process)
- syscw (Number of write operations initiated by the process)
- read_bytes (Actual number of bytes read by the process from disk)
- write_bytes (Actual number of bytes written by the process to disk)
- cancelled_write_bytes (Actual number of bytes cancelled by the process while writing to disk)
home/versioned_docs/version-1.6.x/help/prometheus.md
Executable
+41
View File
@@ -0,0 +1,41 @@
---
id: prometheus
title: Monitoring Prometheus Task
sidebar_label: Prometheus Task Monitor
keywords: [ open source monitoring tool, Prometheus protocol monitoring ]
---
> Collect metric data of applications that support the Prometheus protocol.
## Configuration parameter
| Parameter name | Parameter help description |
|---------------------|--------------------------------------------------------------------------------------------------------------------------|
| Target Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Task Name | Identify the name of this monitoring. The name needs to be unique. |
| Port | Monitor HTTP port. |
| Endpoint Path | Monitor the path of HTTP interfaces, Note ⚠️ It needs to start with /. |
| Query Timeout | Set the data collection timeout, unit: ms, default: 6000ms. |
| HTTPS | HTTPS enable,optional,default:false. |
| Headers | HTTP request headers,optional. |
| Params | Request params,optional. |
| Content-Type | ContentType,optional. |
| BODY | Request body,optional. |
| Auth Type | Authentication methods, optional values include: `Basic Auth`, `Digest Auth`,optional. |
| Username | Username,optional. |
| Password | Password,optional. |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. |
| Bind Tags | Used to classify and manage monitoring resources. |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here. |
### Example of usage
The exposed monitoring address of the application is: `http://127.0.0.1:8080/actuator/prometheus`
You can use the following configuration:
- Target Host: `127.0.0.1`
- Port: `8080`
- Endpoint Path: `/actuator/prometheus`
Keep the rest of the settings default.
home/versioned_docs/version-1.6.x/help/pulsar.md
+72
View File
@@ -0,0 +1,72 @@
---
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_total
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_bucket
Latency of metadata store operations on the broker side.
home/versioned_docs/version-1.6.x/help/rabbitmq.md
+125
View File
@@ -0,0 +1,125 @@
---
id: rabbitmq
title: Monitoring RabbitMQ
sidebar_label: RabbitMQ Monitor
keywords: [open source monitoring tool, open source rabbitmq monitoring tool, monitoring rabbitmq metrics]
---
> Monitoring the running status of RabbitMQ message middleware, nodes, topics and other related metrics.
## Pre-monitoring Operations
>
> HertzBeat uses RabbitMQ Management's Rest Api to collect RabbitMQ metric data.
> Therefore, you need to enable the Management plug-in in your RabbitMQ environment
1. Open the Management plugin, or use the self-opening version
```shell
rabbitmq-plugins enable rabbitmq_management
```
2. Access [http://ip:15672/](http://ip:15672/) with a browser, and the default account password is `guest/guest`. Successful login means that it is successfully opened.
3. Just add the corresponding RabbitMQ monitoring in HertzBeat, the parameters use the IP port of Management, and the default account password.
### Configuration parameters
| Parameter name | Parameter help description |
|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | The peer IPV4, IPV6 or domain name to be monitored. Note ⚠️Without protocol header (eg: https://, http://). |
| Monitoring name | The name that identifies this monitoring, and the name needs to be unique. |
| Port | The HTTP port provided by RabbitMQ Management, the default is 15672. |
| Username | Username used for interface Basic authentication |
| Password | The password used for interface Basic authentication |
| Timeout | HTTP request query timeout |
| Acquisition Interval | Interval time for monitoring periodic data collection, in seconds, the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring, and the operation of adding and modifying will continue after the detection is successful |
| Description Remarks | More remark information to identify and describe this monitoring, users can remark information here |
### Collect Metrics
#### metrics: overview
| Metric Name | Metric Unit | Metric Description |
|--------------------|-------------|------------------------------------|
| product_version | None | Product Version |
| product_name | None | Product name |
| rabbitmq_version | none | rabbitmq version |
| management_version | None | rabbitmq management plugin version |
| erlang_version | None | erlang version |
| cluster_name | None | Cluster name |
| rates_mode | None | rates mode |
#### metrics: object_totals
| Metric Name | Metric Unit | Metric Description |
|-------------|-------------|-----------------------------|
| channels | none | total number of channels |
| connections | none | total number of connections |
| consumers | none | total number of consumers |
| exchanges | none | total number of exchanges |
| queues | none | total number of queues |
#### metrics: nodes
| Metric Name | Metric Unit | Metric Description |
|--------------------|-------------|-----------------------------------------------------------|
| name | None | The node name |
| type | None | The node type |
| running | None | Running state |
| os_pid | None | Pid in OS |
| mem_limit | MB | Memory usage high watermark |
| mem_used | MB | Total amount of memory used |
| fd_total | None | File descriptors available |
| fd_used | None | File descriptors used |
| sockets_total | None | Sockets available |
| sockets_used | None | Sockets used |
| proc_total | None | Erlang process limit |
| proc_used | None | Erlang processes used |
| disk_free_limit | GB | Free disk space low watermark |
| disk_free | GB | Free disk space |
| gc_num | None | GC runs |
| gc_bytes_reclaimed | MB | Bytes reclaimed by GC |
| context_switches | None | Context_switches num |
| io_read_count | None | Total number of read operations |
| io_read_bytes | KB | Total data size read into disk |
| io_read_avg_time | ms | Average read operation time in milliseconds |
| io_write_count | None | Total disk write operations |
| io_write_bytes | KB | Total amount of data written to disk |
| io_write_avg_time | ms | Average time of each disk write operation in milliseconds |
| io_seek_count | None | total seek operation |
| io_seek_avg_time | ms | average seek operation time, in milliseconds |
| io_sync_count | None | total amount of fsync operations |
| io_sync_avg_time | ms | Average time of fsync operation in milliseconds |
| connection_created | None | connection created num |
| connection_closed | None | connection closed num |
| channel_created | None | channel created num |
| channel_closed | None | channel closed num |
| queue_declared | None | queue declared num |
| queue_created | None | queue created num |
| queue_deleted | None | queue deleted num |
| connection_closed | None | connection closed num |
#### metrics: queues
| Metric Name | Metric Unit | Metric Description |
|------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------|
| name | None | The name of the queue with non-ASCII characters escaped as in C. |
| node | None | The queue on the node name |
| state | None | The state of the queue. Normally "running", but may be `{syncing, message_count}` if the queue is synchronising. |
| type | None | Queue type, one of: quorum, stream, classic. |
| vhost | None | vhost path |
| auto_delete | None | Whether the queue will be deleted automatically when no longer used |
| policy | None | Effective policy name for the queue. |
| consumers | None | Number of consumers. |
| memory | B | Bytes of memory allocated by the runtime for the queue, including stack, heap and internal structures. |
| messages_ready | None | Number of messages ready to be delivered to clients |
| messages_unacknowledged | None | Number of messages delivered to clients but not yet acknowledged |
| messages | None | Sum of ready and unacknowledged messages (queue depth) |
| messages_ready_ram | None | Number of messages from messages_ready which are resident in ram |
| messages_persistent | None | Total number of persistent messages in the queue (will always be 0 for transient queues) |
| message_bytes | B | Sum of the size of all message bodies in the queue. This does not include the message properties (including headers) or any overhead |
| message_bytes_ready | B | Like message_bytes but counting only those messages ready to be delivered to clients |
| message_bytes_unacknowledged | B | Like message_bytes but counting only those messages delivered to clients but not yet acknowledged |
| message_bytes_ram | B | Like message_bytes but counting only those messages which are currently held in RAM |
| message_bytes_persistent | B | Like message_bytes but counting only those messages which are persistent |
home/versioned_docs/version-1.6.x/help/redhat.md
+107
View File
@@ -0,0 +1,107 @@
---
id: redhat
title: Monitoring RedHat Operating System
sidebar_label: RedHat OS Operating System
keywords: [ Open Source Monitoring System, Open Source OS Monitoring, RedHat OS Monitoring ]
---
> Collect and monitor general performance metrics for RedHat operating systems (system information, CPU, memory, disk, network interface, file system, top resource processes, etc.).
## Configuration Parameters
| Parameter Name | Parameter help description |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). |
| Task Name | Identifies the name of this monitoring, ensuring uniqueness. |
| Port | Port provided by Linux SSH externally, defaults to 22. |
| Timeout | Sets the timeout for connection in milliseconds (ms), defaults to 6000 ms. |
| Connection Reuse | Sets whether the SSH connection is reused, defaults to: false. Creates a new connection for each information retrieval if false. |
| Username | SSH connection username, optional. |
| Password | SSH connection password, optional. |
| Collector | Specifies which collector schedules the collection for this monitoring. |
| Monitoring Interval | Interval for periodically collecting data, in seconds. Minimum interval is 30 seconds. |
| Binding Tags | Used for categorizing and managing monitored resources. |
| Description | Additional remarks and descriptions for this monitoring, for users' reference. |
| PrivateKey | Key required for connecting to the server. |
### Collected Metrics
#### Metric Set: Basic Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|---------------------------|
| Host Name | None | Host name. |
| System Version | None | Operating system version. |
| Uptime | None | System uptime. |
#### Metric Set: CPU Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|-------------------------------------------|
| info | None | CPU model. |
| cores | None | Number of CPU cores. |
| interrupt | None | Number of CPU interrupts. |
| load | None | Average load for the last 1/5/15 minutes. |
| context_switch | None | Current context switches. |
| usage | % | CPU usage percentage. |
#### Metric Set: Memory Info
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|------------------------------------|
| total | Mb | Total memory capacity. |
| used | Mb | Used memory by user programs. |
| free | Mb | Free memory capacity. |
| buff_cache | Mb | Memory used for buffers and cache. |
| available | Mb | Available memory capacity. |
| usage | % | Memory usage percentage. |
#### Metric Set: Disk Info
| Metric Name | Metric Unit | Metric help description |
|---------------|-------------|------------------------------------|
| disk_num | None | Total number of disks. |
| partition_num | None | Total number of partitions. |
| block_write | None | Total blocks written to disk. |
| block_read | None | Total blocks read from disk. |
| write_rate | iops | Rate of blocks written per second. |
#### Metric Set: Interface Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|--------------------------------|
| interface_name | None | Name of the network interface. |
| receive_bytes | Mb | Inbound data traffic. |
| transmit_bytes | Mb | Outbound data traffic. |
#### Metric Set: Disk Free
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------|
| filesystem | None | Name of the file system. |
| used | Mb | Used disk space. |
| available | Mb | Available disk space. |
| usage | % | Disk usage percentage. |
| mounted | None | Mount point directory. |
#### Metric Set: Top10 CPU Process
Top 10 processes consuming CPU. Metrics include: Process ID, CPU usage, Memory usage, Command.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| cpu_usage | % | CPU usage |
| mem_usage | % | Memory usage |
| command | None | Executed command |
#### Metric Set: Top10 Memory Process
Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CPU usage, Command.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| mem_usage | % | Memory usage |
| cpu_usage | % | CPU usage |
| command | None | Executed command |
home/versioned_docs/version-1.6.x/help/redis.md
+234
View File
@@ -0,0 +1,234 @@
---
id: redis
title: Monitorin REDIS database
sidebar_label: REDIS
keywords: [ open source monitoring tool, open source Redis monitoring tool, monitoring Redis metrics ]
---
> Collect and monitor the general performance Metrics of Redis database. Support REDIS1.0+.
## Configuration parameter
| Parameter name | Parameter help description |
|--------|------------------------------------------------------|
| Target Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). |
| Port | The HTTP port provided by Redis, default value is 6379, sentinel node`s default value is 26379 |
| Timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms |
| Username | Database connection user name, optional |
| Password | Database connection password, optional |
### Collection Metric
#### Metric set：server
| Metric name | Metric unit | Metric help description |
|--------------------------|------|-----------------------------------------------|
| redis_version | none | Version of the Redis server |
| redis_git_sha1 | none | Git SHA1 |
| redis_git_dirty | none | Git dirty flag |
| redis_build_id | none | The build id |
| redis_mode | none | The server's mode ("standalone", "sentinel" or "cluster") |
| os | none | Operating system hosting the Redis server |
| arch_bits | none | Architecture (32 or 64 bits) |
| multiplexing_api | none | Event loop mechanism used by Redis |
| atomicvar_api | none | Atomicvar API used by Redis |
| gcc_version | none | Version of the GCC compiler used to compile the Redis server |
| process_id | none | PID of the server process |
| process_supervised | none | Supervised system ("upstart", "systemd", "unknown" or "no") |
| run_id | none | Random value identifying the Redis server (to be used by Sentinel and Cluster) |
| tcp_port | none | TCP/IP listen port |
| server_time_usec | none | Epoch-based system time with microsecond precision |
| uptime_in_seconds | none | Number of seconds since Redis server start |
| uptime_in_days | none | Same value expressed in days |
| hz | none | The server's current frequency setting |
| configured_hz | none | The server's configured frequency setting |
| lru_clock | none | Clock incrementing every minute, for LRU management |
| executable | none | The path to the server's executable |
| config_file | none | The path to the config file |
| io_threads_active | none | Flag indicating if I/O threads are active |
| shutdown_in_milliseconds | none | The maximum time remaining for replicas to catch up the replication before completing the shutdown sequence. This field is only present during shutdown. |
#### Metric set：clients
| Metric name | Metric unit | Metric help description |
|---------------------------------|------|--------------------------------------------------------------------------------|
| connected_clients | none | Number of client connections (excluding connections from replicas) |
| cluster_connections | none | An approximation of the number of sockets used by the cluster's bus |
| maxclients | none | The value of the maxclients configuration directive. This is the upper limit for the sum of connected_clients, connected_slaves and cluster_connections. |
| client_recent_max_input_buffer | byte | Biggest input buffer among current client connections |
| client_recent_max_output_buffer | byte | Biggest output buffer among current client connections |
| blocked_clients | none | Number of clients pending on a blocking call (BLPOP, BRPOP, BRPOPLPUSH, BLMOVE, BZPOPMIN, BZPOPMAX) |
| tracking_clients | none | Number of clients being tracked (CLIENT TRACKING) |
| clients_in_timeout_table | none | Number of clients in the clients timeout table |
#### Metric set：memory
| Metric name | Metric unit | Metric help description |
|---------------------------|----------|-----------------------------------------------------------------------------------------------|
| used_memory | byte | Total number of bytes allocated by Redis using its allocator (either standard libc, jemalloc, or an alternative allocator such as tcmalloc) |
| used_memory_human | GB/MB/KB | Human readable representation of previous value |
| used_memory_rss | byte | Number of bytes that Redis allocated as seen by the operating system (a.k.a resident set size). This is the number reported by tools such as top(1) and ps(1) |
| used_memory_rss_human | GB/MB/KB | Human readable representation of previous value值 |
| used_memory_peak | byte | Peak memory consumed by Redis (in bytes) |
| used_memory_peak_human | GB/MB/KB | Human readable representation of previous value |
| used_memory_peak_perc | none | The percentage of used_memory_peak out of used_memory |
| used_memory_overhead | byte | The sum in bytes of all overheads that the server allocated for managing its internal data structures |
| used_memory_startup | byte | Initial amount of memory consumed by Redis at startup in bytes |
| used_memory_dataset | byte | The size in bytes of the dataset (used_memory_overhead subtracted from used_memory) |
| used_memory_dataset_perc | none | The percentage of used_memory_dataset out of the net memory usage (used_memory minus used_memory_startup) |
| allocator_allocated | byte | Total bytes allocated form the allocator, including internal-fragmentation. Normally the same as used_memory. |
| allocator_active | byte | Total bytes in the allocator active pages, this includes external-fragmentation. |
| allocator_resident | byte | Total bytes resident (RSS) in the allocator, this includes pages that can be released to the OS (by MEMORY PURGE, or just waiting). |
| total_system_memory | byte | The total amount of memory that the Redis host has |
| total_system_memory_human | GB/MB/KB | Human readable representation of previous value |
| used_memory_lua | byte | Number of bytes used by the Lua engine for EVAL scripts. Deprecated in Redis 7.0, renamed to used_memory_vm_eval |
| used_memory_lua_human | KB | Human readable representation of previous value. Deprecated in Redis 7.0 |
| used_memory_scripts | byte | used_memory_scripts_eval + used_memory_functions (part of used_memory). Added in Redis 7.0 |
| used_memory_scripts_human | GB/MB/KB | Human readable representation of previous value |
| number_of_cached_scripts | none | The number of EVAL scripts cached by the server. Added in Redis 7.0 |
| maxmemory | byte | The value of the maxmemory configuration directive |
| maxmemory_human | GB/MB/KB | Human readable representation of previous value |
| maxmemory_policy | none | The value of the maxmemory-policy configuration directive |
| allocator_frag_ratio | none | Ratio between allocator_active and allocator_allocated. This is the true (external) fragmentation metric (not mem_fragmentation_ratio). |
| allocator_frag_bytes | byte | Delta between allocator_active and allocator_allocated. See note about mem_fragmentation_bytes. |
| allocator_rss_ratio | | Ratio between allocator_resident and allocator_active. |
| allocator_rss_bytes | byte | Delta between allocator_resident and allocator_active |
| rss_overhead_ratio | none | Ratio between used_memory_rss (the process RSS) and allocator_resident. This includes RSS overheads that are not allocator or heap related. |
| rss_overhead_bytes | byte | Delta between used_memory_rss (the process RSS) and allocator_resident |
| mem_fragmentation_ratio | none | Ratio between used_memory_rss and used_memory. Note that this doesn't only includes fragmentation, but also other process overheads (see the allocator_* metrics), and also overheads like code, shared libraries, stack, etc. |
| mem_fragmentation_bytes | byte | Delta between used_memory_rss and used_memory. Note that when the total fragmentation bytes is low (few megabytes), a high ratio (e.g. 1.5 and above) is not an indication of an issue. |
| mem_not_counted_for_evict | byte | Used memory that's not counted for key eviction. This is basically transient replica and AOF buffers. |
| mem_replication_backlog | byte | Memory used by replication backlog |
| mem_clients_slaves | none | Memory used by replica clients - Starting Redis 7.0, replica buffers share memory with the replication backlog, so this field can show 0 when replicas don't trigger an increase of memory usage. |
| mem_clients_normal | none | Memory used by normal clients |
| mem_aof_buffer | none | Transient memory used for AOF and AOF rewrite buffers |
| mem_allocator | none | Memory allocator, chosen at compile time. |
| active_defrag_running | none | When activedefrag is enabled, this indicates whether defragmentation is currently active, and the CPU percentage it intends to utilize. |
| lazyfree_pending_objects | none | The number of objects waiting to be freed (as a result of calling UNLINK, or FLUSHDB and FLUSHALL with the ASYNC option) |
| lazyfreed_objects | none | The number of objects that have been lazy freed. |
#### Metric set：persistence
| Metric name | Metric unit | Metric help description |
|------------------------------|--------|-----------------------------------------------------------------------------------------------------|
| loading | none | Flag indicating if the load of a dump file is on-going |
| current_cow_size | byte | The size in bytes of copy-on-write memory while a child fork is running |
| current_cow_size_age | second | The age, in seconds, of the current_cow_size value. |
| current_fork_perc | none | The percentage of progress of the current fork process. For AOF and RDB forks it is the percentage of current_save_keys_processed out of |
| current_save_keys_processed | none | Number of keys processed by the current save operation |
| current_save_keys_total | none | Number of keys at the beginning of the current save operation |
| rdb_changes_since_last_save | none | Number of changes since the last dump |
| rdb_bgsave_in_progress | none | Flag indicating a RDB save is on-going |
| rdb_last_save_time | second | Epoch-based timestamp of last successful RDB save |
| rdb_last_bgsave_status | none | Status of the last RDB save operation |
| rdb_last_bgsave_time_sec | second | Duration of the last RDB save operation in seconds |
| rdb_current_bgsave_time_sec | none | Duration of the on-going RDB save operation if any |
| rdb_last_cow_size | none | The size in bytes of copy-on-write memory during the last RDB save operation |
| aof_enabled | none | Flag indicating AOF logging is activated |
| aof_rewrite_in_progress | none | Flag indicating a AOF rewrite operation is on-going |
| aof_rewrite_scheduled | none | Flag indicating an AOF rewrite operation will be scheduled once the on-going RDB save is complete. |
| aof_last_rewrite_time_sec | none | Duration of the last AOF rewrite operation in seconds |
| aof_current_rewrite_time_sec | second | Duration of the on-going AOF rewrite operation if any |
| aof_last_bgrewrite_status | none | Status of the last AOF rewrite operation |
| aof_last_write_status | none | Status of the last write operation to the AOF |
| aof_last_cow_size | none | The size in bytes of copy-on-write memory during the last AOF rewrite operation |
| module_fork_in_progress | none | Flag indicating a module fork is on-going |
| module_fork_last_cow_size | none | The size in bytes of copy-on-write memory during the last module fork operation |
#### Metric set：stats
| Metric name | Metric unit | Metric help description |
|--------------------------------|------|----------------------------------------------------|
| total_connections_received | none | Total number of connections accepted by the server |
| total_commands_processed | none | Total number of commands processed by the server |
| instantaneous_ops_per_sec | none | Number of commands processed per second |
| total_net_input_bytes | byte | The total number of bytes read from the network |
| total_net_output_bytes | byte | The total number of bytes written to the network |
| instantaneous_input_kbps | KB/S | The network's read rate per second in KB/sec |
| instantaneous_output_kbps | KB/S | The network's write rate per second in KB/sec |
| rejected_connections | none | Number of connections rejected because of maxclients limit |
| sync_full | none | The number of full resyncs with replicas |
| sync_partial_ok | none | The number of accepted partial resync requests |
| sync_partial_err | none | The number of denied partial resync requests |
| expired_keys | none | Total number of key expiration events |
| expired_stale_perc | none | The percentage of keys probably expired |
| expired_time_cap_reached_count | none | The count of times that active expiry cycles have stopped early |
| expire_cycle_cpu_milliseconds | none | The cumulative amount of time spent on active expiry cycles |
| evicted_keys | none | Number of evicted keys due to maxmemory limit |
| keyspace_hits | none | Number of successful lookup of keys in the main dictionary |
| keyspace_misses | none | Number of failed lookup of keys in the main dictionary |
| pubsub_channels | none | Global number of pub/sub channels with client subscriptions |
| pubsub_patterns | none | Global number of pub/sub pattern with client subscriptions |
| latest_fork_usec | none | Duration of the latest fork operation in microseconds |
| total_forks | none | Total number of fork operations since the server start |
| migrate_cached_sockets | none | The number of sockets open for MIGRATE purposes |
| slave_expires_tracked_keys | none | The number of keys tracked for expiry purposes (applicable only to writable replicas) |
| active_defrag_hits | none | Number of value reallocations performed by active the defragmentation process |
| active_defrag_misses | none | Number of aborted value reallocations started by the active defragmentation process |
| active_defrag_key_hits | none | Number of keys that were actively defragmented |
| active_defrag_key_misses | none | Number of keys that were skipped by the active defragmentation process |
| tracking_total_keys | none | Number of keys being tracked by the server |
| tracking_total_items | none | Number of items, that is the sum of clients number for each key, that are being tracked |
| tracking_total_prefixes | none | Number of tracked prefixes in server's prefix table (only applicable for broadcast mode) |
| unexpected_error_replies | none | Number of unexpected error replies, that are types of errors from an AOF load or replication |
| total_error_replies | none | Total number of issued error replies, that is the sum of rejected commands (errors prior command execution) and failed commands (errors within the command execution) |
| dump_payload_sanitizations | none | Total number of dump payload deep integrity validations (see sanitize-dump-payload config). |
| total_reads_processed | none | Total number of read events processed |
| total_writes_processed | none | Total number of write events processed |
| io_threaded_reads_processed | none | Number of read events processed by the main and I/O threads |
| io_threaded_writes_processed | none | Number of write events processed by the main and I/O threads |
#### Metric set：replication
| Metric name | Metric unit | Metric help description |
|--------------------------------|------|-------------------------------------------------------------------------------------|
| role | none | Value is "master" if the instance is replica of no one, or "slave" if the instance is a replica of some master instance. Note that a replica can be master of another replica (chained replication). |
| connected_slaves | none | Number of connected replicas |
| master_failover_state | none | The state of an ongoing failover, if any. |
| master_replid | none | The replication ID of the Redis server. |
| master_replid2 | none | The secondary replication ID, used for PSYNC after a failover. |
| master_repl_offset | none | The server's current replication offset |
| second_repl_offset | none | The offset up to which replication IDs are accepted |
| repl_backlog_active | none | Flag indicating replication backlog is active |
| repl_backlog_size | byte | Total size in bytes of the replication backlog buffer |
| repl_backlog_first_byte_offset | none | The master offset of the replication backlog buffer |
| repl_backlog_histlen | none | Size in bytes of the data in the replication backlog buffer |
#### Metric set：cpu
| Metric name | Metric unit | Metric help description |
|---------------------------|------|------------------------|
| used_cpu_sys | none | System CPU consumed by the Redis server, which is the sum of system CPU consumed by all threads of the server process (main thread and background threads) |
| used_cpu_user | none | User CPU consumed by the Redis server, which is the sum of user CPU consumed by all threads of the server process (main thread and background threads) |
| used_cpu_sys_children | none | System CPU consumed by the background processes |
| used_cpu_user_children | none | User CPU consumed by the background processes |
| used_cpu_sys_main_thread | none | System CPU consumed by the Redis server main thread |
| used_cpu_user_main_thread | none | User CPU consumed by the Redis server main thread |
#### Metric set：errorstats
| Metric name | Metric unit | Metric help description |
|-------------------|------|-----------|
| errorstat_ERR | none | ERR count |
| errorstat_MISCONF | none | MISCONF count |
#### Metric set：cluster
| Metric name | Metric unit | Metric help description |
|-----------------|------|--------------------|
| cluster_enabled | none | Indicate Redis cluster is enabled |
#### Metric set：commandstats
| Metric name | Metric unit | Metric help description |
|---------------|------|---------------------------------------------------------------------------------------------------------------------------|
| cmdstat_set | none | set command stat |
| cmdstat_get | none | get command stat |
| cmdstat_setnx | none | setnx command stat |
| cmdstat_hset | none | hset command stat |
| cmdstat_hget | none | hget command stat |
| cmdstat_lpush | none | lpush command stat |
| cmdstat_rpush | none | rpush command stat |
| cmdstat_lpop | none | lpop command stat |
| cmdstat_rpop | none | rpop command stat |
| cmdstat_llen | none | llen command stat |
home/versioned_docs/version-1.6.x/help/redis_cluster.md
+166
View File
@@ -0,0 +1,166 @@
---
id: redis_cluster
title: Monitoring Redis Cluster
sidebar_label: Redis Cluster Monitor
keywords: [ open source monitoring tool, open source Redis Cluster monitoring tool, monitoring Redis Cluster metrics ]
---
## Pre-monitoring operations
1. create a empty folder and add two files.
*redis.config*
```shell
port 6379
cluster-enabled yes
cluster-config-file nodes.conf
cluster-node-timeout 5000
appendonly yes
bind 0.0.0.0
protected-mode no
```
*docker-compose.yml*
```yml
services:
redis-master-1:
image: redis:latest
container_name: redis-master-1
command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
volumes:
- ./redis.conf:/usr/local/etc/redis/redis.conf
ports:
- "1000:6379"
redis-master-2:
image: redis:latest
container_name: redis-master-2
command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
volumes:
- ./redis.conf:/usr/local/etc/redis/redis.conf
ports:
- "2000:6379"
redis-master-3:
image: redis:latest
container_name: redis-master-3
command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
volumes:
- ./redis.conf:/usr/local/etc/redis/redis.conf
ports:
- "3000:6379"
redis-slave-1:
image: redis:latest
container_name: redis-slave-1
command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
volumes:
- ./redis.conf:/usr/local/etc/redis/redis.conf
ports:
- "1001:6379"
redis-slave-2:
image: redis:latest
container_name: redis-slave-2
command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
volumes:
- ./redis.conf:/usr/local/etc/redis/redis.conf
ports:
- "2001:6379"
redis-slave-3:
image: redis:latest
container_name: redis-slave-3
command: ["redis-server", "/usr/local/etc/redis/redis.conf"]
volumes:
- ./redis.conf:/usr/local/etc/redis/redis.conf
ports:
- "3001:6379"
networks:
default:
external:
name: hertzbeat-redis-cluster
```
2. View the IP addresses of all containers from the network, which is required when building a cluster.
```bash
docker-compose up -d
docker network inspect hertzbeat-redis-cluste
```
```json
"Containers": {
"187b879f73c473b3cbb82ff95f668e65af46115ddaa27f3ff1a712332b981531": {
...
"Name": "redis-slave-2",
"IPv4Address": "192.168.117.6/24",
...
},
"45e22b64c82e51857fc104436cdd6cc0c5776ad10a2e4b9d8e52e36cfb87217e": {
...
"Name": "redis-master-3",
"IPv4Address": "192.168.117.3/24
...
},
"57838ae37956f8af181f9a131eb011efec332b9ed3d49480f59d8962ececf288": {
...
"Name": "redis-master-2",
"IPv4Address": "192.168.117.7/24",
...
},
"94478d14bd950bcde533134870beb89b392515843027a0595af56dd1e3305a76": {
...
"Name": "redis-master-1",
"IPv4Address": "192.168.117.4/24",
...
},
"ad055720747e7fc430ba794d5321723740eeb345c280073e4292ed4302ff657c": {
...
"Name": "redis-slave-3",
"IPv4Address": "192.168.117.2/24",
...
},
"eddded1ac4c7528640ba0c6befbdaa48faa7cb13905b934ca1f5c69ab364c725": {
...
"Name": "redis-slave-1",
"IPv4Address": "192.168.117.5/24",
...
}
},
```
3. Go inside the container to build a Redis cluster.
```bash
docker exec -it redis-master-1 /bin/bash
```
```bash
redis-cli --cluster create \
192.168.117.4:6379 \
192.168.117.7:6379 \
192.168.117.3:6379 \
192.168.117.5:6379 \
192.168.117.6:6379 \
192.168.117.2:6379 \
--cluster-replicas 1
```
4. Specific operations.
Add a redis monitor center, fill require parameters.
![HertzBeat](/img/docs/help/redis-cluster-add.png)
final effect.
![HertzBeat](/img/docs/help/redis-cluster-view.png)
### Configuration Parameters
Please see [REDIS](https://hertzbeat.apache.org/docs/help/redis) doc.
home/versioned_docs/version-1.6.x/help/registry.md
+51
View File
@@ -0,0 +1,51 @@
---
id: registry
title: Monitoring Registry
sidebar_label: Registry Monitor
keywords: [open source monitoring tool, open source java monitoring tool, monitoring registry metrics]
---
> Collect and monitor the general performance Metrics of Registry.
**Protocol Use：registry**
## Steps to monitor micro services
1. Make sure your **Register center** is available
> We currently support for `Consul` and `Nacos`.
2. Add http_sd monitor and enter necessary info about **Register center** on HertzBeat, such as host, port and so on.
3. Click **OK**
## Configuration parameter
| Parameter name | Parameter help description |
|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Host | Monitored IPV4, IPV6 or domain name. Note⚠️Without protocol header (eg: https://, http://) |
| Task name | Identify the name of this monitoring. The name needs to be unique |
| Port | Port provided by Register center |
| Discovery Client Type | Select one Register center that you want to monitor |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds |
| Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here |
## Collection Metrics
## Metrics Set：server
| Metric name | Metric unit | Metric help description |
|---------------|-------------|-------------------------|
| Address | | |
| Port | | |
| Response Time | ms | |
## Metrics Set：service
| Metric name | Metric unit | Metric help description |
|---------------|-------------|----------------------------------|
| Service Id | | |
| Service Name | | |
| Address | | |
| Port | | |
| Health Status | | Current health status of service |
home/versioned_docs/version-1.6.x/help/rocketmq.md
+48
View File
@@ -0,0 +1,48 @@
---
id: rocketmq
title: Monitoring Apache RocketMQ
sidebar_label: Apache RocketMQ
keywords: [ open source monitoring tool, monitoring Apache RocketMQ metrics ]
---
> Monitor the broker, consumer and other related metrics of RocketMQ.
## Configuration parameters
| Parameter name | Parameter help description |
|---------------------|--------------------------------------------------------------------------------------------------------------------------|
| Namesrv Host | IPV4,IPV6 of RocketMQ name server(eg: https://, http://)。 |
| Monitoring name | Identify the name of this monitoring. The name needs to be unique. |
| Port | Port of RocketMQ name server. |
| accessKey | accessKey. |
| secretKey | secretKey. |
| Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. |
| Bind Tags | Used to classify and manage monitoring resources. |
| Description remarks | For more information about identifying and describing this monitoring, users can note information here. |
### Collection Metric
#### Metric set：cluster
| Metric name | Metric unit | Metric help description |
|-------------------------|-------------|---------------------------------------|
| BrokerId | none | Broker id |
| Address | none | Broker address |
| Version | none | Version |
| Producer_Message_TPS | none | Produce message TPS |
| Consumer_Message_TPS | none | Consume message TPS |
| Yesterday_Produce_Count | none | Number of messages produced yesterday |
| Yesterday_Consume_Count | none | Number of messages consumed yesterday |
| Today_Produce_Count | none | Number of messages produced today |
| Today_Consume_Count | none | Number of messages consumed today |
#### Metric set：Consumer
| Metric name | Metric unit | Metric help description |
|-----------------|-------------|-------------------------|
| Consumer_group | none | Consumer group |
| Client_quantity | none | Number of clients |
| Message_model | none | Message model |
| Consume_type | none | Consume type |
| Consume_tps | none | Consume tps |
| Delay | none | Delay |
home/versioned_docs/version-1.6.x/help/rockylinux.md
+107
View File
@@ -0,0 +1,107 @@
---
id: rockylinux
title: Monitoring Rocky Linux Operating System
sidebar_label: Rocky Linux Operating System
keywords: [ Open Source Monitoring System, Open Source OS Monitoring, Rocky Linux Monitoring ]
---
> Collect and monitor general performance metrics for Rocky Linux operating systems (system information, CPU, memory, disk, network interface, file system, top resource processes, etc.).
## Configuration Parameters
| Parameter Name | Parameter help description |
|---------------------|----------------------------------------------------------------------------------------------------------------------------------|
| Monitoring Host | The IP, IPV6, or domain name of the monitored endpoint. Note ⚠️: Do not include protocol headers (eg: https://, http://). |
| Task Name | Identifies the name of this monitoring, ensuring uniqueness. |
| Port | Port provided by Linux SSH externally, defaults to 22. |
| Timeout | Sets the timeout for connection in milliseconds (ms), defaults to 6000 ms. |
| Connection Reuse | Sets whether the SSH connection is reused, defaults to: false. Creates a new connection for each information retrieval if false. |
| Username | SSH connection username, optional. |
| Password | SSH connection password, optional. |
| Collector | Specifies which collector schedules the collection for this monitoring. |
| Monitoring Interval | Interval for periodically collecting data, in seconds. Minimum interval is 30 seconds. |
| Binding Tags | Used for categorizing and managing monitored resources. |
| Description | Additional remarks and descriptions for this monitoring, for users' reference. |
| PrivateKey | Key required for connecting to the server. |
### Collected Metrics
#### Metric Set: Basic Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|---------------------------|
| Host Name | None | Host name. |
| System Version | None | Operating system version. |
| Uptime | None | System uptime. |
#### Metric Set: CPU Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|-------------------------------------------|
| info | None | CPU model. |
| cores | None | Number of CPU cores. |
| interrupt | None | Number of CPU interrupts. |
| load | None | Average load for the last 1/5/15 minutes. |
| context_switch | None | Current context switches. |
| usage | % | CPU usage percentage. |
#### Metric Set: Memory Info
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|------------------------------------|
| total | Mb | Total memory capacity. |
| used | Mb | Used memory by user programs. |
| free | Mb | Free memory capacity. |
| buff_cache | Mb | Memory used for buffers and cache. |
| available | Mb | Available memory capacity. |
| usage | % | Memory usage percentage. |
#### Metric Set: Disk Info
| Metric Name | Metric Unit | Metric help description |
|---------------|-------------|------------------------------------|
| disk_num | None | Total number of disks. |
| partition_num | None | Total number of partitions. |
| block_write | None | Total blocks written to disk. |
| block_read | None | Total blocks read from disk. |
| write_rate | iops | Rate of blocks written per second. |
#### Metric Set: Interface Info
| Metric Name | Metric Unit | Metric help description |
|----------------|-------------|--------------------------------|
| interface_name | None | Name of the network interface. |
| receive_bytes | Mb | Inbound data traffic. |
| transmit_bytes | Mb | Outbound data traffic. |
#### Metric Set: Disk Free
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|--------------------------|
| filesystem | None | Name of the file system. |
| used | Mb | Used disk space. |
| available | Mb | Available disk space. |
| usage | % | Disk usage percentage. |
| mounted | None | Mount point directory. |
#### Metric Set: Top10 CPU Process
Top 10 processes consuming CPU. Metrics include: Process ID, CPU usage, Memory usage, Command.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| cpu_usage | % | CPU usage |
| mem_usage | % | Memory usage |
| command | None | Executed command |
#### Metric Set: Top10 Memory Process
Top 10 processes consuming memory. Metrics include: Process ID, Memory usage, CPU usage, Command.
| Metric Name | Metric Unit | Metric help description |
|-------------|-------------|-------------------------|
| pid | None | Process ID |
| mem_usage | % | Memory usage |
| cpu_usage | % | CPU usage |
| command | None | Executed command |

Some files were not shown because too many files have changed in this diff Show More