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

Uploaded Source

Built Distribution

graphite_api-1.0.0-py2.py3-none-any.whl (72.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for graphite-api-1.0.0.tar.gz
Algorithm Hash digest
SHA256 72985cd8198da06084f304b4077162f7f56b6ab3743ba3bd6c4467f233c17e1a
MD5 473278c8ed51304ccb30e0d66ac14f63
BLAKE2b-256 4dba7945dd8570cb86e7309599ae1d13b913323afef2738175821439157c4106

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for graphite_api-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c7da375b872d1274350ce4c31d402da47435794924dfd65cf7f9395f4b58b62c
MD5 80150d84dccfb90f34650ca3f5cab413
BLAKE2b-256 fa98ea75f45830f02d178955b172ddb41b4bf08170ca785604b51684e5c14b7e

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