query

query takes both positional and keyword arguments, which in turn are taken from graphite-web’s render API except for the graph/format arguments, which are, of course, inapplicable to graphite-query.

In short, its parameters (in positional order) are:

• target: required, a graphite-web compatible path (i.e. string), or a list of paths, see http://graphite.readthedocs.org/en/latest/render_api.html#target for additional documentation.

• from and until: two optional parameters that specify the relative or absolute time period to graph. see http://graphite.readthedocs.org/en/latest/render_api.html#from-until

• tz: optional, time zone to convert all times into. If this parameter is not specified, then graphitequery.query.settings.TIME_ZONE is used (if any). Finally, system’s timezone is used if TIME_ZONE is empty. see http://graphite.readthedocs.org/en/latest/render_api.html#tz

A basic query might look like this:

>>> from graphitequery.query import query
>>> print list(query("graphite-web.compatible.path.expression")[0])

The query function always (even if you supply only one target path) returns a list of instances of graphitequery.query.datalib.TimeSeries, which in turn is a list-like object whose sub-elements are the values stored by graphite (in a whisper database) at particular points in time.

eval_qs

This is a helper function: it takes a URL query string as a parameter. The query string must be compatible with the graphite-web’s render controller. eval_qs internally converts this string to a parameter dictionary that can be passed on to query and calls query.E.g.:

>>> from graphitequery.query import query, eval_qs
>>> print list(eval_qs("format=raw&target=*.*.*")[0])
>>> # The above is the same as:
>>> print list(query(**{"target": "*.*.*"}))

get_all_leaf_nodes

Returns a list of all leaf nodes/targets that are found in the settings.STORAGE_DIR. It doesn’t have any parameters.