# 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
category: mid
# The monitoring type eg: springboot2 linux windows tomcat mysql aws...
app: spring_gateway
# The monitoring i18n name
name:
zh-CN: SpringGateway
en-US: SpringGateway
# The description and help of this monitoring type
help:
zh-CN: HertzBeat 对 SpringBoot Actuator 暴露的通用性能指标(globalfilters、routefilters、refresh、routes)进行采集监控。注意⚠️:如果要监控 SpringGateway 中的信息,需要您的 SpringGateway 应用集成并开启 SpringBoot Actuator, 点击查看具体步骤。
en-US: HertzBeat collect and monitors SpringGateway through general performance metric that exposed by the SpringBoot Actuator.
Note⚠️:You should make sure that your SpringGateway application have already integrated and enabled the SpringBoot Actuator, click here to see the specific steps.
zh-TW: HertzBeat 對 SpringBoot Actuator 暴露的通用性能指標(globalfilters、routefilters、refresh、routes)進行採集監控。< span class='help_module_span'>注意⚠️:如果要監控SpringGateway中的指標,需要您的SpringGateway應用集成並開啟SpringBoot Actuator,點擊查看具體步驟。
helpLink:
zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/spring_gateway
en-US: https://hertzbeat.apache.org/docs/help/spring_gateway
# Input params define for monitoring(render web ui by the definition)
params:
# field-param field key
- 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: host
# 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]'
# required-true or false
required: true
# default value
defaultValue: 8008
# field-param field key
- field: ssl
# name-param field display i18n name
name:
zh-CN: 启动SSL
en-US: SSL
# When the type is boolean, the frontend will display a switch for it.
type: boolean
# required-true or false
required: false
# field-param field key
- field: base_path
# name-param field display i18n name
name:
zh-CN: Base Path
en-US: Base Path
# type-param field type(most mapping the html input type) The type "text" belongs to a text input field.
type: text
# default value
defaultValue: /actuator
# required-true or false
required: true
# hide-true or false
hide: true
# collect metrics config list
metrics:
# metrics - available
- name: available
# metrics scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel
# priority 0's metrics is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue
priority: 0
# collect metrics content
fields:
# field-metric name, type-metric type(0-number,1-string), instance-is instance primary key, unit-metric unit
- field: responseTime
type: 0
unit: ms
# the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
protocol: http
# Specific collection configuration when protocol is http protocol
http:
# http host: ipv4 ipv6 domain
host: ^_^host^_^
# http port
port: ^_^port^_^
# http url
url: ^_^base_path^_^
# http request method GET POST PUT DELETE PATCH
method: GET
# enable SSL/TLS, that is, whether it is http or https, the default is false
ssl: ^_^ssl^_^
# http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-api availability monitoring
parseType: default
- name: environment
priority: 1
fields:
# The metric information, including field name, type of the field (0-number, 1-string), whether it is an instance primary key, and the unit of the metric.
- field: profile
type: 1
- field: port
type: 0
- field: os
type: 1
- field: os_arch
type: 1
- field: jdk_vendor
type: 1
- field: jvm_version
type: 1
# metric alias list, used to identify metrics in query results
aliasFields:
- $.activeProfiles[0]
- $.propertySources[?(@.name=='server.ports')].properties.*.value
- $.propertySources[?(@.name=='systemProperties')].properties['os.name'].value
- $.propertySources[?(@.name=='systemProperties')].properties['jdk.vendor.version'].value
- $.propertySources[?(@.name=='systemProperties')].properties['java.runtime.version'].value
- $.propertySources[?(@.name=='systemProperties')].properties['os.arch'].value
# A list of calculation scripts for metric values.
calculates:
- profile=#`$.activeProfiles[0]`
- port=#`$.propertySources[?(@.name=='server.ports')].properties.*.value`
- os=#`$.propertySources[?(@.name=='systemProperties')].properties['os.name'].value`
- jdk_vendor=#`$.propertySources[?(@.name=='systemProperties')].properties['jdk.vendor.version'].value`
- jvm_version=#`$.propertySources[?(@.name=='systemProperties')].properties['java.runtime.version'].value`
- os_arch=#`$.propertySources[?(@.name=='systemProperties')].properties['os.arch'].value`
# The protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
protocol: http
# Specific collection configuration when protocol is http protocol
http:
# http host: ipv4 ipv6 domain
host: ^_^host^_^
# http port
port: ^_^port^_^
# http url
url: ^_^base_path^_^/env
# http request method GET POST PUT DELETE PATCH
method: GET
# enable SSL/TLS, that is, whether it is http or https, the default is false
ssl: ^_^ssl^_^
# http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-api availability monitoring
parseType: jsonPath
# http response data parse script
parseScript: '$'
- name: thread_state
visible: false
priority: 2
fields:
- field: state
type: 1
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: ^_^base_path^_^/metrics/jvm.threads.states
method: GET
ssl: ^_^ssl^_^
parseType: jsonPath
parseScript: '$.availableTags[?(@.tag == "state")].values[*]'
- name: threads
priority: 3
fields:
- field: state
type: 1
instance: true
- field: size
type: 0
aliasFields:
- $.measurements[?(@.statistic == "VALUE")].value
calculates:
- state='^o^state^o^'
- size=#`$.measurements[?(@.statistic == "VALUE")].value`
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: ^_^base_path^_^/metrics/jvm.threads.states?tag=state:^o^state^o^
method: GET
ssl: ^_^ssl^_^
parseType: jsonPath
parseScript: '$'
- name: space_name
visible: false
priority: 4
fields:
- field: id
type: 1
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: ^_^base_path^_^/metrics/jvm.memory.used
method: GET
ssl: ^_^ssl^_^
parseType: jsonPath
parseScript: '$.availableTags[?(@.tag == "id")].values[*]'
- name: memory_used
priority: 5
fields:
- field: space
type: 1
instance: true
- field: mem_used
type: 0
unit: MB
aliasFields:
- $.measurements[?(@.statistic == "VALUE")].value
calculates:
- space="^o^id^o^"
- mem_used=#`$.measurements[?(@.statistic == "VALUE")].value`
units:
- mem_used=B->MB
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: ^_^base_path^_^/metrics/jvm.memory.used?tag=id:^o^id^o^
method: GET
ssl: ^_^ssl^_^
parseType: jsonPath
parseScript: '$'
- name: health
priority: 6
fields:
- field: status
type: 1
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: ^_^base_path^_^/health
method: GET
ssl: ^_^ssl^_^
parseType: default
- name: route_id
visible: false
priority: 7
fields:
- field: name
type: 1
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: ^_^base_path^_^/gateway/routes
method: GET
ssl: ^_^ssl^_^
parseType: jsonPath
parseScript: '$[*].route_id'
- name: route_info
priority: 8
fields:
- field: route_id
type: 1
instance: true
- field: predicate
type: 1
- field: uri
type: 1
- field: order
type: 0
aliasFields:
- $.predicate
- $.uri
- $.order
calculates:
- route_id="^o^name^o^"
- predicate=#`$.predicate`
- uri=#`$.uri`
- order=#`$.order`
protocol: http
http:
host: ^_^host^_^
port: ^_^port^_^
url: ^_^base_path^_^/gateway/routes/^o^name^o^
method: GET
ssl: ^_^ssl^_^
parseType: jsonPath
parseScript: '$'