docs: add taosKeeper document (#16384)
This commit is contained in:
parent
8879dc6e59
commit
55292eebe6
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: taosKeeper
|
sidebar_label: taosKeeper
|
||||||
title: taosKeeper
|
title: taosKeeper
|
||||||
description: Instructions and tips for using taosKeeper
|
description: exports TDengine monitoring metrics.
|
||||||
---
|
---
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
@ -22,26 +22,35 @@ You can compile taosKeeper separately and install it. Please refer to the [taosK
|
||||||
|
|
||||||
### Configuration and running methods
|
### Configuration and running methods
|
||||||
|
|
||||||
<!-- taosKeeper needs to be executed on the terminal of the operating system, it supports two configuration methods: [Command-line arguments](#command-line-arguments-in-detail) and [configuration file](#configuration-file-parameters-in-detail). Command-line arguments take precedence over values in the configuration file. -->
|
taosKeeper needs to be executed on the terminal of the operating system, it supports three configuration methods: [Command-line arguments](#command-line-arguments-in-detail), [environment variable](#environment-variable-in-detail) and [configuration file](#configuration-file-parameters-in-detail). The precedence of those is Command-line, environment variable and configuration file.
|
||||||
taosKeeper needs to be executed on the terminal of the operating system. To run taosKeeper, see [configuration file](#configuration-file-parameters-in-detail).
|
|
||||||
|
|
||||||
**Make sure that the TDengine cluster is running correctly before running taosKeeper. ** Ensure that the monitoring service in TDengine has been started. For more information, see [TDengine Monitoring Configuration](../config/#monitoring).
|
**Make sure that the TDengine cluster is running correctly before running taosKeeper. ** Ensure that the monitoring service in TDengine has been started. For more information, see [TDengine Monitoring Configuration](../config/#monitoring).
|
||||||
|
|
||||||
<!--
|
|
||||||
### Command-Line Parameters
|
### Command-Line Parameters
|
||||||
|
|
||||||
You can use command-line parameters to run taosBenchmark and control its behavior:
|
You can use command-line parameters to run taosKeeper and control its behavior:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
taosKeeper
|
$ taosKeeper
|
||||||
```
|
```
|
||||||
-->
|
### Environment variable
|
||||||
|
|
||||||
|
You can use Environment variable to run taosKeeper and control its behavior:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ export TAOS_KEEPER_TDENGINE_HOST=192.168.64.3
|
||||||
|
|
||||||
|
$ taoskeeper
|
||||||
|
```
|
||||||
|
|
||||||
|
you can run `taoskeeper -h` for more detail.
|
||||||
|
|
||||||
### Configuration File
|
### Configuration File
|
||||||
|
|
||||||
You can quickly launch taosKeeper with the following commands. If you do not specify a configuration file, `/etc/taos/keeper.toml` is used by default. If this file does not specify configurations, the default values are used.
|
You can quickly launch taosKeeper with the following commands. If you do not specify a configuration file, `/etc/taos/keeper.toml` is used by default. If this file does not specify configurations, the default values are used.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
taoskeeper -c <keeper config file>
|
$ taoskeeper -c <keeper config file>
|
||||||
```
|
```
|
||||||
|
|
||||||
**Sample configuration files**
|
**Sample configuration files**
|
||||||
|
@ -110,7 +119,7 @@ Query OK, 1 rows in database (0.036162s)
|
||||||
#### Export Monitoring Metrics
|
#### Export Monitoring Metrics
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl http://127.0.0.1:6043/metrics
|
$ curl http://127.0.0.1:6043/metrics
|
||||||
```
|
```
|
||||||
|
|
||||||
Sample result set (excerpt):
|
Sample result set (excerpt):
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
sidebar_label: taosKeeper
|
sidebar_label: taosKeeper
|
||||||
title: taosKeeper
|
title: taosKeeper
|
||||||
description: TDengine taosKeeper 使用说明
|
description: TDengine 3.0 版本监控指标的导出工具
|
||||||
---
|
---
|
||||||
|
|
||||||
## 简介
|
## 简介
|
||||||
|
@ -22,26 +22,36 @@ taosKeeper 安装方式:
|
||||||
|
|
||||||
### 配置和运行方式
|
### 配置和运行方式
|
||||||
|
|
||||||
<!-- taosKeeper 需要在操作系统终端执行,该工具支持两种配置方式:[命令行参数](#命令行参数启动) 和 [配置文件](#配置文件启动)。命令行参数优先级高于配置文件参数。-->
|
taosKeeper 需要在操作系统终端执行,该工具支持三种配置方式:[命令行参数](#命令行参数启动)、[环境变量](#环境变量启动) 和 [配置文件](#配置文件启动)。优先级为:命令行参数、环境变量、配置文件参数。
|
||||||
taosKeeper 需要在操作系统终端执行,该工具支持 [配置文件启动](#配置文件启动)。
|
|
||||||
|
|
||||||
**在运行 taosKeeper 之前要确保 TDengine 集群与 taosAdapter 已经在正确运行。** 并且 TDengine 已经开启监控服务,具体请参考:[TDengine 监控配置](../config/#监控相关)。
|
**在运行 taosKeeper 之前要确保 TDengine 集群与 taosAdapter 已经在正确运行。** 并且 TDengine 已经开启监控服务,具体请参考:[TDengine 监控配置](../config/#监控相关)。
|
||||||
|
|
||||||
<!--
|
|
||||||
### 命令行参数启动
|
### 命令行参数启动
|
||||||
|
|
||||||
在使用命令行参数运行 taosBenchmark 并控制其行为。
|
在使用命令行参数运行 taosKeeper 并控制其行为。
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
taosKeeper
|
$ taosKeeper
|
||||||
```
|
```
|
||||||
-->
|
|
||||||
|
### 环境变量启动
|
||||||
|
|
||||||
|
通过设置环境变量达到控制启动参数的目的,通常在容器中运行时使用。
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ export TAOS_KEEPER_TDENGINE_HOST=192.168.64.3
|
||||||
|
|
||||||
|
$ taoskeeper
|
||||||
|
```
|
||||||
|
|
||||||
|
具体参数列表请参照 `taoskeeper -h` 输入结果。
|
||||||
|
|
||||||
### 配置文件启动
|
### 配置文件启动
|
||||||
|
|
||||||
执行以下命令即可快速体验 taosKeeper。当不指定 taosKeeper 配置文件时,优先使用 `/etc/taos/keeper.toml` 配置,否则将使用默认配置。
|
执行以下命令即可快速体验 taosKeeper。当不指定 taosKeeper 配置文件时,优先使用 `/etc/taos/keeper.toml` 配置,否则将使用默认配置。
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
taoskeeper -c <keeper config file>
|
$ taoskeeper -c <keeper config file>
|
||||||
```
|
```
|
||||||
|
|
||||||
**下面是配置文件的示例:**
|
**下面是配置文件的示例:**
|
||||||
|
@ -110,7 +120,7 @@ Query OK, 1 rows in database (0.036162s)
|
||||||
#### 导出监控指标
|
#### 导出监控指标
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl http://127.0.0.1:6043/metrics
|
$ curl http://127.0.0.1:6043/metrics
|
||||||
```
|
```
|
||||||
|
|
||||||
部分结果集:
|
部分结果集:
|
||||||
|
|
Loading…
Reference in New Issue