# 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 mid-middleware custom-custom monitoring os-operating system monitoring
# 监控类型所属类别:service-应用服务监控 db-数据库监控 mid-中间件 custom-自定义监控 os-操作系统监控 cn-云原生cloud native network-网络监控
category: mid
# The monitoring type eg: linux windows tomcat mysql aws...
# 监控类型 eg: linux windows tomcat mysql aws...
app: rabbitmq
# The monitoring i18n name
# 监控类型国际化名称
name:
zh-CN: RabbitMQ消息系统
en-US: RabbitMQ Message
# The description and help of this monitoring type
# 监控类型的帮助描述信息
help:
zh-CN: HertzBeat 对 RabbitMQ 消息中间件的运行状态,节点,队列等相关指标(overview、object_totals、nodes、queues)进行监测。
⚠️注意:HertzBeat 使用 RabbitMQ Management 的 Rest Api 对 RabbitMQ 进行指标数据采集,因此您的 RabbitMQ 环境需要开启 Management 插件,点击查看开启步骤。
en-US: "HertzBeat monitors RabbitMQ through the runtime status, nodes, queues and other metrics of message-oriented middleware.
⚠️Note:HertzBeat uses the Rest Api of RabbitMQ Management to collect metric data for RabbitMQ, so you need to enable Management plug-in component, Click here to view the specific steps."
zh-TW: HertzBeat對RabbitMQ消息中介軟體的運行狀態,節點,隊列等相關名額(overview、object_totals、nodes、queues)進行監測。
⚠️ 注意:HertzBeat使用RabbitMQ Management的Rest Api對RabbitMQ進行名額資料獲取,囙此您的RabbitMQ環境需要開啟Management挿件,點擊查看開啟步驟。
helpLink:
zh-CN: https://hertzbeat.com/zh-cn/docs/help/rabbitmq
en-US: https://hertzbeat.com/docs/help/rabbitmq
# 监控所需输入参数定义(根据定义渲染页面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: HTTP 端口
en-US: HTTP 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: 15672
# field-param field key
# field-变量字段标识符
- field: ssl
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 启动SSL
en-US: SSL
# When the type is boolean, the front end displays the switch with a switch
# 当type为boolean时,前端用switch展示开关
type: boolean
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: false
# field-param field key
# field-变量字段标识符
- field: authType
# name-param field display i18n name
# name-参数字段显示名称
name:
zh-CN: 认证方式
en-US: Auth Type
# When the type is radio radio radio and checkbox, option represents a list of optional values {name1: value1, name2: value2}
# 当type为radio单选框,checkbox复选框时,option表示可选项值列表 {name1:value1,name2:value2}
type: radio
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: true
#When the type is radio radio radio and checkbox, option represents a list of optional values {name1: value1, name2: value2}
# 当type为radio单选框,checkbox复选框时,option表示可选项值列表 {name1:value1,name2:value2}
options:
- label: Basic Auth
value: Basic Auth
defaultValue: Basic Auth
# field-param field key
# field-变量字段标识符
- field: username
name:
zh-CN: 用户名
en-US: Username
# type-param field type(most mapping the html input type)
# type-字段类型,样式(大部分映射input标签type属性)
type: text
# When the type is text, use limit to indicate the string limit size
# 当type为text时,用limit表示字符串限制大小
limit: 20
# required-true or false
# required-是否是必输项 true-必填 false-可选
required: true
# 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: true
metrics:
# Note: The built-in monitoring metrics include (responseTime - response time)
# 注意:内置监控指标有 (responseTime - 响应时间)
- name: overview
# 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: product_version
type: 1
- field: product_name
type: 1
- field: rabbitmq_version
type: 1
- field: managementrabb_version
type: 1
- field: erlang_version
type: 1
- field: cluster_name
type: 1
- field: rates_mode
type: 1
# 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
protocol: http
# 当protocol为http协议时具体的采集配置
http:
# 主机host: ipv4 ipv6 域名
host: ^_^host^_^
# 端口
port: ^_^port^_^
# url请求接口路径
url: /api/overview
# 请求方式 GET POST PUT DELETE PATCH
method: GET
# 是否启用ssl/tls,即是http还是https,默认false
ssl: ^_^ssl^_^
# 认证
authorization:
# 认证方式: Basic Auth, Digest Auth, Bearer Token
type: ^_^authType^_^
basicAuthUsername: ^_^username^_^
basicAuthPassword: ^_^password^_^
# 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-api可用性指标监控
parseType: default
- name: object_totals
# 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: 1
# 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: channels
type: 0
- field: connections
type: 0
- field: consumers
type: 0
- field: exchanges
type: 0
- field: queues
type: 0
protocol: http
http:
# 主机host: ipv4 ipv6 域名
host: ^_^host^_^
# 端口
port: ^_^port^_^
# url请求接口路径
url: /api/overview
# 请求方式 GET POST PUT DELETE PATCH
method: GET
# 是否启用ssl/tls,即是http还是https,默认false
ssl: ^_^ssl^_^
# 认证
authorization:
# 认证方式: Basic Auth, Digest Auth, Bearer Token
type: ^_^authType^_^
basicAuthUsername: ^_^username^_^
basicAuthPassword: ^_^password^_^
# 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-api可用性指标监控
parseType: jsonPath
parseScript: '$.object_totals'
- name: nodes
# 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: 1
# 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: name
type: 1
instance: true
- field: type
type: 1
- field: running
type: 1
- field: os_pid
type: 1
- field: mem_limit
type: 0
unit: MB
- field: mem_used
type: 0
unit: MB
- field: fd_total
type: 0
- field: fd_used
type: 0
- field: sockets_total
type: 0
- field: sockets_used
type: 0
- field: proc_total
type: 0
- field: proc_used
type: 0
- field: disk_free_limit
type: 0
unit: GB
- field: disk_free
type: 0
unit: GB
- field: gc_num
type: 0
- field: gc_bytes_reclaimed
type: 0
unit: MB
- field: context_switches
type: 0
- field: io_read_count
type: 0
- field: io_read_bytes
type: 0
unit: KB
- field: io_read_avg_time
type: 0
unit: ms
- field: io_write_count
type: 0
- field: io_write_bytes
type: 0
unit: KB
- field: io_write_avg_time
type: 0
unit: ms
- field: io_seek_count
type: 0
- field: io_seek_avg_time
type: 0
unit: ms
- field: io_sync_count
type: 0
- field: io_sync_avg_time
type: 0
unit: ms
- field: connection_created
type: 0
- field: connection_closed
type: 0
- field: channel_created
type: 0
- field: channel_closed
type: 0
- field: queue_declared
type: 0
- field: queue_created
type: 0
- field: queue_deleted
type: 0
- field: connection_closed
type: 0
units:
- mem_limit=B->MB
- mem_used=B->MB
- disk_free_limit=B->GB
- disk_free=B->GB
- gc_bytes_reclaimed=B->MB
- io_read_bytes=B->KB
- io_write_bytes=B->KB
protocol: http
http:
# 主机host: ipv4 ipv6 域名
host: ^_^host^_^
# 端口
port: ^_^port^_^
# url请求接口路径
url: /api/nodes
# 请求方式 GET POST PUT DELETE PATCH
method: GET
# 是否启用ssl/tls,即是http还是https,默认false
ssl: ^_^ssl^_^
# 认证
authorization:
# 认证方式: Basic Auth, Digest Auth, Bearer Token
type: ^_^authType^_^
basicAuthUsername: ^_^username^_^
basicAuthPassword: ^_^password^_^
# 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-api可用性指标监控
parseType: jsonPath
parseScript: '$.*'
- name: queues
# 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: 1
# 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: name
type: 1
instance: true
- field: node
type: 1
- field: state
type: 1
- field: type
type: 1
- field: vhost
type: 1
- field: auto_delete
type: 1
- field: policy
type: 1
- field: consumers
type: 0
- field: memory
type: 0
unit: B
- field: messages_ready
type: 0
- field: messages_unacknowledged
type: 0
- field: messages
type: 0
- field: messages_ready_ram
type: 0
- field: messages_persistent
type: 0
- field: message_bytes
type: 0
unit: B
- field: message_bytes_ready
type: 0
unit: B
- field: message_bytes_unacknowledged
type: 0
unit: B
- field: message_bytes_ram
type: 0
unit: B
- field: message_bytes_persistent
type: 0
unit: B
protocol: http
http:
# 主机host: ipv4 ipv6 域名
host: ^_^host^_^
# 端口
port: ^_^port^_^
# url请求接口路径
url: /api/queues
# 请求方式 GET POST PUT DELETE PATCH
method: GET
# 是否启用ssl/tls,即是http还是https,默认false
ssl: ^_^ssl^_^
# 认证
authorization:
# 认证方式: Basic Auth, Digest Auth, Bearer Token
type: ^_^authType^_^
basicAuthUsername: ^_^username^_^
basicAuthPassword: ^_^password^_^
# 响应数据解析方式: default-系统规则,jsonPath-jsonPath脚本,website-api可用性指标监控
parseType: jsonPath
parseScript: '$.*'