diff --git a/home/docs/advanced/extend-push.md b/home/docs/advanced/extend-push.md new file mode 100644 index 00000000000..18e190d7f5d --- /dev/null +++ b/home/docs/advanced/extend-push.md @@ -0,0 +1,26 @@ +--- +id: extend-push +title: Push Style Custom Monitoring +sidebar_label: Push Style Custom Monitoring +--- + +> Push style curstom monitor is a type of monitor which allow user to configure metrics format and push metrics to hertzbeat with their own service. +> Here we will introduce how to use this feature. + +### Push style custom monitor collection process + +【Peer Server Start Pushing Metrics】 -> 【HertzBeat Push Module Stage Metrics】-> 【HertzBeat Collect Module collect Metrics Periodically】 + +### Data parsing method + +HertzBeat will parsing metrics with the format configured by user while adding new monitor. + +### Create Monitor Steps + +HertzBeat DashBoard -> Service Monitor -> Push Style Monitor -> New Push Style Monitor -> set Push Module Host (hertzbeat server ip, usually 127.0.0.1/localhost) -> set Push Module Port (hertzbeat server port, usually 1157) -> configure metrics field (unit: string, type: 0 number / 1 string) -> end + +--- + +### Monitor Configuration Example + +![](/img/docs/advanced/extend-push-example-1.png) diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-push.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-push.md new file mode 100644 index 00000000000..7245afe2a12 --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/advanced/extend-push.md @@ -0,0 +1,26 @@ +--- +id: extend-push +title: Push Style Custom Monitoring +sidebar_label: Push Style Custom Monitoring +--- + +> 推送方式监控是一种特殊的监控,允许用户配置数据格式并编写代码将指标推送到 Hertzbeat。 +> 下面我们将介绍如何使用这一功能。 + +### 推送方式监控的采集流程 + +【用户开始推送数据】->【HertzBeat推送模块暂存数据】->【HertzBeat采集模块定期采集数据】 + +### 数据解析方式 + +HertzBeat会使用用户添加新监控时配置的格式来解析数据。 + +### 创建监控步骤 + +HertzBeat页面 -> 应用服务监控 -> 推送方式监控 -> 新建推送方式监视器 -> 设置推送模块主机(Hertzbeat服务器ip,通常为127.0.0.1或localhost) -> 设置推送模块端口(hertzbeat服务器端口,通常为1157) -> 配置数据字段(单位:字符串表示,类型:0表示数字/1表示字符串)-> 结束 + +--- + +### 监控配置示例 + +![](/img/docs/advanced/extend-push-example-1.png) diff --git a/home/sidebars.json b/home/sidebars.json index 151f2e6d5c4..b18409e9f1d 100644 --- a/home/sidebars.json +++ b/home/sidebars.json @@ -80,6 +80,13 @@ "items": [ "advanced/extend-snmp" ] + }, + { + "type": "category", + "label": "push", + "items": [ + "advanced/extend-push" + ] } ] }, diff --git a/home/static/img/docs/advanced/extend-push-example-1.png b/home/static/img/docs/advanced/extend-push-example-1.png new file mode 100644 index 00000000000..bf9fc6eb328 Binary files /dev/null and b/home/static/img/docs/advanced/extend-push-example-1.png differ