Installation

Python package

Prerequisites

Installing Graphite-Render requires:

  • Python 3 (3.9 and above).

  • Pip, the Python package manager. On debian/ubuntu, install python-pip.

  • For image rendering (PNG/SVG/PDF graphs): Cairo. On debian/ubuntu, install the libcairo2 package.

Global installation

To install Graphite-Render globally on your system, run as root:

$ pip install graphite-render

Isolated installation (virtualenv)

If you want to isolate Graphite-Render from the system-wide python environment, you can install it in a virtualenv.

$ virtualenv /usr/share/python/graphite
$ /usr/share/python/graphite/bin/pip install graphite-render

Extra dependencies

When you install graphite-render, all the dependencies for running a Graphite server that uses Whisper as a storage backend are installed. You can specify extra dependencies:

  • For Sentry integration: pip install graphite-render[sentry].

  • For Cyanite integration: pip install graphite-render[cyanite].

  • For Cache support: pip install graphite-render[cache]. You’ll also need the driver for the type of caching you want to use (Redis, Memcache, etc.). See the Flask-Cache docs for supported cache types.

You can also combine several extra dependencies:

$ pip install graphite-render[sentry,cyanite]