carbonapi

README

carbonapi: replacement graphite API server

CarbonAPI supports a significant subset of graphite functions [see COMPATIBILITY]. In our testing it has shown to be 5x-10x faster than requesting data from graphite-web.

For requirements see Requirements secion below.

The only required parameter is the path to a config file. For an example see carbonapi.example.yaml

$ ./carbonapi -config /etc/carbonapi.yaml

Request metrics will be dumped to graphite if coresponding config options are set, or if the GRAPHITEHOST/GRAPHITEPORT environment variables are found.

Request data will be stored in memory (default) or in memcache.

Requirements

CarbonAPI uses protobuf-based protocol to talk with underlying storages. For current version the compatibility list is:

1. carbonzipper >= 0.50
2. go-carbon >= 0.9.0 (Note: you need to enable carbonserver in go-carbon). Limitations: /info handler won't work properly
3. carbonserver@master (Note: you should probably switch to go-carbon in that case). Limitations: /info handler won't work properly
4. graphite-clickhouse any. That's alternative storage that doesn't use Whisper. Limitations: /info handler won't work properly.
5. carbonapi >= 0.5. Note: we are not sure if there is any point in running carbonapi over carbonapi at this moment.

OSX Build Notes

Some additional steps may be needed to build carbonapi with cairo rendering on MacOSX.

Install cairo:

$ brew install Caskroom/cask/xquartz

$ brew install cairo --with-x11

Acknowledgement

This program was originally developed for Booking.com. With approval from Booking.com, the code was generalised and published as Open Source on github, for which the author would like to express his gratitude.

License

This code is licensed under the MIT license.