forked from flashcat/categraf
101 lines
3.8 KiB
Markdown
101 lines
3.8 KiB
Markdown
## Categraf
|
|
|
|
<a href="https://github.com/flashcatcloud/categraf">
|
|
<img src="https://cdn.jsdelivr.net/gh/flashcatcloud/categraf@main/doc/categraf.png" alt="categraf, one-stop telemetry collector" width="80" />
|
|
</a>
|
|
|
|
[](https://flashcat.cloud/)
|
|
[](https://github.com/flashcatcloud/categraf/releases/latest)
|
|
[](https://hub.docker.com/r/flashcatcloud/categraf/)
|
|
[](https://github.com/flashcatcloud/categraf/stargazers)
|
|
[](https://github.com/flashcatcloud/categraf/fork)
|
|
[](https://github.com/flashcatcloud/categraf/graphs/contributors)
|
|
[](https://github.com/flashcatcloud/categraf/blob/main/LICENSE)
|
|
|
|
Categraf is one-stop telemetry collector for Nightingale / Prometheus / M3DB / VictoriaMetrics / Thanos / Influxdb / TDengine.
|
|
|
|
It is recommended that you use [Nightingale](https://github.com/ccfos/nightingale) as the backend observability tools, and at the same time use [FlashDuty](http://flashcat.cloud/blog/flashduty-intro/) as the OnCall system to realize alarm aggregation convergence, claiming, upgrading, scheduling, and coordination, so that the alarm can be reached efficiently and ensure that the alarm processing is not missed, so that every piece echoed.
|
|
|
|
|
|
## Links
|
|
|
|
- [QuickStart](https://flashcat.cloud/blog/monitor-agent-categraf-introduction/)
|
|
- [Video tutorial](https://mp.weixin.qq.com/s/T69kkBzToHVh31D87xsrIg)
|
|
- [FAQ](https://www.gitlink.org.cn/flashcat/categraf/wiki/FAQ)
|
|
- [Github Releases](https://github.com/flashcatcloud/categraf/releases)
|
|
|
|
## Build
|
|
|
|
```shell
|
|
# export GO111MODULE=on
|
|
# export GOPROXY=https://goproxy.cn
|
|
go build
|
|
```
|
|
|
|
## Pack
|
|
|
|
```shell
|
|
tar zcvf categraf.tar.gz categraf conf
|
|
```
|
|
|
|
for mac user, use gnu-tar instead
|
|
|
|
use system tar tool will cause err ` F! failed to init config: failed to load configs of dir: ./conf err:toml: line 1: files cannot contain NULL bytes; probably using UTF-16; TOML files must be UTF-8`
|
|
|
|
```shell
|
|
brew install gnu-tar
|
|
gtar zcvf categraf.tar.gz categraf conf
|
|
```
|
|
|
|
## Run
|
|
|
|
```shell
|
|
# test mode: just print metrics to stdout
|
|
./categraf --test
|
|
|
|
# test system and mem plugins
|
|
./categraf --test --inputs system:mem
|
|
|
|
# print usage message
|
|
./categraf --help
|
|
|
|
# run
|
|
./categraf
|
|
|
|
# run with specified config directory
|
|
./categraf --configs /path/to/conf-directory
|
|
|
|
# only enable system and mem plugins
|
|
./categraf --inputs system:mem
|
|
|
|
# use nohup to start categraf
|
|
nohup ./categraf &> stdout.log &
|
|
```
|
|
|
|
|
|
## Deploy categraf as daemonset, deployment or sidecar
|
|
|
|
edit k8s/daemonset.yaml, replace NSERVER_SERVICE_WITH_PORT with service ip:port of nserver in your cluster, replace CATEGRAF_NAMESPACE with namespace value, then run:
|
|
|
|
```shell
|
|
kubectl apply -n monitoring -f k8s/daemonset.yaml # collect metrics, metrics/cadvisor of node
|
|
kubectl apply -n monitoring -f k8s/sidecar.yaml # collect service metrics
|
|
kubectl apply -n monitoring -f k8s/deployment.yaml #collect apiserver coredns etc
|
|
```
|
|
Notice: k8s/sidecar.yaml is a demo, replace mock with your own image of service.
|
|
|
|
## Scrape like prometheus
|
|
see detail [here](https://github.com/flashcatcloud/categraf/blob/main/prometheus/README.md)
|
|
|
|
## Plugin
|
|
|
|
plugin list and document: [https://github.com/flashcatcloud/categraf/tree/main/inputs](https://github.com/flashcatcloud/categraf/tree/main/inputs)
|
|
|
|
|
|
## Thanks
|
|
|
|
Categraf is developed on the basis of Telegraf, Exporters and the OpenTelemetry. Thanks to the great open source community.
|
|
|
|
## [Join wechat groups](https://download.flashcat.cloud/qrcode_sretalk.jpg)
|
|
|