Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[run]
branch = True
source = graphite_api
source = graphite_render

[report]
omit = *_vendor*
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Graphite-API
Graphite-Render
============

**Note:** This is a friendly fork of the upstream project at https://github.com/brutasse/graphite-api.
Expand Down
8 changes: 4 additions & 4 deletions bin/graphite
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ import os

os.environ.setdefault('DEBUG', '1')

import graphite_api
import graphite_render

graphite_api.DEBUG = bool(int(os.environ['DEBUG']))
graphite_render.DEBUG = bool(int(os.environ['DEBUG']))

from graphite_api.app import app
from graphite_render.app import app


if __name__ == '__main__':
port = int(os.environ.get('PORT', 8888))
host = os.environ.get('BIND_ADDRESS', '127.0.0.1')
app.run(debug=graphite_api.DEBUG, port=port, host=host)
app.run(debug=graphite_render.DEBUG, port=port, host=host)
6 changes: 3 additions & 3 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Example::
The Render API -- ``/render``
=============================

Graphite-API provides a ``/render`` endpoint for generating graphs
Graphite-Render provides a ``/render`` endpoint for generating graphs
and retrieving raw data. This endpoint accepts various arguments via query
string parameters, form data or JSON data.

Expand Down Expand Up @@ -697,7 +697,7 @@ fontName
*Default: 'Sans'*

Change the font used to render text on the graph The font must be installed
on the Graphite-API server.
on the Graphite-Render server.

Example::

Expand Down Expand Up @@ -1162,7 +1162,7 @@ Example::
tz
``

*Default: The timezone specified in the graphite-api configuration*
*Default: The timezone specified in the graphite-render configuration*

Time zone to convert all times into.

Expand Down
14 changes: 7 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

master_doc = 'index'

project = 'Graphite-API'
project = 'Graphite-Render'
copyright = u'2014, Bruno Renié'

version = '1.1.4'
Expand All @@ -34,24 +34,24 @@
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

htmlhelp_basename = 'Graphite-APIdoc'
htmlhelp_basename = 'Graphite-Renderdoc'

latex_elements = {
}

latex_documents = [
('index', 'Graphite-API.tex', 'Graphite-API Documentation',
('index', 'Graphite-Render.tex', 'Graphite-Render Documentation',
'Bruno Renié', 'manual'),
]

man_pages = [
('index', 'graphite-api', 'Graphite-API Documentation',
('index', 'graphite-render', 'Graphite-Render Documentation',
['Bruno Renié'], 1)
]

texinfo_documents = [
('index', 'Graphite-API', 'Graphite-API Documentation',
'Bruno Renié', 'Graphite-API', 'One line description of project.',
('index', 'Graphite-Render', 'Graphite-Render Documentation',
'Bruno Renié', 'Graphite-Render', 'One line description of project.',
'Miscellaneous'),
]

Expand All @@ -63,7 +63,7 @@ class RenderFunctionDocumenter(autodoc.FunctionDocumenter):
def can_document_member(cls, member, membername, isattr, parent):
return autodoc.FunctionDocumenter.can_document_member(
member, membername, isattr, parent
) and parent.name == 'graphite_api.functions'
) and parent.name == 'graphite_render.functions'

def format_args(self):
args = super(RenderFunctionDocumenter, self).format_args()
Expand Down
34 changes: 17 additions & 17 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Configuration
=============

/etc/graphite-api.yaml
/etc/graphite-render.yaml
----------------------

The configuration file for Graphite-API lives at ``/etc/graphite-api.yaml``
The configuration file for Graphite-Render lives at ``/etc/graphite-render.yaml``
and uses the YAML format. Creating the configuration file is optional: if
Graphite-API doesn't find the file, sane defaults are used. They are described
Graphite-Render doesn't find the file, sane defaults are used. They are described
below.

Default values
Expand All @@ -16,10 +16,10 @@ Default values

search_index: /srv/graphite/index
finders:
- graphite_api.finders.whisper.WhisperFinder
- graphite_render.finders.whisper.WhisperFinder
functions:
- graphite_api.functions.SeriesFunctions
- graphite_api.functions.PieFunctions
- graphite_render.functions.SeriesFunctions
- graphite_render.functions.PieFunctions
whisper:
directories:
- /srv/graphite/whisper
Expand All @@ -34,7 +34,7 @@ Default sections
*search_index*

The location of the search index used for searching metrics. Note that it
needs to be a file that is writable by the Graphite-API process.
needs to be a file that is writable by the Graphite-Render process.

*finders*

Expand All @@ -54,7 +54,7 @@ Default sections

*time_zone*

The time zone to use when generating graphs. By default, Graphite-API tries
The time zone to use when generating graphs. By default, Graphite-Render tries
to detect your system timezone. If detection fails it falls back to UTC. You
can also manually override it if you want another value than your system's
timezone.
Expand Down Expand Up @@ -110,7 +110,7 @@ Extra sections

*sentry_dsn*

This is useful if you want to send Graphite-API's exceptions to a `Sentry`_
This is useful if you want to send Graphite-Render's exceptions to a `Sentry`_
instance for easier debugging.

Example::
Expand All @@ -119,10 +119,10 @@ Extra sections

.. note::

Sentry integration requires Graphite-API to be installed with the
Sentry integration requires Graphite-Render to be installed with the
corresponding extra dependency::

$ pip install graphite-api[sentry]
$ pip install graphite-render[sentry]

.. _Sentry: https://docs.getsentry.com

Expand Down Expand Up @@ -159,23 +159,23 @@ Extra sections
This would configure Flask-Cache with ``CACHE_TYPE = 'redis'`` and
``CACHE_REDIS_HOST = 'localhost'``.

Some cache options have default values defined by Graphite-API:
Some cache options have default values defined by Graphite-Render:

* ``default_timeout``: 60

* ``key_prefix``: ``'graphite-api:``.
* ``key_prefix``: ``'graphite-render:``.

.. note::

Caching functionality requires you to install the cache extra dependency
but also the underlying driver. E.g. for redis, you'll need::

$ pip install graphite-api[cache] redis
$ pip install graphite-render[cache] redis

*statsd*

Attaches a statsd object to the application, which can be used for
instrumentation. Currently Graphite-API itself doesn't use this,
instrumentation. Currently Graphite-Render itself doesn't use this,
but some backends do, like `Graphite-Influxdb`_.

Example::
Expand All @@ -200,8 +200,8 @@ Extra sections
Custom location
---------------

If you need the Graphite-API config file to be stored in another place than
``/etc/graphite-api.yaml``, you can set a custom location using the
If you need the Graphite-Render config file to be stored in another place than
``/etc/graphite-render.yaml``, you can set a custom location using the
``GRAPHITE_API_CONFIG`` environment variable::

export GRAPHITE_API_CONFIG=/var/lib/graphite/config.yaml
8 changes: 4 additions & 4 deletions docs/custom-functions.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Custom functions
================

Just like with storage finders, it is possible to extend Graphite-API to add
Just like with storage finders, it is possible to extend Graphite-Render to add
custom processing functions.

To give an example, let's implement a function that reverses the time series,
Expand Down Expand Up @@ -30,12 +30,12 @@ Once you've created your function, declare it in a dictionnary:
'reverseSeries': reverseSeries,
}

Add your module to the Graphite-API Python path and add it to the
Add your module to the Graphite-Render Python path and add it to the
configuration:

.. code-block:: yaml

functions:
- graphite_api.functions.SeriesFunctions
- graphite_api.functions.PieFunctions
- graphite_render.functions.SeriesFunctions
- graphite_render.functions.PieFunctions
- reverse.ReverseFunctions
Loading