[manager,home]添加sqlserver关联文档，fix connection指标入库tdengine失败 (#41)

* [manager,home]添加sqlserver关联文档，fix connection指标入库tdengine失败 * [docs]文档更新
2022-03-20 13:27:13 +08:00
parent 155bdaf462
commit 820cb7a3e5
15 changed files with 74 additions and 13 deletions
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@

 ## HertzBeat 赫兹跳动         

-> 易用友好的高性能监控告警系统。
+> 易用友好的监控告警系统。

 ![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/web-monitor.svg)
 ![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/ping-connect.svg)
--- a/home/docs/advanced/extend-jdbc.md
+++ b/home/docs/advanced/extend-jdbc.md
@@ -3,7 +3,7 @@ id: extend-jdbc
 title: JDBC协议自定义监控  
 sidebar_label: JDBC协议自定义监控    
 ---
-> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql)自定义指标监控。 
+> 从[自定义监控](extend-point)了解熟悉了怎么自定义类型，指标，协议等，这里我们来详细介绍下用JDBC(目前支持mysql,mariadb,postgresql,sqlserver)自定义指标监控。 
 > JDBC协议自定义监控可以让我们很方便的通过写SQL查询语句就能监控到我们想监控的指标     

 ### JDBC协议采集流程    
--- a/home/docs/help/guide.md
+++ b/home/docs/help/guide.md
@@ -18,7 +18,7 @@ sidebar_label: 帮助入门

 ### 数据库监控  

-[MYSQL数据库监控](mysql) &emsp;&emsp;&emsp;&emsp; [MariaDB数据库监控](mariadb)  &emsp;&emsp;&emsp;&emsp; [PostgreSQL数据库监控](postgresql)        
+[MYSQL数据库监控](mysql) &emsp;&emsp;&emsp;&emsp; [MariaDB数据库监控](mariadb)  &emsp;&emsp;&emsp;&emsp; [PostgreSQL数据库监控](postgresql)  &emsp;&emsp;&emsp;&emsp; [SqlServer数据库监控](sqlserver)         

 ### 操作系统监控     

--- a/home/docs/help/mariadb.md
+++ b/home/docs/help/mariadb.md
@@ -13,6 +13,7 @@ sidebar_label: MariaDB数据库
 | 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
 | 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
 | 端口        | 数据库对外提供的端口，默认为3306。  |
+| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。  |
 | 数据库名称   | 数据库实例名称，可选。  |
 | 用户名      | 数据库连接用户名，可选 |
 | 密码        | 数据库连接密码，可选 |
--- a/home/docs/help/mysql.md
+++ b/home/docs/help/mysql.md
@@ -13,6 +13,7 @@ sidebar_label: MYSQL数据库
 | 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
 | 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
 | 端口        | 数据库对外提供的端口，默认为3306。  |
+| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。  |
 | 数据库名称   | 数据库实例名称，可选。  |
 | 用户名      | 数据库连接用户名，可选 |
 | 密码        | 数据库连接密码，可选 |
--- a/home/docs/help/postgresql.md
+++ b/home/docs/help/postgresql.md
@@ -13,6 +13,7 @@ sidebar_label: PostgreSQL数据库
 | 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
 | 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
 | 端口        | 数据库对外提供的端口，默认为5432。  |
+| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。  |
 | 数据库名称   | 数据库实例名称，可选。  |
 | 用户名      | 数据库连接用户名，可选 |
 | 密码        | 数据库连接密码，可选 |
--- a/home/docs/help/sqlserver.md
+++ b/home/docs/help/sqlserver.md
@@ -0,0 +1,57 @@
+---
+id: sqlserver  
+title: 监控：SqlServer数据库监控      
+sidebar_label: SqlServer数据库   
+---
+
+> 对SqlServer数据库的通用性能指标进行采集监控。支持SqlServer 2017+。
+
+### 配置参数
+
+| 参数名称      | 参数帮助描述 |
+| ----------- | ----------- |
+| 监控Host     | 被监控的对端IPV4，IPV6或域名。注意⚠️不带协议头(eg: https://, http://)。 |
+| 监控名称     | 标识此监控的名称，名称需要保证唯一性。  |
+| 端口        | 数据库对外提供的端口，默认为1433。  |
+| 查询超时时间 | 设置SQL查询未响应数据时的超时时间，单位ms毫秒，默认3000毫秒。  |
+| 数据库名称   | 数据库实例名称，可选。  |
+| 用户名      | 数据库连接用户名，可选 |
+| 密码        | 数据库连接密码，可选 |
+| URL        | 数据库连接URL，可选，若配置，则URL里面的数据库名称，用户名密码等参数会覆盖上面配置的参数  |
+| 采集间隔    | 监控周期性采集数据间隔时间，单位秒，可设置的最小间隔为10秒  |
+| 是否探测    | 新增监控前是否先探测检查监控可用性，探测成功才会继续新增修改操作  |
+| 描述备注    | 更多标识和描述此监控的备注信息，用户可以在这里备注信息  |
+
+### 采集指标
+
+#### 指标集合：basic
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| machine_name         | 无 | 	运行服务器实例的 Windows 计算机名称 |
+| server_name            | 无 | 与Windows实例关联的服务器和实例信息SQL Server  |
+| version         | 无 | 实例的版本，SQL Server，格式为"major.minor.build.revision" |
+| edition | 无 | 	已安装的 实例的产品SQL Server版本 |
+| start_time | 无 | 数据库启动时间 | 
+
+#### 指标集合：performance_counters
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| database_pages         | 无 | Database pages, 已获得的页面数(缓冲池) |
+| target_pages            | 无 | Target pages, 缓冲池必须的理想页面数 |
+| page_life_expectancy         | s,秒 | Page life expectancy, 数据页在缓冲池中驻留的时间，这个时间一般会大于 300 |
+| buffer_cache_hit_ratio | % | Buffer cache hit ratio, 数据库缓冲池高速缓冲命中率，被请求的数据在缓冲池中被找到的概率，一般会大于 80% 才算正常，否则可能是缓冲池容量太小 |
+| checkpoint_pages_sec | 无 | Checkpoint pages/sec, 检查点每秒写入磁盘的脏页个数，如果数据过高，证明缺少内存容量 |
+| page_reads_sec | 无 | Page reads/sec, 缓存池中每秒读的页数 |
+| page_writes_sec | 无 | Page writes/sec, 缓存池中每秒写的页数 |
+
+
+#### 指标集合：connection
+
+| 指标名称      | 指标单位 | 指标帮助描述 |
+| ----------- | ----------- | ----------- |
+| user_connection   | 无 | 已连接的会话数 |
+
+
+
--- a/home/docs/introduce.md
+++ b/home/docs/introduce.md
@@ -5,7 +5,7 @@ sidebar_label: 介绍
 slug: /
 ---

-> 易用友好的高性能监控告警系统。
+> 易用友好的监控告警系统。

 ![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/web-monitor.svg)
 ![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/ping-connect.svg)
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -64,7 +64,8 @@
          "items": [
            "help/mysql",
            "help/mariadb",
-            "help/postgresql"
+            "help/postgresql",
+            "help/sqlserver"
          ]
        },
        {
--- a/home/src/pages/index.js
+++ b/home/src/pages/index.js
@@ -28,7 +28,7 @@ function Home() {
                    <h1 className="hero__title">
                        <img style={{width: '500px', marginTop: '100px'}} src={cdnTransfer('img/hertzbeat-brand.svg')} alt={'#'}/>
                    </h1>
-                    <p className="hero__subtitle"><Translate>易用友好的高性能监控告警系统</Translate></p>
+                    <p className="hero__subtitle"><Translate>易用友好的监控告警系统</Translate></p>
                    <div className={styles.social}>
                        <a href="https://console.tancloud.cn"><img src={cdnTransfer('img/badge/web-monitor.svg')} alt={''}/></a>
                        <a href="https://console.tancloud.cn"><img src={cdnTransfer('img/badge/ping-connect.svg')} alt={''}/></a>
--- a/manager/src/main/resources/application.yml
+++ b/manager/src/main/resources/application.yml
@@ -27,8 +27,8 @@ spring:
      on-profile: prod
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
-    username: admin
-    password: admin
+    username: root
+    password: 123456
    url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false
    platform: mysql
    hikari:
--- a/manager/src/main/resources/define/app/sqlserver.yml
+++ b/manager/src/main/resources/define/app/sqlserver.yml
@@ -115,7 +115,7 @@ metrics:
    priority: 1
    fields:
      # 指标信息 包括 field名称   type字段类型:0-number数字,1-string字符串   instance是否为实例主键   unit:指标单位
-      - field: connection
+      - field: user_connection
        type: 0
        unit: 连接数
    protocol: jdbc
@@ -132,5 +132,5 @@ metrics:
      # SQL查询方式： oneRow, multiRow, columns
      queryType: oneRow
      # sql
-      sql: SELECT cntr_value as connection FROM sys.dm_os_performance_counters WHERE object_name = 'SQLServer:General Statistics' AND counter_name = 'User Connections';
+      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^_^
--- a/script/application.yml
+++ b/script/application.yml
@@ -28,7 +28,7 @@ spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
-    password: 1234
+    password: 123456
    url: jdbc:mysql://localhost:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false
    platform: mysql
    hikari:
--- a/script/docker-compose/conf/application.yml
+++ b/script/docker-compose/conf/application.yml
@@ -28,7 +28,7 @@ spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
-    password: 1234
+    password: 123456
    url: jdbc:mysql://mysql:3306/hertzbeat?useUnicode=true&characterEncoding=utf-8&useSSL=false
    platform: mysql
    hikari:
--- a/script/docker-compose/docker-compose.yaml
+++ b/script/docker-compose/docker-compose.yaml
@@ -14,7 +14,7 @@ services:
      - "3306:3306"
    environment:
      TZ: Asia/Shanghai
-      MYSQL_ROOT_PASSWORD: 1234
+      MYSQL_ROOT_PASSWORD: 123456
    volumes:
      - ./dbdata/mysqldata:/var/lib/mysql/
      - ./conf/sql:/docker-entrypoint-initdb.d/