Graphite-web, without the interface. Just the rendering HTTP API.
Project description
Graphite-web, without the interface. Just the rendering HTTP API.
This is a minimalistic API server that replicates the behavior of Graphite-web. I removed everything I could and simplified as much code as possible while keeping the basic functionality.
Implemented API calls:
/metrics/find
/metrics/expand
/metrics/search (removed strange keep_query_pattern parameter)
/render
No-ops:
/dashboard/find
/dashboard/load/<name>
/events/get_data
Difference from graphite-web
Stateless. No need for a database.
No caching. Rendering is live.
No Pickle.
Graphite-web has a history of accepting URLs with or without a trailing slash. Graphite-API only supports URLs with no trailing slash.
JSON data in request bodies is supported, additionally to form data and querystring parameters.
Ceres integration will be as an external backend.
Compatibility with python 2 and 3.
Easy to install and configure.
Goals
Solid codebase. Strict flake8 compatibility, good test coverage.
Ease of installation/use/configuration.
Compatibility with the original Graphite-web API.
Non-goals
Support for very old Python versions.
Built-in support for every metric storage system in the world. Whisper is included by default, other storages are added via 3rd-party backends.
Installation
git clone git@github.com:brutasse/graphite-api.git
cd graphite-api
sudo python setup.py installAlternatively, you can run setup.py install as a normal user, in a virtualenv.
Configuration
The default config file path is /etc/graphite-api.conf. The format is YAML.
search_index: /srv/graphite/index
whisper:
directories:
- /srv/graphite/whisper
time_zone: Europe/BerlinIf you need the configuration file to be at a different location, you can set the GRAPHITE_API_CONFIG environment variable to the location you want.
Storage finders
Graphite-API can read from any metrics store as long as it has a compatible storage finder. Finders can be configured this way:
finders:
- graphite_api.finders.whisper.WhisperFinder
- cyanite.CyaniteFinderMultiple finders are allowed.
Functions
Custom functions can be added to extend the built-in grammar. The default functions are:
functions:
- graphite_api.functions.SeriesFunctions
- graphite_api.functions.PieFunctionsDeploying
With Gunicorn or any WSGI server. The WSGI application is located at graphite_api.app:app.
sudo pip install gunicorn
gunicorn graphite_api.app:appHacking
Tox is used to run the tests for all supported environments. To get started from a fresh clone of the repository:
pip install tox
tox
