Graphite-Render documentation

GitHub project PyPI version

Graphite-render is a fork of graphite-api for python3, and would not be possible with all the great work of its predecessors.

Graphite-api itself 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-Render is maintained for python3 only. Other than that is offers all the things that made graphite-api great:

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

  • The Graphite-Render application is completely stateless and doesn’t need a SQL database. It only needs to talk to a time series database.

  • Python 3.9+ is supported.

  • The HTTP API accepts JSON data additionnaly to form data and querystring parameters.

  • The application is extremely simple to install and configure.

  • The architecture has been drastically simplified and there are many fewer moving parts than in graphite-web:

  • The codebase has been thoroughly updated with a focus on test coverage and code quality.

Note

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

Contents

Indices and tables