Installation Instructions
=========================

.. note::

   All required components of the RSB Performance Monitoring pipeline can be obtained using the `Cognitive Interaction Toolkit infrastructure <https://toolkit.cit-ec.uni-bielefeld.de>`_.
   In this case, you can directly continue with :doc:`configuration`.

It is advisable to install all related software into a common directory, called *prefix*.

Installation of Dependencies
----------------------------

#. Install the C++ and Python implementations of :ref:`RSB <rsb:rsb>` as described in the :ref:`installation instructions <rsb:install>`.

#. Install :ref:`RST <rst:rst>` as explained in the :ref:`installation instructions <rst:installation>`. Ensure that the python implementation is installed as well.

Installation of RSB Performance Monitoring Components
-----------------------------------------------------

Installation of rsb-process-monitor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

:program:`rsb-process-monitor` is implemented in C++ for performance reasons.
Is is shipped as CMake project.

#. Clone the git repository:

   .. code-block:: bash

      git clone https://code.cor-lab.org/git/rsb-performance-monitor.git.process-monitor rsb-process-monitor

#. Configure the CMake project

   .. code-block:: bash

      cd rsb-process-monitor
      mkdir build
      cd build
      cmake -DCMAKE_PREFIX_PATH=${prefix} -DCMAKE_INSTALL_PREFIX=${prefix} ..

   Replace ``${prefix}`` with the prefix where you installed :ref:`RSB <rsb:rsb>` and :ref:`RST <rst:rst>` to.

#. Compile and install

   .. code-block:: bash

      make
      make install

Installation of rsb-host-monitor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

:program:`rsb-host-monitor` is implemented in python.
Therefore, we need to ensure that the required packages (e.g. from :ref:`RSB <rsb:rsb>` are available on the :envvar:`PYTHONPATH`.

#. Clone the git repository:

   .. code-block:: bash

      git clone https://code.cor-lab.org/git/rsb-performance-monitor.git.host-monitor rsb-host-monitor

#. Install the project:

   .. code-block:: bash

      export PYTHONPATH=${prefix}/lib/python2.7/site-packages:$PYTHONPATH
      export PYTHONPATH=${prefix}/lib/python2.7/site-packages/rst-*.egg:$PYTHONPATH
      export PYTHONPATH=${prefix}/lib/python2.7/site-packages/rstsandbox-*.egg:$PYTHONPATH
      cd rsb-host-monitor
      python setup.py install --prefix=${prefix}

   Replace ``${prefix}`` with the prefix where you installed :ref:`RSB <rsb:rsb>` and :ref:`RST <rst:rst>` to.

Installation of rsbperfmon-db-adapter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

:program:`rsbperfmon-db-adapter` is implemented in python.
Therefore, we need to ensure that the required packages (e.g. from :ref:`RSB <rsb:rsb>` are available on the :envvar:`PYTHONPATH`.

#. Clone the git repository:

   .. code-block:: bash

      git clone https://code.cor-lab.org/git/rsb-performance-monitor.git.db-adapter rsbperfmon-db-adapter

#. Install the project:

   .. code-block:: bash

      export PYTHONPATH=${prefix}/lib/python2.7/site-packages:$PYTHONPATH
      export PYTHONPATH=${prefix}/lib/python2.7/site-packages/rst-*.egg:$PYTHONPATH
      export PYTHONPATH=${prefix}/lib/python2.7/site-packages/rstsandbox-*.egg:$PYTHONPATH
      cd rsbperfmon-db-adapter
      python setup.py install --prefix=${prefix}

   Replace ``${prefix}`` with the prefix where you installed :ref:`RSB <rsb:rsb>` and :ref:`RST <rst:rst>` to.

Installation of a Timeseries Database Backend
---------------------------------------------

Currently, two different timeseries databases are supported as backends.
You need to select one.

   `InfluxDB <https://influxdb.com>`_
      More modern timeseries database with well-structured query language.
      Only version 0.8 is supported.
   `Graphite <https://graphite.readthedocs.org/en/latest>`_
      Well-known monitoring database and web-frontend.
      Less structured query language and harder to deploy

While InfluxDB provides the much more modern experience and is easier to administer, Graphite currently provides better performance with less CPU impact and better control of automatic retention.
Depending on your needs, decide on one of the solutions.

Installation of InfluxDB
^^^^^^^^^^^^^^^^^^^^^^^^

InfluxDB can be installed using the provided Debian package as explained in the `installation instructions <https://influxdb.com/docs/v0.8/introduction/installation.html>`__.
In case you need to install InfluxDB without root permissions, extracting the Debian package is the only feasible solution.

Installation of Graphite
^^^^^^^^^^^^^^^^^^^^^^^^

Please follow the provided `installation instructions <https://graphite.readthedocs.org/en/latest/install.html>`__.
It is advisable to install Graphite into a `virtualenv <https://virtualenv.pypa.io/en/latest>`_.

Installation of the Grafana Dashboard Solution
----------------------------------------------

In order to install `Grafana <https://grafana.org>`_ you can either follow the `installation instructions <http://docs.grafana.org/installation/>`__ for specific systems, or just download one of the binary archives referenced on the `download page <http://grafana.org/download/>`_ and extract it somewhere.