Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
81 lines (56 sloc) 2.72 KB

Graphite-API documentation

GitHub project Build Status PyPI version

Graphite-API is an alternative to Graphite-web, without any built-in dashboard. Its role is solely to fetch metrics from a time-series database (whisper, cyanite, etc.) and rendering graphs or JSON data out of these time series. It is meant to be consumed by any of the numerous Graphite dashboard applications.

Graphite-API is a fork of Graphite-web and couldn't have existed without the fantastic prior work done by the Graphite team.

Why should I use it?

Graphite-API offers a number of improvements over Graphite-web that you might find useful. Namely:

Note

Graphite-API does not provide any web/graphical interface. If you currently rely on the built-in Graphite composer, Graphite-API might not be for you. However, if you're using a third-party dashboard interface, Graphite-API will do just fine.

Contents

.. toctree::
   :maxdepth: 2

   installation
   configuration
   deployment
   api
   functions
   finders
   custom-functions
   releases

Indices and tables