# 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
# 此监控类型所属类别：service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控
category: service
# Monitoring application type name (consistent with file name) eg: linux windows tomcat mysql aws...
# 监控应用类型名称(与文件名保持一致) eg: linux windows tomcat mysql aws...
app: ping
# 监控类型国际化名称
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.com/zh-cn/docs/help/ping
  en-US: https://hertzbeat.com/docs/help/ping
# 监控所需输入参数定义(根据定义渲染页面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
    # 是否是必输项 true-必填 false-可选
    required: true
  # field-param field key
  # field-字段名称标识符
  - field: timeout
    # name-param field display i18n name
    # name-参数字段显示名称
    name:
      zh-CN: Ping超时时间(ms)
      en-US: Ping Timeout(ms)
    # 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,100000]'
    # required-true or false
    # 是否是必输项 true-必填 false-可选
    required: true
    # default value 6000
    # 默认值 6000
    defaultValue: 6000
# collect metrics config list
# 采集指标组配置列表
metrics:
  # First monitoring metric group "cpu"
  # 第一个监控指标组 cpu
  # Note: The built-in monitoring metrics include (responseTime - response time)
  # 注意：内置监控指标有 (responseTime - 响应时间)
  - name: summary
    i18n:
      zh-CN: 概要
      en-US: Summary
    # 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
    # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
    # 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-是否是指标集合唯一标识符字段
    fields:
      - field: responseTime
        type: 0
        unit: ms
        i18n:
          zh-CN: 响应时间
          en-US: ResponseTime
    # Monitoring and collection protocols eg: sql, ssh, http, telnet, wmi, snmp, sdk
    # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: icmp
    # Specific collection configuration when the protocol is the ping protocol
    # 当protocol为ping协议时具体的采集配置
    icmp:
      # icmp host
      # icmp 主机
      host: ^_^host^_^
      # timeout
      # 超时时间
      timeout: ^_^timeout^_^