Go to file
Ulric Qin 2d1366c497 update switch dashboard 2022-07-01 12:26:10 +08:00
.github release image to docker hub 2022-06-14 15:12:16 +08:00
agent replace invalid chars in metric name 2022-06-29 08:57:38 +08:00
conf modify default settings of es plugin 2022-06-30 17:37:49 +08:00
config add more docs for traces.yaml 2022-06-28 20:11:39 +08:00
doc update README 2022-06-25 14:13:34 +08:00
docker new base image 2022-06-14 21:22:03 +08:00
house clickhouse table add hostname column 2022-06-30 09:46:16 +08:00
inputs update switch dashboard 2022-07-01 12:26:10 +08:00
k8s sidecar demo 2022-06-28 15:41:39 +08:00
logs reformat import pkgs 2022-06-24 14:00:42 +08:00
parser more detail name for prom parser method 2022-06-30 11:02:14 +08:00
pkg Merge pull request #59 from ysyneu/main 2022-06-29 19:07:26 +08:00
traces add trace support 2022-06-28 16:33:27 +08:00
types code refactor 2022-04-25 14:51:52 +08:00
writer code refactor 2022-06-17 20:24:29 +08:00
.gitignore add trace support 2022-06-28 16:33:27 +08:00
.goreleaser.yaml optimize building time of github action 2022-06-25 00:03:56 +08:00
LICENSE add LICENSE 2022-05-16 11:58:50 +08:00
Makefile add Makefile job: build-enterprise 2022-06-24 10:10:54 +08:00
README.md update readme 2022-06-29 14:21:03 +08:00
go.mod add more docs for traces.yaml 2022-06-28 20:11:39 +08:00
go.sum add more docs for traces.yaml 2022-06-28 20:11:39 +08:00
main.go fix building log endpoints without error judge 2022-06-24 18:19:23 +08:00
main_posix.go try to support windows 2022-05-29 17:03:03 +08:00
main_windows.go write log to file when running on windows 2022-05-29 20:49:09 +08:00

README.md

Categraf

Release Powered By Flashcat

Categraf is a monitoring agent for nightingale / prometheus / m3db / victoriametrics / thanos / influxdb / tdengine.

dockeri.co

Build

# export GO111MODULE=on
# export GOPROXY=https://goproxy.cn
go build

Pack

tar zcvf categraf.tar.gz categraf conf

Run

# 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

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:

kubectl apply -n monitoring -f ks8/daemonset.yaml
kubectl apply -n monitoring -f ks8/sidecar.yaml

Notice: k8s/sidecar.yaml is a demo, replace mock with your own image.

Plugin

Click on the links to see the README of each plugin.

Thanks

Categraf is developed on the basis of Telegraf and Exporters. Thanks to the great open source community.

Community