app-doris_fe.yml

# 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: bigdata
# The monitoring type eg: linux windows tomcat mysql aws...
app: doris_fe
# The monitoring i18n name
name:
  zh-CN: Apache Doris FE
  en-US: Apache Doris FE
# The description and help of this monitoring type
help:
  zh-CN: Hertzbeat 对 Doris 数据库FE的通用指标（doris_fe connection total、doris_fe edit log clean、doris_fe image、doris_fe rps等）进行测量监控，支持版本为DORIS2.0.0。<br>您可以点击 “<i>新建 Doris DatabaseFE</i>” 并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: Hertzbeat monitoring Doris DatabaseFE through general performance metric such as doris_fe connection total, doris_fe edit log clean, doris_fe image and doris_fe rps. The version we support is DORIS2.0.0. You could click the "<i>New Doris DatabaseFE Monitor</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>" menu.
  zh-TW: Hertzbeat 對 Doris 資料庫FE的通用名額（doris_fe connection total、doris_fe edit log clean、doris_fe image、doris_fe rps等）進行量測監控，支持版本為DORIS2.0.0。<br>您可以點擊“<i>新建Doris DatabaseFE</i>”並進行配寘，或者選擇“<i>更多操作</i>”，導入已有配寘。
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/doris_fe/
  en-US: https://hertzbeat.apache.org/docs/help/doris_fe/
# 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: port
    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]'
    # default value
    defaultValue: 8030
    required: true
  - field: timeout
    name:
      zh-CN: 查询超时时间
      en-US: Query Timeout
    type: number
    required: false
    # hide param-true or false
    hide: true
    defaultValue: 6000
metrics:
  - name: doris_fe_connection_total
    i18n:
      zh-CN: 连接总数
      en-US: Connection Total
    priority: 0
    fields:
      - field: value
        type: 0
        label: true
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # http host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_edit_log_clean
    i18n:
      zh-CN: 编辑日志清理
      en-US: Edit Log Clean
    priority: 0
    fields:
      - field: type
        type: 1
        label: true
      - field: value
        type: 0
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # http host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_edit_log
    i18n:
      zh-CN: 编辑日志
      en-US: Edit Log
    priority: 0
    fields:
      - field: type
        type: 1
        label: true
      - field: value
        type: 0
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # http host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_image_clean
    i18n:
      zh-CN: 图片清理
      en-US: Image Clean
    priority: 0
    fields:
      - field: type
        type: 1
        label: true
      - field: value
        type: 0
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_image_write
    i18n:
      zh-CN: 图片写入
      en-US: Image Write
    priority: 0
    fields:
      - field: type
        type: 1
        label: true
      - field: value
        type: 0
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_query_err
    i18n:
      zh-CN: 查询错误
      en-US: Query Error
    priority: 0
    fields:
      - field: value
        type: 0
        label: true
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # http host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_max_journal_id
    i18n:
      zh-CN: 最大日志ID
      en-US: Max Journal ID
    priority: 0
    fields:
      - field: value
        type: 0
        label: true
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_max_tablet_compaction_score
    i18n:
      zh-CN: 最大Tablet压缩分数
      en-US: Max Tablet Compaction Score
    priority: 0
    fields:
      - field: value
        type: 0
        label: true
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_qps
    i18n:
      zh-CN: 每秒查询率
      en-US: QPS
    priority: 0
    fields:
      - field: value
        type: 0
        label: true
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_query_err_rate
    i18n:
      zh-CN: 查询错误率
      en-US: Query Error Rate
    priority: 0
    fields:
      - field: value
        type: 0
        label: true
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # 主机host: ipv4 ipv6 域名
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  
  - name: doris_fe_report_queue_size
    i18n:
      zh-CN: 报告队列大小
      en-US: Report Queue Size
    priority: 0
    fields:
      - field: value
        type: 0
        label: true
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_rps
    i18n:
      zh-CN: 每秒转数
      en-US: RPS
    priority: 0
    fields:
      - field: value
        type: 0
        label: true
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_scheduled_tablet_num
    i18n:
      zh-CN: 调度 Tablet 数量
      en-US: Scheduled Tablet Num
    priority: 0
    fields:
      - field: value
        type: 0
        label: true
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus
  - name: doris_fe_txn_status
    i18n:
      zh-CN: 事务状态
      en-US: Transaction Status
    priority: 0
    fields:
      - field: type
        type: 1
        label: true
      - field: value
        type: 0
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # the config content when protocol is http
    http:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # url request interface path
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus