Skip to main content

Graphite-web, without the interface. Just the rendering HTTP API.

Project description

Build Status Coverage Status

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

  • /render

No-ops:

  • /dashboard/find

  • /dashboard/load/<name>

  • /events/get_data

Additional API calls:

  • /index (POST or PUT only): rebuilds the search index by recursively querying the storage backends for available paths. Replaces graphite-web’s build-index command-line script.

Difference from graphite-web

  • Stateless. No need for a database.

  • No Pickle rendering.

  • No remote rendering.

  • 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 and 3rd-party dashboards.

Non-goals

  • Support for very old Python versions (Python 2.6 is still supported but maybe not for long).

  • Built-in support for every metric storage system in the world. Whisper is included by default, other storages are added via 3rd-party backends.

Documentation

On readthedocs.org or in the docs/ directory.

Hacking

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

graphite-api-1.1.2.tar.gz (74.8 kB view details)

Uploaded Source

Built Distribution

graphite_api-1.1.2-py2.py3-none-any.whl (80.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file graphite-api-1.1.2.tar.gz.

File metadata

File hashes

Hashes for graphite-api-1.1.2.tar.gz
Algorithm Hash digest
SHA256 bfd112cdc7ef1812429afc8b481bda38fb12d85bbabdd098be2c60e55cce1cca
MD5 df2f2d980630c58cbeea0b5c9bd01ce9
BLAKE2b-256 3bd61f286509f33ca9a4fd52f4fe6f819c7c53393e15ccd3cb3a3a7bde6daa0e

See more details on using hashes here.

File details

Details for the file graphite_api-1.1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for graphite_api-1.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6b81614e77a6436e67e68a86d520320e5a7e4d877d11fb714a9add6603cc2f24
MD5 035b84eb669d1e067a2e2b8c28feba42
BLAKE2b-256 468ed17c6caaf30264249bbd09c76a9ddde47e03856fdcacf50d42a5570ede84

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page