# 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.

category: mid
app: shenyu
name:
  zh-CN: ShenYu网关
  en-US: Apache ShenYu
# The description and help of this monitoring type
help:
  zh-CN: Hertzbeat 通过调用 <a href="https://shenyu.apache.org/zh/docs/plugin-center/observability/metrics-plugin">ShenYu Metrics 插件</a> 对 ShenYu 网关的通用指标 (请求量、执行时间、JVM、内存占用、线程信息等) 进行采集监控。<br>注意⚠️：需要您提前 <a href="https://shenyu.apache.org/zh/docs/plugin-center/observability/metrics-plugin">开启暴露 ShenYu Metrics 插件暴露其数据接口</a>。您可以点击 “<i>新建 ShenYu</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: Hertzbeat monitors metrics of the ShenYu Gateway by calling the <a href="https://shenyu.apache.org/docs/plugin-center/observability/metrics-plugin">ShenYu Metrics Api</a>. <br>Note⚠️:You need to <a href="https://shenyu.apache.org/docs/plugin-center/observability/metrics-plugin">enable ShenYu Metrics Plugin</a> in advance. You can click "<i>New ShenYu</i>" and configure it, or select "<i>More Action</i>" to import the existing configuration.
  zh-TW: Hertzbeat 通過調用 <a href="https://shenyu.apache.org/zh/docs/plugin-center/observability/metrics-plugin">ShenYu Metrics 插件</a> 對 ShenYu 網關的通用指標 (請求量、執行時間、JVM、內存占用、線程信息等) 進行采集監控。<br>注意⚠️：需要您提前 <a href="https://shenyu.apache.org/zh/docs/plugin-center/observability/metrics-plugin">開啓暴露 ShenYu Metrics 插件暴露其數據接口</a>。您可以點擊 “<i>新建 ShenYu</i>” 並進行配置，或者選擇“<i>更多操作</i>”，導入已有配置。
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/shenyu
  en-US: https://hertzbeat.apache.org/docs/help/shenyu
params:
  - field: host
    name:
      zh-CN: 目标Host
      en-US: Target Host
    type: host
    required: true
  - field: port
    name:
      zh-CN: 端口
      en-US: Port
    type: number
    range: '[0,65535]'
    defaultValue: 8090
    required: true
  - field: timeout
    name:
      zh-CN: 查询超时时间
      en-US: Query Timeout
    type: number
    required: false
    hide: true
    defaultValue: 6000
metrics:
  - name: shenyu_request_total
    i18n:
      zh-CN: ShenYu请求总量
      en-US: ShenYu Request Total
    priority: 0
    fields:
      - field: value
        type: 0
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: shenyu_request_throw_created
    i18n:
      zh-CN: ShenYu请求异常总量
      en-US: ShenYu Request Exception Total
    priority: 1
    fields:
      # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field
      - field: value
        type: 0
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: process_cpu_seconds_total
    i18n:
      zh-CN: 进程 CPU 时间总量 (秒)
      en-US: Process CPU Time Total
    priority: 2
    fields:
      # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field
      - field: value
        type: 0
        unit: s
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: process_open_fds
    i18n:
      zh-CN: 进程打开的文件描述符数量
      en-US: Process Open Fds
    priority: 3
    fields:
      # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field
      - field: value
        type: 0
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: process_max_fds
    i18n:
      zh-CN: 进程最大文件描述符数量
      en-US: Process Max Fds
    priority: 4
    fields:
      # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field
      - field: value
        type: 0
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: jvm_info
    i18n:
      zh-CN: JVM 信息
      en-US: JVM Info
    priority: 5
    fields:
      # Metric information includes field name, type field type (0-number number, 1-string string), label-whether it is a metric label field, unit: metric unit
      - field: runtime
        type: 1
        i18n:
          zh-CN: 运行时
          en-US: Runtime
      - field: vendor
        type: 1
        i18n:
          zh-CN: 供应商
          en-US: Vendor
      - field: version
        type: 1
        i18n:
          zh-CN: 版本
          en-US: Version
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: jvm_memory_bytes_used
    i18n:
      zh-CN: JVM 内存使用字节数
      en-US: JVM Memory Bytes Used
    priority: 6
    fields:
      # Metric information includes field name, type field type (0-number number, 1-string string), label-whether it is a metric label field, unit: metric unit
      - field: area
        type: 1
        label: true
        i18n:
          zh-CN: 区域
          en-US: Area
      - field: value
        type: 0
        unit: MB
    units:
      - value=B->MB
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: jvm_memory_pool_bytes_used
    i18n:
      zh-CN: JVM 内存池使用字节数
      en-US: JVM Memory Pool Bytes Used
    priority: 7
    fields:
      # Metric information includes field name, type field type (0-number number, 1-string string), label-whether it is a metric label field, unit: metric unit
      - field: pool
        type: 1
        label: true
        i18n:
          zh-CN: 池
          en-US: Pool
      - field: value
        type: 0
        unit: MB
    units:
      - value=B->MB
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: jvm_memory_pool_bytes_committed
    i18n:
      zh-CN: JVM 内存池提交字节数
      en-US: JVM Memory Pool Bytes Committed
    priority: 8
    fields:
      # Metric information includes field name, type field type (0-number number, 1-string string), label-whether it is a metric label field, unit: metric unit
      - field: pool
        type: 1
        label: true
        i18n:
          zh-CN: 池
          en-US: Pool
      - field: value
        type: 0
        unit: MB
    units:
      - value=B->MB
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: jvm_memory_pool_bytes_max
    i18n:
      zh-CN: JVM 内存池最大字节数
      en-US: JVM Memory Pool Bytes Max
    priority: 9
    fields:
      # Metric information includes field name, type field type (0-number number, 1-string string), label-whether it is a metric label field, unit: metric unit
      - field: pool
        type: 1
        label: true
        i18n:
          zh-CN: 池
          en-US: Pool
      - field: value
        type: 0
        unit: MB
    units:
      - value=B->MB
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # Specific collection configuration when protocol is http protocol
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: jvm_threads_state
    i18n:
      zh-CN: JVM 线程状态
      en-US: JVM Threads State
    priority: 10
    fields:
      # Metric information includes field name, type field type (0-number number, 1-string string), label-whether it is a metric label field, unit: metric unit
      - field: state
        type: 1
        label: true
        i18n:
          zh-CN: 状态
          en-US: State
      - field: count
        type: 0
        i18n:
          zh-CN: 数量
          en-US: Count
    aliasFields:
      - state
      - value
    calculates:
      - count=value
    # Monitoring and collection usage protocol eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # This section describes how to configure data collection when protocol is http
    http:
      # Host: ipv4 ipv6 domain name
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: ''
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus