timera 0.2.1

Copyright (c) 2017 the Timera authors and contributors <see AUTHORS.txt file>.

Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Portions of the code marked as "stolen from Paste" are provided under the
following license:

Copyright (c) 2005 Ian Bicking and Contributors

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Description: Timera
======

Store metrics in InfluxDB.

.. figure:: docs/img/plugin-httptimer-grafana-dashboard-1.png
:scale: 50 %
:alt: Grafana Dashboard

Grafana Dashboard

There's currently one plugin included with Timera, ``httptimer``.

With ``httptimer``, you can store the time it takes to get http responses. For example:

.. code-block:: ini

[httptimer_plugin_01]
name = www.google.com
url = https://www.google.com/
proxy = http://proxy.example.com:3128/
include_direct = true

See the config file, `config.ini <https://github.com/natej/timera/blob/master/config.ini>`_, for options.

Use any InfluxDB-compatible visualization software to view your metrics. For example:

- `Chronograf <https://portal.influxdata.com/downloads>`_
- `Grafana <http://docs.grafana.org/features/datasources/influxdb/>`_

Plugins
-------

Timera has a simple plugin system. So it's easy to write your own plugin to collect and store the metrics you want.
See the custom plugin below and the included plugin
`httptimer <https://github.com/natej/timera/blob/master/timera/plugins/httptimer/>`_ for examples.

Config file:

.. code-block:: ini

[mymetrics_plugin_01]
plugin_import = mymetrics.metrics
name = cpu_load_short
field = value

``mymetrics/metrics.py``:

.. code-block:: python

import logging
import timera

log = logging.getLogger(__name__)

def get_metrics(config, timestamp, plugin):
"""
:param config: ConfigParser instance
:param timestamp: unix timestamp (seconds since epoch) for current collection interval
:param plugin: dict with parsed plugin values
"""
measurement = plugin['config']['name']
field = plugin['config']['field']
metric = 0.64
fields = {field: str(metric)}
tags = {'host': 'server01', 'region': 'us-west'}
log.info('%s %r: %s=%f' % (measurement, tags, field, metric))
measurementd = dict(measurement=measurement, time=timestamp, fields=fields, tags=tags)
idbc = timera.db.get_client(config)
timera.db.write_points(idbc, [measurementd])

If you create a plugin you think others would find useful, please submit a PR with tests for inclusion in Timera.

Requirements
------------

- `InfluxDB <https://portal.influxdata.com/downloads>`_
- `Python <https://www.python.org/>`_ 2.7 or 3.6, pip and setuptools.

Install
-------

.. code-block:: bash

$ pip install timera

Or if using a virtual environment:

.. code-block:: bash

$ source env/bin/activate
$ pip install timera

Development Install
-------------------

Use ``make install-dev`` to install in editable mode (``pip install -e .``) with pytest and tox:

.. code-block:: bash

$ source env/bin/activate
$ cd timera-master
$ make install-dev
$ make test
$ tox

Run It
------

Create db and start collecting metrics:

.. code-block:: bash

# edit config.ini
$ timera config.ini reset_db
$ timera config.ini start

Optional
--------

Use `Supervisor <https://github.com/Supervisor/supervisor>`_ to run Timera. See the
`contrib dir <https://github.com/natej/timera/blob/master/contrib/>`_. Supervisor requires
Python 2 (``pip install supervisor``).

Viewing Metrics with Grafana
----------------------------

Configure `InfluxDB as a datasource <http://docs.grafana.org/features/datasources/influxdb/>`_.

For the ``httptimer`` plugin, create a `graph panel <http://docs.grafana.org/features/panels/graph/>`_ and
configure the query:

.. figure:: docs/img/plugin-httptimer-grafana-metrics-tab-1.png
:scale: 50 %
:alt: Grafana Metrics Tab

Grafana Metrics Tab

Changes
-------

See `CHANGES.rst <https://github.com/natej/timera/blob/master/CHANGES.rst>`_.

License
-------

Timera is provided under the MIT License. See `LICENSE.txt <https://github.com/natej/timera/blob/master/LICENSE.txt>`_.

Keywords: influxdb system network monitoring
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Database
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: System :: Systems Administration
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*