# 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 mid-middleware
# 监控类型所属类别：service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控 cn-云原生cloud native network-网络监控 mid-中间件
category: mid
# The monitoring: nacos
# 监控类型 nacos
app: nacos
# The monitoring i18n name
# 监控类型国际化名称
name:
  zh-CN: Nacos注册配置中心
  en-US: Nacos Server
# 监控所需输入参数定义(根据定义渲染页面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
  # required-true or false
  # required-是否是必输项 true-必填 false-可选
  - field: port
    # name-param field display i18n name
    # name-参数字段显示名称
    name:
      zh-CN: Nacos服务端口
      en-US: Nacos 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
    # required-true or false
    # required-是否是必输项 true-必填 false-可选
    defaultValue: 8848

# collect metrics config list
# 采集指标组配置列表
metrics:
  # metrics - system
  # 监控指标组 - system
  - name: system
    # 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: system_cpu_usage
        type: 0
        unit: '%'
      - field: system_average_load
        type: 0
      - field: system_memory_usage
        type: 0
        unit: '%'
    # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field
    # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
    aliasFields:
      - cpu
      - load
      - mem
    # mapping and conversion expressions, use these and aliasField above to calculate metrics value
    # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
    # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
    calculates:
      - system_cpu_usage=cpu * 100
      - system_average_load=load
      - system_memory_usage=mem * 100
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    # 监控使用协议, 例如: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    # 当使用http协议时的配置内容
    http:
        # http host: ipv4 ipv6 domain
        # http 主机：ipv4 ipv6域名
        host: ^_^host^_^
        # http port
        # http 端口
        port: ^_^port^_^
        # http url
        url: /nacos/v2/ns/operator/metrics?onlyStatus=false
        # http method: GET POST PUT DELETE PATCH
        # http 请求方法: GET POST PUT DELETE PATCH
        method: GET
        # 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
        parseScript: $.data

  - name: jvm_gc_count
    priority: 1
    fields:
      - field: total_gc_count
        type: 0
    aliasFields:
      - value
    calculates:
      - total_gc_count=value
    protocol: http
    http:
        host: ^_^host^_^
        port: ^_^port^_^
        url: /nacos/actuator/metrics/jvm.gc.pause
        method: GET
        parseType: jsonPath
        parseScript: $.measurements[0]

  - name: jvm_gc_time
    priority: 1
    fields:
      - field: total_gc_time
        type: 0
        unit: 's'
    aliasFields:
      - value
    calculates:
      - total_gc_time=value
    protocol: http
    http:
      host: ^_^host^_^
      port: ^_^port^_^
      url: /nacos/actuator/metrics/jvm.gc.pause
      method: GET
      parseType: jsonPath
      parseScript: $.measurements[1]

  - name: nacos
    priority: 1
    fields:
      - field: service_count
        type: 0
      - field: client_count
        type: 0
    aliasFields:
      - serviceCount
      - clientCount
    calculates:
      - service_count=serviceCount
      - client_count=clientCount
    protocol: http
    http:
      host: ^_^host^_^
      port: ^_^port^_^
      url: /nacos/v2/ns/operator/metrics?onlyStatus=false
      method: GET
      parseType: jsonPath
      parseScript: $.data