app-tidb.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.

# The monitoring type category：service-application service monitoring db-database monitoring custom-custom monitoring os-operating system monitoring
category: db
# The monitoring type eg: linux windows tomcat mysql aws...
app: tidb
# The monitoring i18n name
name:
  zh-CN: TiDB数据库
  en-US: TiDB
  ja-JP: TiDB データベース
# The description and help of this monitoring type
help:
  zh-CN: HertzBeat 使用 HTTP 和 JDBC 协议对 TiDB 的通用性能指标进行采集监控，点击查看开启步骤</a>。<br>您可以点击“<i>新建 TiDB 数据库</i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: HertzBeat monitors general performance metrics of TiDB through HTTP and JDBC protocol. <br> You could click the "<i>New TiDB</i>" button and proceed with the configuration or import an existing setup through the "<i>More Actions</i>".
  zh-TW: HertzBeat 使用 HTTP 和 JDBC 協議對 TiDB 的通用性能指標進行採集監控，點擊查看開啟步驟</a>。 <br>您可以點擊“<i>新建 TiDB 數據庫</i>”並進行配置，或者選擇“<i>更多操作</i>”，導入已有配置。
  ja-JP: Hertzbeat は HTTP と JDBCプロトコルを介して TiDB データベースの一般的なパフォーマンスのメトリクスを監視します。<br>「<i>新規 TiDB データベース</i>」をクリックしてパラメタを設定した後、新規することができます。
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/tidb
  en-US: https://hertzbeat.apache.org/docs/help/tidb
# 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
      ja-JP: 目標ホスト
    # 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: JDBC 端口
      en-US: JDBC Port
      ja-JP: JDBCポート
    # 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: false
    defaultValue: 4000
    # hide param-true or false
    hide: true
  - field: service-port
    name:
      zh-CN: Service 端口
      en-US: Service Port
      ja-JP: サービスポート
    type: number
    range: '[0,65535]'
    required: true
    defaultValue: 10080

  - field: pd-port
    name:
      zh-CN: PD 端口
      en-US: PD Port
      ja-JP: PDポート
    type: number
    range: '[0,65535]'
    required: false
    defaultValue: 2379

  - field: timeout
    name:
      zh-CN: 查询超时时间(ms)
      en-US: Query Timeout(ms)
      ja-JP: クエリタイムアウト（ｍｓ）
    type: number
    required: false
    defaultValue: 6000

  - field: database
    name:
      zh-CN: 数据库名称
      en-US: Database Name
      ja-JP: データベース名
    type: text
    required: false
    hide: true

  - field: username
    name:
      zh-CN: 用户名
      en-US: Username
      ja-JP: ユーザー名
    type: text
    limit: 50
    required: false
    hide: true

  - field: password
    name:
      zh-CN: 密码
      en-US: Password
      ja-JP: パスワード
    type: password
    required: false
    hide: true

  - field: url
    name:
      zh-CN: JDBC URL
      en-US: JDBC URL
      ja-JP: JDBC URL
    type: text
    required: false
    hide: true
# collect metrics config list
metrics:
  # metrics - status
  - name: status
    i18n:
      zh-CN: 状态
      en-US: Status
      ja-JP: ステータス
    # 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
    # collect metrics content
    fields:
      # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field
      - field: connections
        type: 0
        i18n:
          zh-CN: 连接数
          en-US: Connections
          ja-JP: 接続数
      - field: version
        type: 1
        i18n:
          zh-CN: 版本
          en-US: Version
          ja-JP: バージョン
      - field: git_hash
        type: 1
        i18n:
          zh-CN: Git Hash
          en-US: Git Hash
          ja-JP: Git Hash
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    http:
      # http host: ipv4 ipv6 domain
      host: ^_^host^_^
      # http port
      port: ^_^service-port^_^
      # http url
      url: '/status'
      timeout: ^_^timeout^_^
      # http method: GET POST PUT DELETE PATCH
      method: GET
      # http response data parse type: default-hertzbeat rule, jsonpath-jsonpath script, website-for website monitoring, prometheus-prometheus exporter rule
      parseType: jsonPath
      parseScript: '$'
      
  - name: stores
    i18n:
      zh-CN: 存储
      en-US: Stores
      ja-JP: ストレージ
    priority: 1
    fields:
      - field: address
        type: 1
        i18n:
          zh-CN: 地址
          en-US: Address
          ja-JP: アドレス
      - field: version
        type: 1
        i18n:
          zh-CN: 版本
          en-US: Version
          ja-JP: バージョン
      - field: status_address
        type: 1
        i18n:
          zh-CN: 状态地址
          en-US: Status Address
          ja-JP: ステータスアドレス
      - field: deploy_path
        type: 1
        i18n:
          zh-CN: 部署路径
          en-US: Deploy Path
          ja-JP: デプロイパス
      - field: state_name
        type: 1
        i18n:
          zh-CN: 状态名称
          en-US: State Name
          ja-JP: 状態名
      - field: capacity
        type: 1
        i18n:
          zh-CN: 容量
          en-US: Capacity
          ja-JP: 容量
      - field: available
        type: 1
        i18n:
          zh-CN: 可用
          en-US: Available
          ja-JP: 使用可能
      - field: used_size
        type: 1
        i18n:
          zh-CN: 已用
          en-US: Used
          ja-JP: 使用済み
      - field: start_ts
        type: 1
        i18n:
          zh-CN: 启动时间
          en-US: Start Time
          ja-JP: 起動時間
      - field: last_heartbeat_ts
        type: 1
        i18n:
          zh-CN: 上次心跳时间
          en-US: Last Heartbeat Time
          ja-JP: 最後のハートビート時間
      - field: uptime
        type: 1
        i18n:
          zh-CN: 启动时长
          en-US: Uptime
          ja-JP: アップタイム
    aliasFields:
      - $.store.address
      - $.store.version
      - $.store.status_address
      - $.store.deploy_path
      - $.store.state_name
      - $.status.capacity
      - $.status.available
      - $.status.used_size
      - $.status.start_ts
      - $.status.last_heartbeat_ts
      - $.status.uptime
    calculates:
      - address=$.store.address
      - version=$.store.version
      - status_address=$.store.status_address
      - deploy_path=$.store.deploy_path
      - state_name=$.store.state_name
      - capacity=$.status.capacity
      - available=$.status.available
      - used_size=$.status.used_size
      - start_ts=$.status.start_ts
      - last_heartbeat_ts=$.status.last_heartbeat_ts
      - uptime=$.status.uptime
    protocol: http
    http:
      host: ^_^host^_^
      port: ^_^pd-port^_^
      url: '/pd/api/v1/stores'
      timeout: ^_^timeout^_^
      method: GET
      parseType: jsonPath
      parseScript: '$.stores.*'

  - name: basic
    i18n:
      zh-CN: 基本信息
      en-US: Basic Info
      ja-JP: 基礎情報
    # 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: 2
    # collect metrics content
    fields:
      # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-whether it is a metrics label field
      - field: version
        type: 1
        i18n:
          zh-CN: 版本
          en-US: Version
          ja-JP: バージョン
        label: true
      - field: port
        type: 1
        i18n:
          zh-CN: 端口
          en-US: Port
          ja-JP: ポート
      - field: datadir
        type: 1
        i18n:
          zh-CN: 数据目录
          en-US: Data Directory
          ja-JP: データディレクトリ
      - field: max_connections
        type: 0
        i18n:
          zh-CN: 最大连接数
          en-US: Max Connections
          ja-JP: 最大接続数
    # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field
    aliasFields:
      - version
      - port
      - datadir
      - max_connections
    # (optional)mapping and conversion expressions, use these and aliasField above to calculate metrics value
    # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
    calculates:
      - port=port
      - datadir=datadir
      - max_connections=max_connections
      - version=version+"_"+version_compile_os+"_"+version_compile_machine
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: jdbc
    # the config content when protocol is jdbc
    jdbc:
      # host: ipv4 ipv6 host
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      # database platform name
      platform: mysql
      username: ^_^username^_^
      password: ^_^password^_^
      database: ^_^database^_^
      timeout: ^_^timeout^_^
      # SQL Query Method：oneRow, multiRow, columns
      queryType: columns
      # sql
      sql: show global variables where Variable_name like 'version%' or Variable_name = 'max_connections' or Variable_name = 'datadir' or Variable_name = 'port';
      # JDBC url
      url: ^_^url^_^


  - name: account_expiry
    priority: 14
    i18n:
      zh-CN: 账户过期信息
      en-US: Account Expiry Info
      ja-JP: アカウント有効期限情報
    fields:
      - field: user
        type: 1
        label: true
        i18n:
          zh-CN: 用户名
          en-US: User
          ja-JP: ユーザー名
      - field: host
        type: 1
        label: true
        i18n:
          zh-CN: 主机
          en-US: Host
          ja-JP: ホスト
      - field: password_expired
        type: 1
        i18n:
          zh-CN: 密码是否过期
          en-US: Password Expired
          ja-JP: パスワード期限切れ
      - field: password_lifetime
        type: 0
        unit: days
        i18n:
          zh-CN: 密码生命周期(天)
          en-US: Password Lifetime (days)
          ja-JP: パスワード有効期限（日）
      - field: password_last_changed
        type: 1
        i18n:
          zh-CN: 密码最后修改时间
          en-US: Password Last Changed
          ja-JP: パスワード最終変更
      - field: days_until_expiry
        type: 0
        unit: days
        i18n:
          zh-CN: 距离过期天数
          en-US: Days Until Expiry
          ja-JP: 有効期限までの日数
    protocol: jdbc
    jdbc:
      host: ^_^host^_^
      port: ^_^port^_^
      platform: mysql
      username: ^_^username^_^
      password: ^_^password^_^
      database: ^_^database^_^
      timeout: ^_^timeout^_^
      queryType: multiRow
      sql: SELECT User, Host, password_expired, IF(password_lifetime IS NULL OR password_lifetime = 0, 0, password_lifetime) as password_lifetime, password_last_changed, DATEDIFF(DATE_ADD(password_last_changed, INTERVAL IFNULL(password_lifetime, 0) DAY), CURDATE()) as days_until_expiry FROM mysql.user WHERE User != '' ORDER BY days_until_expiry ASC;
      url: ^_^url^_^