# 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: db
# The monitoring type eg: linux windows tomcat mysql aws...
# 监控类型 eg: linux windows tomcat mysql aws...
app: elasticsearch
# The monitoring i18n name
# 监控类型国际化名称
name:
zh-CN: ElasticSearch
en-US: ElasticSearch
# The description and help of this monitoring type
# 监控类型的帮助描述信息
help:
zh-CN: Hertzbeat 对 ElasticSearch 数据库监控通用指标进行测量监控。
您可以点击 “新建 ElasticSearch” 并进行配置,或者选择“更多操作”,导入已有配置。
en-US: Hertzbeat monitors ElasticSearch through general performance metric. You could click the "New ElasticSearch" button and proceed with the configuration or import an existing setup through the "More Actions" menu.
zh-TW: Hertzbeat對ElasticSearch資料庫監控通用名額進行量測監控。
您可以點擊“新建ElasticSearch”並進行配寘,或者選擇“更多操作”,導入已有配寘。
helpLink:
zh-CN: https://hertzbeat.com/zh-cn/docs/help/elasticsearch
en-US: https://hertzbeat.com/docs/help/elasticsearch
# 监控所需输入参数定义(根据定义渲染页面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
# default value
# 默认值
defaultValue: 9200
# field-param field key
# field-变量字段标识符
- field: timeout
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 查询超时时间
en-US: Query Timeout
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: number
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# hide param-true or false
# 是否隐藏字段 true or false
hide: true
# default value
# 默认值
defaultValue: 6000
# field-param field key
# field-变量字段标识符
- field: ssl
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 启用HTTPS
en-US: SSL
# type-param field type(boolean mapping the html h tag)
# type-字段类型,样式(boolean映射switch展示开关)
type: boolean
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: true
# field-param field key
# field-变量字段标识符
- field: authType
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 认证方式
en-US: Auth Type
# type-param field type(most mapping the html input tag)
# type-字段类型,样式(大部分映射input标签type属性)
type: radio
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# when type is radio checkbox, use option to show optional values {name1:value1,name2:value2}
# 当type为radio单选框, checkbox复选框时, option表示可选项值列表 {name1:value1,name2:value2}
options:
- label: Basic Auth
value: Basic Auth
- label: Digest Auth
value: Digest Auth
# field-param field key
# field-变量字段标识符
- field: username
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 用户名
en-US: Username
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: text
# when type is text, use limit to limit string length
# 当type为text时,用limit表示字符串限制大小
limit: 20
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# field-param field key
# field-变量字段标识符
- field: password
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 密码
en-US: Password
# type-param field type(most mapping the html input tag)
# type-字段类型,样式(大部分映射input标签type属性)
type: password
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# collect metrics config list
# 采集指标组配置列表
metrics:
# metrics - cpu
# 监控指标组 - cpu
- name: health
# 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: cluster_name
type: 1
instance: true
- field: status
type: 1
- field: nodes
type: 0
- field: data_nodes
type: 0
- field: active_primary_shards
type: 0
- field: active_shards
type: 0
- field: active_percentage
type: 0
unit: '%'
- field: initializing_shards
type: 0
- field: unassigned_shards
type: 0
# (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field
# (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
aliasFields:
- cluster_name
- status
- number_of_nodes
- number_of_data_nodes
- active_primary_shards
- active_shards
- initializing_shards
- unassigned_shards
- active_shards_percent_as_number
# mapping and conversion expressions, use these and aliasField above to calculate metrics value
# (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
# eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
calculates:
- cluster_name=cluster_name
- status=status
- nodes=number_of_nodes
- data_nodes=number_of_data_nodes
- active_primary_shards=active_primary_shards
- active_shards=active_shards
- active_percentage=active_shards_percent_as_number
- initializing_shards=initializing_shards
- unassigned_shards=unassigned_shards
# the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
protocol: http
# the config content when protocol is http
http:
# http host: ipv4 ipv6 domain
host: ^_^host^_^
# http port
port: ^_^port^_^
# http url
url: /_cluster/health?pretty
# http method: GET POST PUT DELETE PATCH
method: GET
# if enabled https
ssl: ^_^ssl^_^
# http auth
authorization:
# http auth type: Basic Auth, Digest Auth, Bearer Token
type: ^_^authType^_^
basicAuthUsername: ^_^username^_^
basicAuthPassword: ^_^password^_^
digestAuthUsername: ^_^username^_^
digestAuthPassword: ^_^password^_^
# http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule
# http 响应数据解析方式: default-系统规则, jsonPath-jsonPath脚本, website-网站可用性指标监控, prometheus-Prometheus数据规则
parseType: default
- name: nodes
priority: 1
fields:
- field: total
type: 0
- field: successful
type: 0
- field: failed
type: 0
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: /_nodes/stats
method: GET
ssl: ^_^ssl^_^
authorization:
type: ^_^authType^_^
basicAuthUsername: ^_^username^_^
basicAuthPassword: ^_^password^_^
digestAuthUsername: ^_^username^_^
digestAuthPassword: ^_^password^_^
# http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule
# http 响应数据解析方式: default-系统规则, jsonPath-jsonPath脚本, website-网站可用性指标监控, prometheus-Prometheus数据规则
parseType: jsonPath
# parse script when parse type is josnPath
parseScript: '$._nodes'
- name: nodes_detail
priority: 2
fields:
- field: node_name
type: 1
instance: true
- field: ip
type: 1
- field: cpu_load_average
type: 0
- field: cpu_percent
type: 0
unit: '%'
- field: heap_used
type: 0
unit: MB
- field: heap_used_percent
type: 0
unit: '%'
- field: heap_total
type: 0
unit: 'MB'
- field: disk_free
type: 0
unit: 'GB'
- field: disk_total
type: 0
unit: 'GB'
- field: disk_used_percent
type: 0
unit: '%'
aliasFields:
- $.name
- $.ip
# $.os.cpu.load_average.1m 支持 5.x 及以上版本;$.os.load_average 支持 2.x 及以上版本
- $.os.cpu.load_average.1m
- $.os.load_average
# $.os.cpu.percent 支持 5.x 及以上版本;$.os.cpu_percent 支持 2.x 及以上版本
- $.os.cpu_percent
- $.os.cpu.percent
- $.jvm.mem.heap_used_in_bytes
- $.jvm.mem.heap_used_percent
- $.jvm.mem.heap_max_in_bytes
- $.fs.total.free_in_bytes
- $.fs.total.total_in_bytes
calculates:
- node_name=$.name
- ip=$.ip
- cpu_load_average=#`$.os.cpu.load_average.1m` | $.os.load_average
- cpu_percent=$.os.cpu.percent | $.os.cpu_percent
- heap_used=$.jvm.mem.heap_used_in_bytes
- heap_used_percent=$.jvm.mem.heap_used_percent
- heap_total=$.jvm.mem.heap_max_in_bytes
- disk_free=$.fs.total.free_in_bytes
- disk_total=$.fs.total.total_in_bytes
- disk_used_percent=(1-$.fs.total.free_in_bytes/$.fs.total.total_in_bytes)*100
units:
- heap_used=B->MB
- heap_total=B->MB
- disk_free=B->GB
- disk_total=B->GB
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: /_nodes/stats
method: GET
ssl: ^_^ssl^_^
authorization:
type: ^_^authType^_^
basicAuthUsername: ^_^username^_^
basicAuthPassword: ^_^password^_^
digestAuthUsername: ^_^username^_^
digestAuthPassword: ^_^password^_^
parseType: jsonPath
parseScript: '$.nodes.*'