# 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 of this monitoring type:
# service - application service monitoring
# db - database monitoring
# custom - custom monitoring
# os - operating system monitoring
category: service
# Monitoring application type name (consistent with file name) eg: linux windows tomcat mysql aws...
app: ping
# The app api i18n name
name:
  zh-CN: PING连通性
  en-US: PING CONNECT
# The description and help of this monitoring type
help:
  zh-CN: HertzBeat 以 ms 为指标单位，对端 HOST 地址进行 PING 操作，判断其连通性。您可以点击“<i>新建 PING 连通性</i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: HertzBeat uses 'ms' as the metric unit to PING the end HOST address and determines the connectivity. You could click the "Add API " button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
  zh-TW: HertzBeat 以 ms 爲指標單位，對端 HOST 地址進行 PING 操作，判斷其連通性。您可以點擊“<i>新建 PING 連通性</i>”並進行配置，或者選擇“<i>更多操作</i>”，導入已有配置。
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/ping
  en-US: https://hertzbeat.apache.org/docs/help/ping
# 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: timeout
    # name-param field display i18n name
    name:
      zh-CN: Ping超时时间(ms)
      en-US: Ping 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
# collect metrics config list
metrics:
  # First monitoring metric group summary
  # Note: The built-in monitoring metrics include (responseTime - response time)
  - name: summary
    i18n:
      zh-CN: 概要
      en-US: Summary
    # 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
    # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field
    fields:
      - field: responseTime
        type: 0
        unit: ms
        i18n:
          zh-CN: 响应时间
          en-US: Response Time
    # Monitoring and collection protocols eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: icmp
    # Specific collection configuration when the protocol is the ping protocol
    icmp:
      # icmp host
      host: ^_^host^_^
      # timeout
      timeout: ^_^timeout^_^