From e2e327f65358680363699e1b4211ef81e0f9d1a1 Mon Sep 17 00:00:00 2001
From: chris-sun-star <85611200+chris-sun-star@users.noreply.github.com>
Date: Wed, 8 Dec 2021 19:16:20 +0800
Subject: [PATCH] =?UTF-8?q?optimize=20document,=20explain=20how=20to=20sta?=
 =?UTF-8?q?rt=20prometheus=20with=20the=20right=20con=E2=80=A6=20(#16)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* optimize document, explain how to start prometheus with the right config file and add grafana config section

* add config doc for mysql
---
 docs/config-reference/prometheus-config.md    |  2 +-
 .../deploy-obagent-manually.md                | 13 ++++-
 .../deploy-obagent-with-obd.md                | 13 ++++-
 docs/obagent-mysql.md                         | 49 +++++++++++++++++++
 4 files changed, 74 insertions(+), 3 deletions(-)
 create mode 100644 docs/obagent-mysql.md

diff --git a/docs/config-reference/prometheus-config.md b/docs/config-reference/prometheus-config.md
index a80eb31..42cda8a 100644
--- a/docs/config-reference/prometheus-config.md
+++ b/docs/config-reference/prometheus-config.md
@@ -9,7 +9,7 @@
 ```yaml
 # OBAgent 的 RPM 包中包含 Prometheus 的配置模版，您可以根据实际情况修改。
 # 要开启基础认证，您需要配置 {http_basic_auth_user} 和 {http_basic_auth_password}。
-# {target} 替换成主机的 IP 和 端口号
+# {target} 替换成监控目标主机的 IP 和 端口号, 如果有多个监控目标，需要配置多行，每个监控目标一行。
 # rules 目录包含两个报警配置模版，分别是默认的主机和 OceanBase 数据库的报警配置。如需自定义报警项，您可以参考此目录。
 
 # 全局配置
diff --git a/docs/install-and-deploy/deploy-obagent-manually.md b/docs/install-and-deploy/deploy-obagent-manually.md
index 64fcadc..dcec598 100644
--- a/docs/install-and-deploy/deploy-obagent-manually.md
+++ b/docs/install-and-deploy/deploy-obagent-manually.md
@@ -45,7 +45,7 @@ OBAgent 提供使用 OBD 部署和手动部署。要手动部署 OBAgent，您
 > 说明：您需要安装 Prometheus。
 
 1. 配置 Prometheus，详情参考 [Prometheus 配置文件说明](../config-reference/prometheus-config.md)。
-2. 启动 Prometheus。
+2. 将配置好的 Prometheus 配置文件复制到部署 Prometheus 的主机上，然后使用如下命令启动 Prometheus。
 
     ```bash
     ./prometheus --config.file=./prometheus.yaml
@@ -75,6 +75,17 @@ groups:
         description: "{{ $labels.instance }} disk > {{ $value }}  "
 ```
 
+### （可选）步骤4：部署与配置 Grafana
+
+- 下载并解压 Grafana。
+- 启动 Grafana。
+    ```bash
+    ./bin/grafana-server
+    ```
+- 登陆 grafana 并且修改密码，第一次登陆默认账号密码都是 admin。
+- 配置 prometheus 为数据源, 添加数据源的方式参考 [grafana 文档](https://grafana.com/docs/grafana/v7.5/datasources/add-a-data-source/)。
+- 导入 dashboard, 针对 OB 和主机指标的配置已经发布到grafana，id 分别为 15215, 15216, 导入 dashboard 的方式参考 [grafana 文档](https://grafana.com/docs/grafana/v7.5/dashboards/export-import/)。
+
 ## （可选）更新 KV 配置
 
 OBAgent 提供了更新配置的接口。您可以通过 HTTP 服务更新 KV 配置项：
diff --git a/docs/install-and-deploy/deploy-obagent-with-obd.md b/docs/install-and-deploy/deploy-obagent-with-obd.md
index f19bb2a..cf3d113 100644
--- a/docs/install-and-deploy/deploy-obagent-with-obd.md
+++ b/docs/install-and-deploy/deploy-obagent-with-obd.md
@@ -80,7 +80,7 @@ obd cluster start <deploy name> [flags]
 
 > 说明：您需要安装 Prometheus。
 
-运行以下命令，启动 Prometheus：
+运行以下命令，启动 Prometheus, obagent 中的配置文件模版 obd 已经进行了替换，可以复制该配置文件到部署 Prometheus 的主机，然后直接使用该配置文件用如下命令启动 prometheus ：
 
 ```bash
 ./prometheus --config.file=./prometheus.yaml
@@ -110,6 +110,17 @@ groups:
         description: "{{ $labels.instance }} disk > {{ $value }}  "
 ```
 
+### （可选）部署与配置 Grafana
+
+- 下载并解压 Grafana。
+- 启动 Grafana。
+    ```bash
+    ./bin/grafana-server
+    ```
+- 登陆 grafana 并且修改密码，第一次登陆默认账号密码都是 admin。
+- 配置 prometheus 为数据源, 添加数据源的方式参考 [grafana 文档](https://grafana.com/docs/grafana/v7.5/datasources/add-a-data-source/)。
+- 导入 dashboard, 针对 OB 和主机指标的配置已经发布到grafana，id 分别为 15215, 15216, 导入 dashboard 的方式参考 [grafana 文档](https://grafana.com/docs/grafana/v7.5/dashboards/export-import/)。
+
 ## （可选）更新 KV 配置
 
 要更新 KV 配置，请使用 `obd cluster edit-config`。详细信息，参考 [OBD 使用文档](https://github.com/oceanbase/obdeploy/blob/master/README-CN.md#obd-cluster-edit-config)。
diff --git a/docs/obagent-mysql.md b/docs/obagent-mysql.md
new file mode 100644
index 0000000..efdade3
--- /dev/null
+++ b/docs/obagent-mysql.md
@@ -0,0 +1,49 @@
+obagent 集成了 prometheus 提供的 mysqld exporter, 可以使用 obagent 来采集 mysql 的性能指标
+​
+
+# 配置方式
+obagent 中打包了采集 mysql 的流水线配置，默认没有开启，可以通过修改如下配置项来配置并开启mysql的采集
+```yaml
+# 用户采集监控数据的 mysql 用户, 对于开启的采集项，需要有对应表的读权限
+- key: monagent.mysql.monitor.user
+  value: mysql_monitor_user
+  valueType: string
+# 监控用户的密码
+- key: monagent.mysql.monitor.password
+  value: mysql_monitor_password
+  valueType: string
+  encrypted: true
+# mysql 的 sql 端口
+- key: monagent.mysql.sql.port
+  value: 3306
+  valueType: int64
+# mysql 的连接地址
+- key: monagent.mysql.host
+  value: 127.0.0.1
+  valueType: string
+# 是否开启mysql指标采集，默认为 inactive 表示不开启，如果开启需要修改为 active
+- key: monagent.pipeline.mysql.status
+  value: inactive
+  valueType: string
+```
+
+
+mysql 流水线的配置如下，采集的指标保持 mysqld exporter 的默认开关，一般不需要修改，如果需要指定特定指标的开关，需要修改 mysqldInput 插件 scraperFlags 的配置
+```yaml
+# 当前配置文件在 obagent 的 rpm 包中， monitor_mysql.yaml, 这里只展示采集插件部分
+
+mysqldInput: &mysqldInput
+  plugin: mysqldInput
+  config:
+    timeout: 10s
+    pluginConfig:
+      dsn: ${monagent.mysql.monitor.user}:${monagent.mysql.monitor.password}@(${monagent.mysql.host}:${monagent.mysql.sql.port})/
+      scraperFlags:
+        # 开启 binlog_size 指标的采集
+        binlog_size: true
+        # 关闭 slave_status 指标的采集
+        slave_status: false
+
+```
+# 其他说明
+mysql 相关的采集配置未与 obd 集成，只能以手动配置的方式来启动
-- 
GitLab