# 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: opengauss
name:
  zh-CN: OpenGauss数据库
  en-US: OpenGauss DB
# The description and help of this monitoring type
help:
  zh-CN: HertzBeat 使用 <a class='help_module_content' href='https://hertzbeat.apache.org/docs/advanced/extend-jdbc'> JDBC 协议</a> 通过配置 SQL 对 OpenGauss 数据库的通用性能指标 (basic、state、activity etc) 进行采集监控，支持版本为 PostgreSQL10+。<br>您可以点击“<i>新建 OpenGauss 数据库</i>”并进行配置，或者选择“<i>更多操作</i>”，导入已有配置。
  en-US: HertzBeat uses <a class='help_module_content' href='https://hertzbeat.apache.org/docs/advanced/extend-jdbc'> JDBC Protocol</a> to configure SQL for collecting general metrics of OpenGauss database  (basic、state、activity etc). Supported version is PostgreSQL10+. <br>You can click "<i>New OpenGauss Database</i>" and configure it, or select "<i>More Action</i>" to import the existing configuration.
  zh-TW: HertzBeat 使用 <a class='help_module_content' href='https://hertzbeat.apache.org/docs/advanced/extend-jdbc'> JDBC 協議</a> 通過配置 SQL 對 OpenGauss 數據庫的通用性能指標 (basic、state、activity etc)進行采集監控，支持版本爲 PostgreSQL10+。<br>您可以點擊“<i>新建 OpenGauss 數據庫</i>”並進行配置，或者選擇“<i>更多操作</i>”，導入已有配置。
helpLink:
  zh-CN: https://hertzbeat.apache.org/zh-cn/docs/help/opengauss
  en-US: https://hertzbeat.apache.org/docs/help/opengauss
params:
  - field: host
    name:
      zh-CN: 目标Host
      en-US: Target Host
    type: host
    required: true
  - field: port
    name:
      zh-CN: 端口
      en-US: Port
    type: number
    range: '[0,65535]'
    required: true
    defaultValue: 5432
  - field: timeout
    name:
      zh-CN: 查询超时时间(ms)
      en-US: Query Timeout(ms)
    type: number
    # when type is number, range is required
    # 当type为number时,用range表示范围
    range: '[400,200000]'
    required: false
    hide: true
    defaultValue: 6000
  - field: database
    name:
      zh-CN: 数据库名称
      en-US: Database Name
    type: text
    defaultValue: postgres
    required: false
  - field: username
    name:
      zh-CN: 用户名
      en-US: Username
    type: text
    limit: 20
    required: false
  - field: password
    name:
      zh-CN: 密码
      en-US: Password
    type: password
    required: false
  - field: url
    name:
      zh-CN: URL
      en-US: URL
    type: text
    required: false
    hide: true
metrics:
  - name: basic
    # 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
    # 指标调度优先级(0-127)越小优先级越高,优先级低的指标会等优先级高的指标采集完成后才会被调度,相同优先级的指标会并行调度采集
    # 优先级为0的指标为可用性指标,即它会被首先调度,采集成功才会继续调度其它指标,采集失败则中断调度
    i18n:
      zh-CN: 基本信息
      en-US: Basic Info
    priority: 0
    # monitor metrics list
    fields:
      # metric information includes field name, type field type: 0-number, 1-string, label-whether it is a metric label field, unit-metric unit
      - field: server_version
        i18n:
          zh-CN: 数据库版本
          en-US: Server Version
        type: 1
        label: true
      - field: port
        i18n:
          zh-CN: 端口号
          en-US: Port
        type: 1
      - field: server_encoding
        i18n:
          zh-CN: 数据库编码格式
          en-US: Encoding
        type: 1
      - field: data_directory
        i18n:
          zh-CN: 数据存储目录
          en-US: Data Directory
        type: 1
      - field: max_connections
        i18n:
          zh-CN: 最大连接数
          en-US: Max Connection
        type: 0
        unit: sbc
    protocol: jdbc
    jdbc:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      timeout: ^_^timeout^_^
      platform: postgresql
      username: ^_^username^_^
      password: ^_^password^_^
      database: ^_^database^_^
      # SQL query method: oneRow, multiRow, columns
      queryType: columns
      # sql
      sql: select name, setting as value from pg_settings where name = 'max_connections' or name = 'server_version' or name = 'server_encoding' or name = 'port' or name = 'data_directory';
      url: ^_^url^_^

  - name: state
    i18n:
      zh-CN: 状态
      en-US: Status
    priority: 1
    fields:
      # metric information includes field name, type field type: 0-number, 1-string, label-whether it is a metric label field, unit-metric unit
      - field: name
        i18n:
          zh-CN: 名称
          en-US: Name
        type: 1
      - field: conflicts
        i18n:
          zh-CN: 冲突次数
          en-US: Conflicts
        type: 0
        unit: times
      - field: deadlocks
        i18n:
          zh-CN: 死锁次数
          en-US: Deadlocks
        type: 0
        unit: times
      - field: blks_read
        i18n:
          zh-CN: 块读取数
          en-US: Blocks Read
        type: 0
        unit: blocks per second
      - field: blks_hit
        i18n:
          zh-CN: 块命中数
          en-US: Blocks Hit
        type: 0
        unit: blocks per second
      - field: blk_read_time
        i18n:
          zh-CN: 块读取时间
          en-US: Block Read Time
        type: 0
        unit: ms
      - field: blk_write_time
        i18n:
          zh-CN: 块写入时间
          en-US: Block Write
        type: 0
        unit: ms
      - field: stats_reset
        i18n:
          zh-CN: 统计信息重置时间
          en-US: States Reset
        type: 1
    protocol: jdbc
    jdbc:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      timeout: ^_^timeout^_^
      platform: postgresql
      username: ^_^username^_^
      password: ^_^password^_^
      database: ^_^database^_^
      # SQL query method: oneRow, multiRow, columns
      queryType: multiRow
      # sql
      sql: SELECT COALESCE(datname,'shared-object') as name, conflicts, deadlocks, blks_read, blks_hit, blk_read_time, blk_write_time, stats_reset from pg_stat_database where (datname != 'template1' and datname != 'template0') or datname is null;
      url: ^_^url^_^

  - name: activity
    i18n:
      zh-CN: 活跃进程
      en-US: Activity
    priority: 2
    fields:
      # metric information includes field name, type field type: 0-number, 1-string, label-whether it is a metric label field, unit-metric unit
      - field: running
        i18n:
          zh-CN: 运行中进程数
          en-US: Running
        type: 0
        unit: sbc
    protocol: jdbc
    jdbc:
      # host: ipv4 ipv6 domain
      host: ^_^host^_^
      # port
      port: ^_^port^_^
      timeout: ^_^timeout^_^
      platform: postgresql
      username: ^_^username^_^
      password: ^_^password^_^
      database: ^_^database^_^
      # SQL query method: oneRow, multiRow, columns
      queryType: oneRow
      # sql
      sql: SELECT count(*) as running FROM pg_stat_activity WHERE NOT pid=pg_backend_pid();
      url: ^_^url^_^