add some README

This commit is contained in:
Ulric Qin 2022-06-13 15:37:42 +08:00
parent 5c23d4684c
commit 30cc8caaba
6 changed files with 63 additions and 1 deletions

View File

@ -18,7 +18,7 @@ gather_services = false
gather_extend_memstats = false
container_id_label_enable = true
container_id_label_short_style = true
container_id_label_short_style = false
## Containers to include and exclude. Globs accepted.
## Note that an empty array for both will include all containers

13
inputs/cpu/README.md Normal file
View File

@ -0,0 +1,13 @@
# cpu
CPU 采集插件很简单,自动采集本机 CPU 的使用率、空闲率等等,默认采集的是整机的,如果想采集单核的,就开启这个配置:
```ini
collect_per_cpu = true
```
其中 CPU 使用率的指标名字是 cpu_usage_active
## 监控大盘
该插件没有单独的监控大盘OS 的监控大盘统一放到 system 下面了

7
inputs/disk/README.md Normal file
View File

@ -0,0 +1,7 @@
# disk
该插件采集磁盘利用率、inode利用率等默认配置就是推荐配置如果有发现不符合预期的情况再考虑调整。
## 监控大盘
该插件没有单独的监控大盘OS 的监控大盘统一放到 system 下面了

7
inputs/diskio/README.md Normal file
View File

@ -0,0 +1,7 @@
# diskio
采集硬盘IO的情况
## 监控大盘
该插件没有单独的监控大盘OS 的监控大盘统一放到 system 下面了

View File

@ -7,3 +7,35 @@ forked from telegraf/inputs.docker
1. Using `container_id` as label not field
1. Some metrics have been deleted
## 容器ID标签
通过下面两个配置来控制 container_id 这个标签:
```ini
container_id_label_enable = true
container_id_label_short_style = false
```
默认 container_id_label_enable 设置为 true表示启用即会把容器ID放到标签里container_id_label_short_style 是短格式容器ID很长如果把 short_style 设置为 true就会只截取前面12位
## 权限问题
Categraf 最好是用 root 账号来运行,否则,请求 docker.sock 可能会遇到权限问题,需要把 Categraf 的运行账号,加到 docker group 中,假设 Categraf 使用 categraf 账号运行:
```
sudo usermod -aG docker categraf
```
## 运行在容器里
如果 Categraf 运行在容器中docker 的 unix socket 就需要挂到 Categraf 的容器里,比如通过 `-v /var/run/docker.sock:/var/run/docker.sock` 这样的参数来启动 Categraf 的容器。如果是在 compose 环境下,也可以在 docker compose 配置中加上 volume 的配置:
```yaml
volumes:
- /var/run/docker.sock:/var/run/docker.sock
```
## 停用该插件
- 方法一:把 `input.docker` 目录改个别的名字,不用 `input.` 打头
- 方法二docker.toml 中的 endpoint 配置留空

3
inputs/exec/README.md Normal file
View File

@ -0,0 +1,3 @@
# exec
该插件用于给用户自定义监控脚本,脚本的输出格式支持两种,一种是 influx 格式,一种是 falcon 格式