87 lines
2.8 KiB
Markdown
87 lines
2.8 KiB
Markdown
# Categraf
|
|
[](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 a monitoring agent for nightingale / prometheus / m3db / victoriametrics / thanos / influxdb / tdengine.
|
|
|
|
|
|
## Links
|
|
|
|
- [QuickStart](https://www.gitlink.org.cn/flashcat/categraf/wiki/QuickStart)
|
|
- [FAQ](https://www.gitlink.org.cn/flashcat/categraf/wiki/FAQ)
|
|
- [Github Releases](https://github.com/flashcatcloud/categraf/releases)
|
|
- [Gitlink Releases](https://www.gitlink.org.cn/flashcat/categraf/releases)
|
|
|
|
## Build
|
|
|
|
```shell
|
|
# export GO111MODULE=on
|
|
# export GOPROXY=https://goproxy.cn
|
|
go build
|
|
```
|
|
|
|
## Pack
|
|
|
|
```shell
|
|
tar 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: [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.
|
|
|
|
## Community
|
|
|
|
|