# 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
category: bigdata
# The monitoring: airflow
app: airflow
# The monitoring i18n name
name:
  zh-CN: Apache Airflow
  en-US: Apache Airflow
# The description and help of this monitoring type
help:
  zh-CN: Hertzbeat 对 Apache Airflow 通用性能指标（airflow health、airflow version）进行采集监控。<br>您可以点击“<i>新建 Apache Airflow </i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: HertzBeat monitors Apache Airflow through general performance metrics such as airflow health and airflow version. You could click the "<i>New Apache Airflow</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
  zh-TW: Hertzbeat對Apache Airflow通用性能指標（airflow health、airflow version）進行採集監控。<br>您可以點擊“<i>新建 Apache Airflow</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/airflow/
  en-US: https://hertzbeat.apache.org/docs/help/airflow/
# 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
  # required-true or false
  - 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
    # required-true or false
    defaultValue: 8080

  - field: ssl
    name:
      zh-CN: 启用HTTPS
      en-US: HTTPS
    type: boolean
    hide: true
    required: true

  - field: timeout
    name:
      zh-CN: 超时时间(ms)
      en-US: Timeout(ms)
    type: number
    hide: true
    required: false

# collect metrics config list
metrics:
  - name: airflow_health
    i18n:
      zh-CN: airflow 健康状态
      en-US: airflow health status
    priority: 0
    fields:
      - field: metadatabase
        i18n:
          zh-CN: metadatabase 健康情况
          en-US: metadatabase status
        type: 1
      - field: scheduler
        i18n:
          zh-CN: scheduler 健康情况
          en-US: scheduler status
        type: 1
      - field: triggerer
        i18n:
          zh-CN: triggerer 健康情况
          en-US: triggerer status
        type: 1
    aliasFields:
      - $.metadatabase.status
      - $.scheduler.status
      - $.triggerer.status
    calculates:
      - metadatabase=$.metadatabase.status
      - scheduler=$.scheduler.status
      - triggerer=$.triggerer.status
    # 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
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url Indicates the path of the request interface
      url: /api/v1/health
      timeout: ^_^timeout^_^
      method: GET
      parseType: jsonPath
      parseScript: '$'

  - name: airflow_version
    i18n:
      zh-CN: Airflow 版本
      en-US: airflow version
    priority: 1
    fields:
      - field: version
        i18n:
          zh-CN: Airflow 版本
          en-US: Airflow version
        type: 1
      - field: git_version
        i18n:
          zh-CN: Airflow git版本
          en-US: git version
        type: 1
    protocol: http
    http:
      host: ^_^host^_^
      port: ^_^port^_^
      url: /api/v1/version
      timeout: ^_^timeout^_^
      method: GET
      parseType: jsonPath
      parseScript: '$'