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

  • /metrics/search (removed strange keep_query_pattern parameter)

  • /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 caching. Rendering is live.

  • No Pickle.

  • 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.0.1.tar.gz (67.9 kB view details)

Uploaded Source

Built Distribution

graphite_api-1.0.1-py2.py3-none-any.whl (72.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for graphite-api-1.0.1.tar.gz
Algorithm Hash digest
SHA256 10b917539dcab2734a82dac124c29d7a029debd578071e13708bbd0d2b5038ba
MD5 466c13a902744bed09a054da452140f0
BLAKE2b-256 11f7794badb93c374ae10d01a5193f4dc01b8bfa47ebd530a11d2d8304517e1c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for graphite_api-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ba36b49f32dd7a0cddd1ebe16439981dc189af77cb19b05a1af7de2d9e425c63
MD5 6ae9a5b3ab275ce6b9208bd8c09c2258
BLAKE2b-256 3f66671789f49bed3e74fe3ffe2ab0343c35cd8af185d0d56780f25fe045c46a

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