# Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # The monitoring type category:service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring # 监控类型所属类别:service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控 cn-云原生cloud native network-网络监控 category: service # The monitoring type eg: linux windows tomcat mysql aws... # 监控类型 eg: linux windows tomcat mysql aws... app: fullsite # The monitoring i18n name # 监控类型国际化名称 name: zh-CN: SiteMap全站 en-US: SITE MAP # The description and help of this monitoring type # 监控类型的帮助描述信息 help: zh-CN: HertzBeat 对网站全部页面的 URL 路径、HTTP 状态码、响应时间及请求反馈进行监测。由于一个网站可能有多个不同服务提供的页面,系统将采集网站暴露的网站地图(SiteMap)来监控全站。
⚠️注意:此功能需要您的网站支持 XML 和 TXT 格式的 SiteMap。
en-US: "HertzBeat monitors all pages of website by URL path, HTTP status code, response times and request feedback. Due to the possibility that a website may have multiple pages provided by different services, Hertzbeat will collect SiteMap which exposed by the website to monitor the entire site.
⚠️Note: HertzBeat support SiteMap in XML or TXT format.
" zh-TW: HertzBeat對網站全部頁面的URL路徑、HTTP狀態碼、回應時間及請求迴響進行監測。 由於一個網站可能有多個不同服務提供的頁面,系統將採集網站暴露的網站地圖(SiteMap)來監控全站。
⚠️注意:此功能需要您的網站支持XML和TXT格式的SiteMap。
helpLink: zh-CN: https://hertzbeat.com/zh-cn/docs/help/guide/ en-US: https://hertzbeat.com/docs/help/guide/ # 监控所需输入参数定义(根据定义渲染页面UI) # Input params define for monitoring(render web ui by the definition) params: # field-param field key # field-变量字段标识符 - field: host # name-param field display i18n name # name-参数字段显示名称 name: zh-CN: 主机Host en-US: Host # type-param field type(most mapping the html input type) # type-字段类型,样式(大部分映射input标签type属性) type: host # required-true or false # required-是否是必输项 true-必填 false-可选 required: true # field-param field key # field-变量字段标识符 - field: port # name-param field display i18n name # name-参数字段显示名称 name: zh-CN: 端口 en-US: Port # type-param field type(most mapping the html input type) # type-字段类型,样式(大部分映射input标签type属性) type: number # when type is number, range is required # 当type为number时,用range表示范围 range: '[0,65535]' # required-true or false # required-是否是必输项 true-必填 false-可选 required: true defaultValue: 80 - field: sitemap name: zh-CN: 网站地图 en-US: Site Map type: text limit: 200 required: true placeholder: 'Web SITEMAP EG:/sitemap.xml' - field: ssl name: zh-CN: 启用HTTPS en-US: HTTPS # type-param field type(boolean mapping the html switch tag) # type-当type为boolean时,前端用switch展示开关 type: boolean required: true # collect metrics config list # 采集指标组配置列表 metrics: # metrics - summary # 监控指标组 - summary - name: summary # metrics group scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel # priority 0's metrics group is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue # 指标组调度优先级(0->127)->(优先级高->低) 优先级低的指标组会等优先级高的指标组采集完成后才会被调度, 相同优先级的指标组会并行调度采集 # 优先级为0的指标组为可用性指标组,即它会被首先调度,采集成功才会继续调度其它指标组,采集失败则中断调度 priority: 0 # collect metrics content # 具体监控指标列表 fields: # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), instance-if is metrics group unique identifier # field-指标名称, type-指标类型(0-number数字,1-string字符串), unit-指标单位('%','ms','MB'), instance-是否是指标集合唯一标识符字段 - field: url type: 1 instance: true - field: statusCode type: 1 - field: responseTime type: 0 unit: ms - field: errorMsg type: 1 # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk protocol: http # the config content when protocol is http http: host: ^_^host^_^ port: ^_^port^_^ url: ^_^sitemap^_^ method: GET ssl: ^_^ssl^_^ parseType: sitemap