json-based metrics collector
Go Shell Makefile
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config_dir_example
docker
src
.gitignore
CHANGELOG.md
Dockerfile
LICENSE.txt
Makefile
README.md
gollector-graphite.go
gollector.go
graph.png
gstat.go
test.json

README.md

Gollector

Gollector is a metrics collector that emits JSON responses, which can be consumed by monitoring systems such as Circonus. The flexibility of the JSON responses leads to many monitoring possibilities, such as the included 'gstat', which is an n-host iostat-alike for all metrics gollector is collecting.

Gollector was birthed by Triggit and still maintained regularly. It is in production on hundreds of machines as of this writing.

Here's a graph generated in Circonus from data provided by Gollector:

An Example

Most of the built-in collectors are linux-only for now, and probably the future unless pull requests happen. Many plugins very likely require a 3.0 or later kernel release due to dependence on system structs and other deep voodoo.

Gollector does not need to be run as root to collect its metrics. For things that need root, or work with additional data sources (such as data stores), check out the sister project Gollector Monitors.

Gollector also now supports Graphite! make gollector-graphite or just make will build the program, which bridges the two services. Please see the tool's usage information (no arguments) for assistance using this feature.

Unlike other collectors that use fat tools like netstat and df which can take expensive resources on loaded systems, Gollector opts to use the C interfaces directly when it can. This allows it to keep a very small footprint; with the go runtime, it clocks in just above 5M resident and unnoticeable CPU usage at the time of writing. The agent can sustain over 8000qps with a benchmarking tool like wrk, so it will be plenty fine getting hit once per minute, or even once per second.

Docker Example

The pre-programmed metrics in the docker image come from test.json in this repository.

docker pull erikh/gollector
docker run -i -t erikh/gollector:latest
# wait a few seconds for it to start. the process will block.
# to get the metrics
curl http://gollector:gollector@`docker port $(docker ps | grep gollector | awk '{ print $1 }') 8000`

If you're having trouble parsing the metrics with your eyes, piping to jq . (jq is here) can give you a nice, colored, pretty printed version.

Quick Start from Source

In the gollector directory on a Linux machine with kernel 3.0 or better:

$ make
$ ./gollector generate > gollector.json
$ ./gollector gollector.json &
$ ./gstat -hosts localhost -metric "load_average"

Should yield an array of floats that contain your current load average.

$ curl http://gollector:gollector@localhost:8000/

Will yield a json object of all current metrics.

Wiki

Our wiki contains tons of information on advanced configuration, usage, and even tools you can use with Gollector. Check it out!

License

  • MIT (C) 2013 Erik Hollensbe