# 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 mid-middleware custom-custom monitoring os-operating system monitoring
category: service
# The monitoring type eg: linux windows tomcat mysql aws...
app: smtp
# The app api i18n name
name:
  zh-CN: SMTP邮件服务器
  en-US: SMTP Email Server
# The description and help of this monitoring type
help:
  zh-CN: HertzBeat 对 SMTP 服务的(Banner,helo响应)相关指标进行监测。<br>您可以点击 “<i>新建 SMTP</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: HertzBeat monitors the banner and hello response related metrics of the SMTP service.<br>You can click "<i>New SMTP</i>" and configure it, or select "<i>More Action</i>" to import the existing configuration.
  zh-TW: HertzBeat對SMTP服務的（Banner，helo響應）相關名額進行監測。<br>您可以點擊 “<i>新建 ShenYu</i>” 並進行配置，或者選擇“<i>更多操作</i>”，導入已有配置。
# 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: SMTP的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 25
    defaultValue: 25
  # 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: email
    name:
      zh-CN: email
      en-US: email
    type: text
    # required-true or false
    required: true
# collect metrics config list
metrics:
  # metrics - summary
  - 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
      - field: response
        type: 1
        i18n:
          zh-CN: 响应状态
          en-US: Response
      - field: smtpBanner
        type: 1
        i18n:
          zh-CN: SMTP Banner
          en-US: SMTP Banner
      - field: heloInfo
        type: 1
        i18n:
          zh-CN: Helo日志
          en-US: HeloInfo
#      - field: emailMaxSize
#        type: 0
#        unit: byte
#        i18n:
#          zh-CN: 最大邮件大小
#          en-US: EmailMaxSize
#      - field: serverInfo
#        type: 1
#        i18n:
#          zh-CN: 服务器相关信息
#          en-US: ServerInfo
#      - field: heloInfo
#        type: 1
#        i18n:
#          zh-CN: Helo日志
#          en-US: HeloInfo

    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: smtp
    # Specific collection configuration when protocol is telnet protocol
    smtp:
      # telnet host
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # timeout
      timeout: ^_^timeout^_^
      # email
      email: ^_^email^_^