# 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
# 监控类型所属类别：service-应用服务监控 db-数据库监控 custom-自定义监控 os-操作系统监控 cn-云原生cloud native network-网络监控
category: db
# The monitoring type eg: linux windows tomcat mysql aws...
# 监控类型 eg: linux windows tomcat mysql aws...
app: sqlserver
# The monitoring i18n name
# 监控类型国际化名称
name:
  zh-CN: SqlServer数据库
  en-US: SqlServer DB
# The description and help of this monitoring type
# 监控类型的帮助描述信息
help:
  zh-CN: HertzBeat 对 SqlServer 数据库的通用性能指标(basic、performance counters、connection)进行采集监控，支持版本为 SqlServer 2017+。<br><span class='help_module_span'>⚠️注意<a class='help_module_content'  href='https://hertzbeat.com/zh-cn/docs/help/sqlserver'>点击查看可能遇见的 ssh 问题</a>。</span>
  en-US: "HertzBeat monitors SqlServer database through basic performance metrics such as performance counters and connection, the version we support is SqlServer 2017+. <br><span class='help_module_span'>⚠️Note: <a class='help_module_content'  href='https://hertzbeat.com/docs/help/sqlserver'>Click here to see the possible SSH problems.</a></span>"
  zh-TW: HertzBeat對SqlServer資料庫的通用性能指標（basic、performance counters、connection）進行採集監控，支持版本為SqlServer 2017+。<br><span> ⚠️ 注意<a href='https://hertzbeat.com/zh-cn/docs/help/sqlserver'>點擊查看可能遇見的ssh問題</a>。</span>
helpLink:
  zh-CN: https://hertzbeat.com/zh-cn/docs/help/sqlserver
  en-US: https://hertzbeat.com/docs/help/sqlserver
# 监控所需输入参数定义(根据定义渲染页面UI)
# Input params define for monitoring(render web ui by the definition)
params:
  # field-param field key
  # field-变量字段标识符
  - field: host
    # name-param field display i18n name
    # name-参数字段显示名称
    name:
      zh-CN: 主机Host
      en-US: Host
    # type-param field type(most mapping the html input type)
    # type-字段类型,样式(大部分映射input标签type属性)
    type: host
    # required-true or false
    # required-是否是必输项 true-必填 false-可选
    required: true
  # field-param field key
  # field-变量字段标识符
  - field: port
    # name-param field display i18n name
    # name-参数字段显示名称
    name:
      zh-CN: 端口
      en-US: Port
    # type-param field type(most mapping the html input type)
    # type-字段类型,样式(大部分映射input标签type属性)
    type: number
    # when type is number, range is required
    # 当type为number时,用range表示范围
    range: '[0,65535]'
    # required-true or false
    # required-是否是必输项 true-必填 false-可选
    required: true
    # default value
    # 默认值
    defaultValue: 1433
  # field-param field key
  # field-变量字段标识符
  - field: timeout
    # name-param field display i18n name
    # name-参数字段显示名称
    name:
      zh-CN: 查询超时时间(ms)
      en-US: Query Timeout(ms)
    # type-param field type(most mapping the html input type)
    # type-字段类型,样式(大部分映射input标签type属性)
    type: number
    # when type is number, range is required
    # 当type为number时,用range表示范围
    range: '[400,200000]'
    # required-true or false
    # required-是否是必输项 true-必填 false-可选
    required: false
    # hide param-true or false
    # 是否隐藏字段 true or false
    hide: true
    # default value
    # 默认值
    defaultValue: 6000
  # field-param field key
  # field-变量字段标识符
  - field: database
    # name-param field display i18n name
    # name-参数字段显示名称
    name:
      zh-CN: 数据库名称
      en-US: Database Name
    # type-param field type(most mapping the html input tag)
    # type-字段类型,样式(大部分映射input标签type属性)
    type: text
    # required-true or false
    # required-是否是必输项 true-必填 false-可选
    required: false
  # field-param field key
  # field-变量字段标识符
  - field: username
    # name-param field display i18n name
    # name-参数字段显示名称
    name:
      zh-CN: 用户名
      en-US: Username
    # type-param field type(most mapping the html input tag)
    # type-字段类型,样式(大部分映射input标签type属性)
    type: text
    # when type is text, use limit to limit string length
    # 当type为text时,用limit表示字符串限制大小
    limit: 20
    # required-true or false
    # required-是否是必输项 true-必填 false-可选
    required: false
  # field-param field key
  # field-变量字段标识符
  - field: password
    # name-param field display i18n name
    # name-参数字段显示名称
    name:
      zh-CN: 密码
      en-US: Password
    # type-param field type(most mapping the html input tag)
    # type-字段类型,样式(大部分映射input标签type属性)
    type: password
    # required-true or false
    # required-是否是必输项 true-必填 false-可选
    required: false
  # field-param field key
  # field-变量字段标识符
  - field: url
    # type-param field type(most mapping the html input tag)
    # type-字段类型,样式(大部分映射input标签type属性)
    name:
      zh-CN: URL
      en-US: URL
    # type-param field type(most mapping the html input tag)
    # type-字段类型,样式(大部分映射input标签type属性)
    type: text
    # required-true or false
    # required-是否是必输项 true-必填 false-可选
    required: false
    # hide param-true or false
    # 是否隐藏字段 true or false
    hide: true
# collect metrics config list
# 采集指标组配置列表
metrics:
  # metrics - basic
  # 监控指标组 - basic
  - name: basic
    # metrics group scheduling priority(0->127)->(high->low), metrics with the same priority will be scheduled in parallel
    # priority 0's metrics group is availability metrics, it will be scheduled first, only availability metrics collect success will the scheduling continue
    # 指标组调度优先级(0->127)->(优先级高->低) 优先级低的指标组会等优先级高的指标组采集完成后才会被调度, 相同优先级的指标组会并行调度采集
    # 优先级为0的指标组为可用性指标组,即它会被首先调度,采集成功才会继续调度其它指标组,采集失败则中断调度
    priority: 0
    # collect metrics content
    # 具体监控指标列表
    fields:
      # field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), instance-if is metrics group unique identifier
      # field-指标名称, type-指标类型(0-number数字,1-string字符串), unit-指标单位('%','ms','MB'), instance-是否是指标集合唯一标识符字段
      - field: machine_name
        type: 1
        instance: true
      - field: server_name
        type: 1
      - field: version
        type: 1
      - field: edition
        type: 1
      - field: start_time
        type: 1
    # the protocol used for monitoring, eg: sql, ssh, http, telnet, wmi, snmp, sdk
    protocol: jdbc
    # the config content when protocol is jdbc
    jdbc:
      # server host: ipv4 ipv6 domain
      host: ^_^host^_^
      # server port
      port: ^_^port^_^
      # database type
      platform: sqlserver
      # database username
      username: ^_^username^_^
      # database password
      password: ^_^password^_^
      # database name
      database: ^_^database^_^
      # jdbc connect timeout
      timeout: ^_^timeout^_^
      # sql query data type: oneRow, multiRow, columns
      queryType: oneRow
      # sql
      sql: SELECT SERVERPROPERTY('MachineName') AS machine_name, SERVERPROPERTY('ServerName') AS server_name, SERVERPROPERTY('ProductVersion') AS version, SERVERPROPERTY('Edition') AS edition, sqlserver_start_time AS start_time FROM sys.dm_os_sys_info;
      # custom jdbc url
      url: ^_^url^_^

  - name: performance_counters
    priority: 1
    fields:
      - field: database_pages
        type: 0
      - field: target_pages
        type: 0
      - field: page_life_expectancy
        type: 0
      - field: buffer_cache_hit_ratio
        type: 0
      - field: checkpoint_pages_sec
        type: 0
      - field: page_reads_sec
        type: 0
      - field: page_writes_sec
        type: 0
    # (optional)metrics field alias name, it is used as an alias field to map and convert the collected data and metrics field
    # (可选)监控指标别名, 做为中间字段与采集数据字段和指标字段映射转换
    aliasFields:
      - Database pages
      - Target pages
      - Page life expectancy
      - Buffer cache hit ratio
      - Checkpoint pages/sec
      - Page reads/sec
      - Page writes/sec
    # mapping and conversion expressions, use these and aliasField above to calculate metrics value
    # (可选)指标映射转换计算表达式,与上面的别名一起作用,计算出最终需要的指标值
    # eg: cores=core1+core2, usage=usage, waitTime=allTime-runningTime
    calculates:
      - database_pages=Database pages
      - target_pages=Target pages
      - page_life_expectancy=Page life expectancy
      - buffer_cache_hit_ratio=Buffer cache hit ratio
      - checkpoint_pages_sec=Checkpoint pages/sec
      - page_reads_sec=Page reads/sec
      - page_writes_sec=Page writes/sec
    protocol: jdbc
    jdbc:
      host: ^_^host^_^
      port: ^_^port^_^
      platform: sqlserver
      username: ^_^username^_^
      password: ^_^password^_^
      database: ^_^database^_^
      timeout: ^_^timeout^_^
      queryType: columns
      sql: select counter_name, cntr_value from sys.dm_os_performance_counters where object_name = 'SQLServer:Buffer Manager';
      url: ^_^url^_^

  - name: connection
    priority: 1
    fields:
      - field: user_connection
        type: 0
        unit: 连接数
    protocol: jdbc
    jdbc:
      host: ^_^host^_^
      port: ^_^port^_^
      platform: sqlserver
      username: ^_^username^_^
      password: ^_^password^_^
      database: ^_^database^_^
      timeout: ^_^timeout^_^
      queryType: oneRow
      sql: SELECT cntr_value as user_connection FROM sys.dm_os_performance_counters WHERE object_name = 'SQLServer:General Statistics' AND counter_name = 'User Connections';
      url: ^_^url^_^