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.3.tar.gz (75.5 kB view details)

Uploaded Source

Built Distribution

graphite_api-1.1.3-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.3.tar.gz.

File metadata

File hashes

Hashes for graphite-api-1.1.3.tar.gz
Algorithm Hash digest
SHA256 f72718124510065be75c53bf49bd69c16cdb13ca31431add77282c0f7c5933e3
MD5 060e8cf2263a29bc1e5642d86eafc3d1
BLAKE2b-256 0c5702f5f1ae8c044ef6b8ade555e7541c36ccb738b29a3bd1b6973d4266e8c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for graphite_api-1.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 252e599fc0195fe7ae9429d291b37d2cf2f2d098fc142b713141ca18a4f0e1dd
MD5 433d46edb739a095280cd8e4f65f4cbe
BLAKE2b-256 830cca75b8ba16d9bdc402e0e228b55c88b01c4cfa6518bb8a9ecb453237538f

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