# 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
category: mid
# The monitoring: nacos
app: nacos
# The monitoring i18n name
name:
  zh-CN: Nacos分布式
  en-US: Nacos Server
# The description and help of this monitoring type
help:
  zh-CN: Hertzbeat 通过调用 <a href="https://nacos.io/zh-cn/docs/monitor-guide.html">Nacos Metrics 接口</a> 对 Nacos 注册配置中心服务的通用指标进行采集监控。<br>注意⚠️：需要您提前 <a href="https://nacos.io/zh-cn/docs/monitor-guide.html">开启暴露 Nacos Metrics 数据</a>，支持 Nacos 版本0.8+，您可以点击 “<i>新建 Nacos</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: Hertzbeat monitors metrics of the Nacos Server by calling the <a href="https://nacos.io/en-us/docs/monitor-guide.html">Nacos Metrics Api</a>. <br>Note⚠️:You need to <a href="https://nacos.io/en-us/docs/monitor-guide.html">enable exposure of Nacos Metrics data</a> in advance, support Nacos version 0.8+ , you can click "<i>New Nacos</i>" and configure it, or select "<i>More Action</i>" to import the existing configuration.
  zh-TW: Hertzbeat 通過調用 <a href="https://nacos.io/zh-cn/docs/monitor-guide.html">Nacos Metrics 接口</a> 對 Nacos 注冊配置中心服務的通用指標進行采集監控。<br>注意⚠️：需要您提前 <a href="https://nacos.io/zh-cn/docs/monitor-guide.html">開啓暴露 Nacos Metrics 數據</a>，支持 Nacos 版本0.8+，您可以點擊 “<i>新建 Nacos</i>” 並進行配置，或者選擇“<i>更多操作</i>”，導入已有配置。
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/nacos
  en-US: https://hertzbeat.apache.org/docs/help/nacos
# 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
  # required-true or false
  - field: port
    # name-param field display i18n name
    name:
      zh-CN: Nacos服务端口
      en-US: Nacos 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
    # required-true or false
    defaultValue: 8848

# collect metrics config list
metrics:
  - name: system_cpu_usage
    i18n:
      zh-CN: CPU 使用率
      en-US: CPU Usage
    # 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
    fields:
      - field: usage
        type: 0
        unit: '%'
        i18n:
          zh-CN: 使用率
          en-US: Usage
    aliasFields:
      - value
    calculates:
      - usage=value
    protocol: http
    # the config content when protocol is http
    http:
      # http host: ipv4 ipv6 domain
      host: ^_^host^_^
      # http port
      port: ^_^port^_^
      # http url
      url: /nacos/actuator/prometheus
      # http method: 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
      parseType: prometheus

  - name: jvm_memory_used_bytes
    i18n:
      zh-CN: JVM 内存使用
      en-US: JVM Memory Used
    priority: 1
    fields:
      - field: area
        type: 1
        i18n:
          zh-CN: 区域
          en-US: Area
      - field: id
        type: 1
        label: true
        i18n:
          zh-CN: ID
          en-US: ID
      - field: value
        type: 0
        unit: MB
        i18n:
          zh-CN: 大小
          en-US: Size
    units:
      - value=B->MB
    # 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^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: /nacos/actuator/prometheus
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: nacos_monitor
    i18n:
      zh-CN: Nacos 详情
      en-US: Nacos Monitor
    priority: 2
    fields:
      - field: module
        type: 1
        i18n:
          zh-CN: 模块
          en-US: Module
      - field: name
        type: 1
        i18n:
          zh-CN: 指标名称
          en-US: Metric Name
      - field: value
        type: 0
        i18n:
          zh-CN: 大小
          en-US: Value
    # The protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # The config content when protocol is http
    http:
      # Host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: /nacos/actuator/prometheus
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus