# 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 webserver-web server cache-cache cn-cloud native network-network monitoring, etc.
category: service
# The monitoring type name(consistent with the file name) eg: linux windows tomcat mysql aws...
app: nginx
# The app api i18n name
name:
  zh-CN: Nginx服务器
  en-US: Nginx Server
# The description and help of this monitoring type
help:
  zh-CN: HertzBeat 使用 <a class='help_module_content' href='https://www.tecmint.com/enable-nginx-status-page/'> Nginx </a> 通过配置 ngx_http_stub_status_module 对 nginx 的通用性能指标(nginx_status、req_status等)进行采集监控。<br>您可以点击“<i>新建 nginx</i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: HertzBeat uses <a class='help_module_content' href='https://www.tecmint.com/enable-nginx-status-page/'> Nginx </a> to configure ngx_http_stub_status_module for collecting general metrics of Nginx (nginx_status, req_status.). <br>You can click "<i>New Nginx</i>" and configure it, or select "<i>More Operations</i>" to import the existing configuration.
  zh-TW: HertzBeat 使用 <a class='help_module_content' href='https://www.tecmint.com/enable-nginx-status-page/'> Nginx </a> 通過配置 ngx_http_stub_status_module 對 Nginx 數據庫的通用性能指標(nginx信息、请求信息等)進行采集監控。<br>您可以點擊“<i>新建 Nginx</i>”並進行配置，或者選擇“<i>更多操作</i>”，導入已有配置。
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/nginx
  en-US: https://hertzbeat.apache.org/docs/help/nginx
# Input params define for app api(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: 80
  # field-param field key
  - field: timeout
    # name-param field display i18n name
    name:
      zh-CN: 连接超时时间(ms)
      en-US: Connect Timeout(ms)
    # type-param field type(most mapping the html input type)
    type: number
    # when type is number, range is required
    range: '[0,100000]'
    # required-true or false
    required: true
    # default value 6000
    defaultValue: 6000
  # 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

# collect metrics config list
metrics:
  # metrics - available
  - name: available
    i18n:
      zh-CN: 可用性
      en-US: 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
        i18n:
          zh-CN: 响应时间
          en-US: Response Time
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: nginx
    # Specific collection configuration when protocol is http protocol
    nginx:
      # http host: ipv4 ipv6 domain
      host: ^_^host^_^
      # http port
      port: ^_^port^_^
      # timeout
      timeout: ^_^timeout^_^
      # ssl
      ssl: ^_^ssl^_^

  - name: nginx_status
    i18n:
      zh-CN: Nginx 状态信息
      en-US: Nginx Status
    # 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: 1
    fields:
      - field: accepts
        type: 0
        i18n:
          zh-CN: 接受连接数
          en-US: Accepts
      - field: handled
        type: 0
        i18n:
          zh-CN: 成功处理连接数
          en-US: Handled
      - field: active
        type: 0
        i18n:
          zh-CN: 当前活跃连接数
          en-US: Active
      - field: dropped
        type: 0
        i18n:
          zh-CN: 已丢弃连接数
          en-US: Dropped
      - field: requests
        type: 0
        i18n:
          zh-CN: 客户端请求数
          en-US: Requests
      - field: reading
        type: 0
        i18n:
          zh-CN: 正在执行读操作的连接数
          en-US: Reading
      - field: writing
        type: 0
        i18n:
          zh-CN: 正在执行写操作的连接数
          en-US: Writing
      - field: waiting
        type: 0
        i18n:
          zh-CN: 正在等待的连接数
          en-US: Waiting
    # Alias field list, used to identify metrics in the query result
    aliasFields:
      - accepts
      - handled
      - active
      - dropped
      - requests
      - reading
      - writing
      - waiting
    # A list of calculation scripts for metric values.
    calculates:
      - dropped=accepts - handled
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk, nginx
    protocol: nginx
    # the config content when protocol is http
    nginx:
      # http host: ipv4 ipv6 domain
      host: ^_^host^_^
      # http port
      port: ^_^port^_^
      # timeout
      timeout: ^_^timeout^_^
      # http url
      url: /nginx-status
      # ssl
      ssl: ^_^ssl^_^

  - name: req_status
    i18n:
      zh-CN: 请求详细信息
      en-US: Req Status
    # 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: 2
    fields:
      - field: zone_name
        type: 1
        i18n:
          zh-CN: 分组类别
          en-US: Zone Name
      - field: key
        type: 1
        i18n:
          zh-CN: 分组名称
          en-US: Key
      - field: max_active
        type: 0
        i18n:
          zh-CN: 最大并发连接数
          en-US: Max Active
      - field: max_bw
        type: 0
        unit: KB
        i18n:
          zh-CN: 最大带宽
          en-US: Max BW
      - field: traffic
        type: 0
        unit: KB
        i18n:
          zh-CN: 总流量
          en-US: Traffic
      - field: requests
        type: 0
        i18n:
          zh-CN: 总请求数
          en-US: Requests
      - field: active
        type: 0
        i18n:
          zh-CN: 当前并发连接数
          en-US: Active
      - field: bandwidth
        type: 0
        unit: KB
        i18n:
          zh-CN: 当前带宽
          en-US: Bandwidth
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: nginx
    # the config content when protocol is http
    nginx:
      # http host: ipv4 ipv6 domain
      host: ^_^host^_^
      # http port
      port: ^_^port^_^
      # timeout
      timeout: ^_^timeout^_^
      # http url
      url: /req-status
      # ssl
      ssl: ^_^ssl^_^