categraf/README.md

# Categraf

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

## QuickStart

[QuickStart](https://www.gitlink.org.cn/flashcat/categraf/wiki)

## Releases

[Releases](https://www.gitlink.org.cn/flashcat/categraf/releases)

## Build

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

## Deploy categraf as daemonset

```shell
edit k8s/categraf.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/categraf.yaml
```

## Test

```shell
./categraf --test

# usage:
./categraf --help
```

## Pack

```shell
tar zcvf categraf.tar.gz categraf conf
```

## Plan

- [x] [system](inputs/system)
- [x] [kernel](inputs/kernel)
- [x] [kernel_vmstat](inputs/kernel_vmstat)
- [x] [linux_sysctl_fs](inputs/linux_sysctl_fs)
- [x] [cpu](inputs/cpu)
- [x] [mem](inputs/mem)
- [x] [net](inputs/net)
- [x] [netstat](inputs/netstat)
- [x] [disk](inputs/disk)
- [x] [diskio](inputs/diskio)
- [x] [conntrack](inputs/conntrack)
- [x] [ntp](inputs/ntp)
- [x] [processes](inputs/processes)
- [x] [exec](inputs/exec)
- [x] [ping](inputs/ping)
- [x] [http_response](inputs/http_response)
- [x] [net_response](inputs/net_response)
- [x] [procstat](inputs/procstat)
- [x] [mysql](inputs/mysql)
- [x] [redis](inputs/redis)
- [x] [oracle](inputs/oracle)
- [x] [rabbitmq](inputs/rabbitmq)
- [x] [prometheus](inputs/prometheus)
- [x] [tomcat](inputs/tomcat)
- [x] [nvidia_smi](inputs/nvidia_smi)
- [x] [nginx_upstream_check](inputs/nginx_upstream_check)
- [x] [kubernetes(read metrics from kubelet api)](inputs/kubernetes)
- [x] [kube_state_metrics](inputs/kube_state_metrics)
- [x] [nginx_vts](inputs/nginx_vts)
- [ ] mongodb
- [ ] rocketmq
- [ ] activemq
- [ ] kafka
- [ ] elasticsearch
- [x] windows
- [ ] mssql
- [ ] iis
- [ ] weblogic
- [ ] was
- [ ] hadoop
- [ ] ad
- [x] [zookeeper](inputs/zookeeper)
- [ ] statsd
- [ ] snmp
- [x] [switch_legacy](inputs/switch_legacy)
- [ ] ipmi
- [ ] smartctl
- [ ] logging
- [ ] trace

## FAQ

[FAQ](https://www.gitlink.org.cn/flashcat/categraf/wiki)

## Thanks

Categraf is developed on the basis of Telegraf and Exporters. Thanks to the great open source community.
add LICENSE 2022-05-16 11:58:50 +08:00			`# Categraf`
add README 2022-04-14 15:18:49 +08:00
code refactor 2022-05-31 06:35:56 +08:00			`Categraf is a monitoring agent for nightingale/prometheus/m3db/victoriametrics/thanos/influxdb/tdengine.`
add README 2022-04-14 15:18:49 +08:00
add quickstart link in README 2022-05-31 06:33:13 +08:00			`## QuickStart`

			`[QuickStart](https://www.gitlink.org.cn/flashcat/categraf/wiki)`

update README 2022-05-30 13:43:58 +08:00			`## Releases`

			`[Releases](https://www.gitlink.org.cn/flashcat/categraf/releases)`

add LICENSE 2022-05-16 11:58:50 +08:00			`## Build`
add README 2022-04-14 15:18:49 +08:00
			```shell
add LICENSE 2022-05-16 11:58:50 +08:00			`# export GO111MODULE=on`
			`# export GOPROXY=https://goproxy.cn`
add README 2022-04-14 15:18:49 +08:00			`go build`
			```
deploy categraf as daemonset 2022-06-13 19:52:13 +08:00
update readme 2022-06-13 19:55:02 +08:00			`## Deploy categraf as daemonset`
deploy categraf as daemonset 2022-06-13 19:52:13 +08:00
			```shell
update daemonset yaml 2022-06-15 11:37:08 +08:00			`edit k8s/categraf.yaml, replace NSERVER_SERVICE_WITH_PORT with service ip:port of nserver in your cluster, replace CATEGRAF_NAMESPACE with namespace value, then run:`
deploy categraf as daemonset 2022-06-13 19:52:13 +08:00
add all-in-one daemonset yaml 2022-06-13 23:58:57 +08:00			`kubectl apply -n monitoring -f ks8/categraf.yaml`
deploy categraf as daemonset 2022-06-13 19:52:13 +08:00			```
add README 2022-04-14 15:18:49 +08:00
add LICENSE 2022-05-16 11:58:50 +08:00			`## Test`

			```shell
			`./categraf --test`

			`# usage:`
			`./categraf --help`
			```

			`## Pack`
add README 2022-04-14 15:18:49 +08:00
			```shell
			`tar zcvf categraf.tar.gz categraf conf`
			```
code refactor 2022-04-17 11:05:12 +08:00
add done plugins 2022-05-24 20:07:07 +08:00			`## Plan`
code refactor 2022-04-17 11:05:12 +08:00
update README 2022-06-14 19:42:35 +08:00			`- [x] [system](inputs/system)`
			`- [x] [kernel](inputs/kernel)`
			`- [x] [kernel_vmstat](inputs/kernel_vmstat)`
			`- [x] [linux_sysctl_fs](inputs/linux_sysctl_fs)`
			`- [x] [cpu](inputs/cpu)`
			`- [x] [mem](inputs/mem)`
			`- [x] [net](inputs/net)`
			`- [x] [netstat](inputs/netstat)`
			`- [x] [disk](inputs/disk)`
			`- [x] [diskio](inputs/diskio)`
update REDME: add conntrack and zookeeper plugin link 2022-06-21 10:33:58 +08:00			`- [x] [conntrack](inputs/conntrack)`
update README 2022-06-14 19:42:35 +08:00			`- [x] [ntp](inputs/ntp)`
			`- [x] [processes](inputs/processes)`
			`- [x] [exec](inputs/exec)`
			`- [x] [ping](inputs/ping)`
			`- [x] [http_response](inputs/http_response)`
			`- [x] [net_response](inputs/net_response)`
			`- [x] [procstat](inputs/procstat)`
			`- [x] [mysql](inputs/mysql)`
			`- [x] [redis](inputs/redis)`
			`- [x] [oracle](inputs/oracle)`
			`- [x] [rabbitmq](inputs/rabbitmq)`
			`- [x] [prometheus](inputs/prometheus)`
			`- [x] [tomcat](inputs/tomcat)`
			`- [x] [nvidia_smi](inputs/nvidia_smi)`
			`- [x] [nginx_upstream_check](inputs/nginx_upstream_check)`
			`- [x] [kubernetes(read metrics from kubelet api)](inputs/kubernetes)`
update README 2022-06-20 14:37:03 +08:00			`- [x] [kube_state_metrics](inputs/kube_state_metrics)`
add some more ping metrics 2022-06-21 10:55:49 +08:00			`- [x] [nginx_vts](inputs/nginx_vts)`
code refactor 2022-05-02 15:35:01 +08:00			`- [ ] mongodb`
			`- [ ] rocketmq`
			`- [ ] activemq`
			`- [ ] kafka`
			`- [ ] elasticsearch`
add plugin: nginx_upstream_check 2022-06-01 11:58:12 +08:00			`- [x] windows`
code refactor 2022-05-02 15:35:01 +08:00			`- [ ] mssql`
			`- [ ] iis`
			`- [ ] weblogic`
			`- [ ] was`
			`- [ ] hadoop`
			`- [ ] ad`
update REDME: add conntrack and zookeeper plugin link 2022-06-21 10:33:58 +08:00			`- [x] [zookeeper](inputs/zookeeper)`
code refactor 2022-05-02 15:35:01 +08:00			`- [ ] statsd`
			`- [ ] snmp`
update README 2022-06-14 19:42:35 +08:00			`- [x] [switch_legacy](inputs/switch_legacy)`
code refactor 2022-05-02 15:35:01 +08:00			`- [ ] ipmi`
			`- [ ] smartctl`
			`- [ ] logging`
			`- [ ] trace`
add LICENSE 2022-05-16 11:58:50 +08:00
update README 2022-05-30 13:43:58 +08:00			`## FAQ`

			`[FAQ](https://www.gitlink.org.cn/flashcat/categraf/wiki)`

add LICENSE 2022-05-16 11:58:50 +08:00			`## Thanks`

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