Skip to content

Commit

Permalink
1.1.0 release notes updates
Browse files Browse the repository at this point in the history
  • Loading branch information
DanCech committed Dec 18, 2017
1 parent 31768fd commit 02773f8
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 10 deletions.
6 changes: 5 additions & 1 deletion docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ Most functions are applied to one :term:`series list`. Functions with the parame
``*seriesLists`` can take an arbitrary number of series lists. To pass multiple series lists
to a function which only takes one, use the :py:func:`group` function.

.. _list-of-functions :
.. _list-of-functions:

List of functions
-----------------
.. automodule:: graphite.render.functions
:members:

.. _function-plugins:

Function Plugins
----------------

Expand Down Expand Up @@ -88,6 +90,8 @@ To load a packaged function plugin module, add it to the ``FUNCTION_PLUGINS`` se
'some.function_plugin',
]
.. _function-api:

Function API
------------

Expand Down
18 changes: 9 additions & 9 deletions docs/releases/1_1_0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,25 @@ Graphite can also be installed from `PyPI <http://pypi.python.org/>`_ via
* http://pypi.python.org/pypi/carbonate/


The main feature of this release is :doc:`Tagging support </tags>` in Carbon and Graphite-web. From the release of the 1.1.x series, Graphite supports storing data using tags to identify each series. This allows for much more flexibility than the traditional hierarchical layout. When using tag support, each series is uniquely identified by its name and set of tag/value pairs. We also have new functions (``seriesByTags``,``groupByTags`` and ``aliasByTags``) for querying tagged series.
The main feature of this release is :ref:`tag support <tags>` in Carbon and Graphite-web. From the release of the 1.1.x series, Graphite supports storing data using tags to identify each series. This allows for much more flexibility than the traditional hierarchical layout. When using tag support, each series is uniquely identified by its name and set of tag/value pairs. We also have new functions (``seriesByTags``, ``groupByTags`` and ``aliasByTags``) for querying tagged series, and support for using tags in all existing aggregation & grouping functions.

Also, all components of Graphite stack now support Python 3. Python 3 support is however considered experimental, as this is the first release with complete Python 3 support.
All components of Graphite stack now support Python 3. Python 3 support is however considered experimental, as this is the first release with complete Python 3 support.

Another long-awaited feature is :doc:`Custom functions </functions#function-plugins>` - you can write your own functions and load them into Graphite. There's also the :doc:`Function API </functions#function-api` to get a list of available functions, or the details of a specific function. Please note that the built-in frontend code does not yet use the Functions API, so your functions will not be present in the Graphite-web interface.
Another long-awaited feature is :ref:`Custom functions <function-plugins>` - you can write your own functions and load them into Graphite. There's also the :ref:`Function API <function-api>` to get a list of available functions, or the details of a specific function. Please note that the built-in frontend code does not yet use the Functions API, so your functions will not be present in the Graphite-web interface.

Graphite 1.1.0 also has completely refactored clustering code - for example, now clustering can use `msgpack`_ format for intra-cluster communications and supports buffering HTTP when talking to cluster servers, which should `increase the reading speed`_. If you're using custom finders you can use :doc:`new documentation </storage-backends#advanced-finders>` to make your code use the new features too.
Graphite 1.1.0 also has completely refactored clustering code - for example, now clustering can use `msgpack`_ format for intra-cluster communications and supports buffering HTTP when talking to cluster servers, which should `increase the reading speed`_. If you're using custom finders you can use :ref:`new documentation <advanced-finders>` to make your code use the new features too.

Graphite now supports "pipe" chaining syntax for functions. With this update the following query ``aliasByNode(movingAverage(sortByName(test.*),"5min"),1)`` can be written as ``test.*|sortByName()|movingAverage("5min")|aliasByNode(1)``. See `PR#2042`_ for details.

New function ``xFilesFactor`` which sets the xFilesFactor for runtime aggregation and consolidation, also aggregation functions (`moving*` and new ``aggregate`` function) now supporting ``xFilesFactor`` explicitly - see `PR#2053`_ for details.

Please check other new features, bug fixes and changes in list below.
A host of other new features, bug fixes and changes are in the list below.


New features
------------

* Tagging support / Tags Autocompletion / TagDB Federation (@DanCech)
* Tagging support / Tags Autocompletion / TagDB Federation (PR#2002 / PR#2078 / PR#2128, @DanCech)

* Python3 support (PR#2139, @takluyver)

Expand All @@ -60,7 +60,7 @@ New features
Functions
---------

* :doc:`Custom functions </functions#function-plugins>` (PR#2146, @DanCech)
* :ref:`Custom functions <function-plugins>` (PR#2146, @DanCech)

* Use timezone-aware dates in ``hitcount``, update epoch to handle naive dates (PR#2088, @DanCech)

Expand Down Expand Up @@ -158,7 +158,7 @@ Bug Fixes

* Get rid of OverflowError in perSecond and scaleToSeconds (@Felixoid)

* Clean up perSecond and nonNegativeDerivative maxValue and None handling (@DacCech)
* Clean up perSecond and nonNegativeDerivative maxValue and None handling (@DanCech)

* Use ``WEBAPP_VERSION`` in documentation link (@wridgers)

Expand Down Expand Up @@ -227,7 +227,7 @@ Carbon

* Catch TypeError exception from None data value (@retzkek)

* Added '--logger' and '--logfile' option (Du Zheng/@deniszh)
* Added '--logger' and '--logfile' option (Du Zheng / @deniszh)

* Fixing lint (@DanCech)

Expand Down
4 changes: 4 additions & 0 deletions docs/storage-backends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ Whisper database and a Ceres database:
'graphite.finders.ceres.CeresFinder',
)
.. _custom-finders:

Custom finders
^^^^^^^^^^^^^^

Expand Down Expand Up @@ -119,6 +121,8 @@ the database has gaps: gaps can be filled with ``None`` values.
available for this given metric in the database. It must return an
``IntervalSet`` of one or more ``Interval`` objects.

.. _advanced-finders:

Advanced finders
^^^^^^^^^^^^^^^^

Expand Down
2 changes: 2 additions & 0 deletions docs/tags.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _tags:

Graphite Tag Support
====================
From the release of the 1.1.x series, Graphite supports storing data using tags to identify each series. This allows for much more flexibility than the traditional hierarchical layout. When using tag support, each series is uniquely identified by its name and set of tag/value pairs.
Expand Down

0 comments on commit 02773f8

Please sign in to comment.