app-iotdb.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: db
app: iotdb
name:
  zh-CN: IoTDB数据库
  en-US: IoTDB
params:
  - field: host
    name:
      zh-CN: 主机Host
      en-US: Host
    type: host
    required: true
  - field: port
    name:
      zh-CN: 端口
      en-US: Port
    type: number
    range: '[0,65535]'
    defaultValue: 9091
    required: true
  - field: timeout
    name:
      zh-CN: 查询超时时间
      en-US: Query Timeout
    type: number
    required: false
    hide: true
    defaultValue: 6000
metrics:
  - name: cluster_node_status
    priority: 0
    fields:
      - field: name
        type: 1
        instance: true
      - field: status
        type: 0
    aliasFields:
      - name
      - value
    calculates:
      - name=name
      - status=value
    # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # 当protocol为http协议时具体的采集配置
    http:
      # 主机host: ipv4 ipv6 域名
      host: ^_^host^_^
      # 端口
      port: ^_^port^_^
      # url请求接口路径
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: jvm_memory_committed_bytes
    # 指标组调度优先级(0-127)越小优先级越高,优先级低的指标组会等优先级高的指标组采集完成后才会被调度,相同优先级的指标组会并行调度采集
    # 优先级为0的指标组为可用性指标组,即它会被首先调度,采集成功才会继续调度其它指标组,采集失败则中断调度
    priority: 1
    fields:
      # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
      - field: area
        type: 1
      - field: id
        type: 1
        instance: true
      - field: value
        type: 0
        unit: MB
    units:
      - value=B->MB
    # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # 当protocol为http协议时具体的采集配置
    http:
      # 主机host: ipv4 ipv6 域名
      host: ^_^host^_^
      # 端口
      port: ^_^port^_^
      # url请求接口路径
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: jvm_memory_used_bytes
    # 指标组调度优先级(0-127)越小优先级越高,优先级低的指标组会等优先级高的指标组采集完成后才会被调度,相同优先级的指标组会并行调度采集
    # 优先级为0的指标组为可用性指标组,即它会被首先调度,采集成功才会继续调度其它指标组,采集失败则中断调度
    priority: 1
    fields:
      # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
      - field: area
        type: 1
      - field: id
        type: 1
        instance: true
      - field: value
        type: 0
        unit: MB
    units:
      - value=B->MB
    # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # 当protocol为http协议时具体的采集配置
    http:
      # 主机host: ipv4 ipv6 域名
      host: ^_^host^_^
      # 端口
      port: ^_^port^_^
      # url请求接口路径
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: jvm_threads_states_threads
    priority: 1
    fields:
      # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
      - field: state
        type: 1
        instance: true
      - field: count
        type: 0
    aliasFields:
      - state
      - value
    calculates:
      - count=value
    # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # 当protocol为http协议时具体的采集配置
    http:
      # 主机host: ipv4 ipv6 域名
      host: ^_^host^_^
      # 端口
      port: ^_^port^_^
      # url请求接口路径
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: quantity
    priority: 1
    fields:
      # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
      - field: id
        type: 1
        instance: true
      - field: name
        type: 1
      - field: type
        type: 1
      - field: value
        type: 0
    aliasFields:
      - name
      - type
      - value
    calculates:
      - id=name+"-"+type
    # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # 当protocol为http协议时具体的采集配置
    http:
      # 主机host: ipv4 ipv6 域名
      host: ^_^host^_^
      # 端口
      port: ^_^port^_^
      # url请求接口路径
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: cache_hit
    priority: 1
    fields:
      # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
      - field: name
        type: 1
        instance: true
      - field: value
        type: 0
    # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # 当protocol为http协议时具体的采集配置
    http:
      # 主机host: ipv4 ipv6 域名
      host: ^_^host^_^
      # 端口
      port: ^_^port^_^
      # url请求接口路径
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: queue
    priority: 1
    fields:
      # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
      - field: id
        type: 1
        instance: true
      - field: name
        type: 1
      - field: status
        type: 1
      - field: value
        type: 0
    aliasFields:
      - name
      - status
      - value
    calculates:
      - id=name+"-"+status
    # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # 当protocol为http协议时具体的采集配置
    http:
      # 主机host: ipv4 ipv6 域名
      host: ^_^host^_^
      # 端口
      port: ^_^port^_^
      # url请求接口路径
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus

  - name: thrift_connections
    priority: 1
    fields:
      # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
      - field: name
        type: 1
        instance: true
      - field: connection
        type: 0
    aliasFields:
      - name
      - value
    calculates:
      - connection=value
    # 监控采集使用协议 eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: http
    # 当protocol为http协议时具体的采集配置
    http:
      # 主机host: ipv4 ipv6 域名
      host: ^_^host^_^
      # 端口
      port: ^_^port^_^
      # url请求接口路径
      url: '/metrics'
      timeout: ^_^timeout^_^
      method: GET
      parseType: prometheus