RSB Performance Monitoring

h1. Dashboard Pipeline Setup

{{>toc}}

h2. Installation of Required Software

# Install rsb, rst

# Install rsb-performance-monitor

# Install rsb-performance-monitor-graphite-adapter (git in this project)

# Install InfluxDB (ideally just use the DEB archive or citk)

# Install grafana (just extract the pre-built archive somewhere, or citk)

# Install elasticsearch (Optionally, used to store dashboard configurations server-side. Client-side storing is also possible. Install binary archive, e.g. from citk)

h2. Configuration

# Configure InfluxDB as desired. A config file which uses just a local computer and /tmp for data is attached. Please note that in this file the @assets@ line in the @admin@ section needs to be fixed so that it point to the installation of the required files for the admin web interface.

# Configure grafana to operate with this instance of InfluxDB. A sample configuration file is attached.

Please note that everyone calling the grafana web page in his browser later on needs to be able to communicate directly with the running InfluxDB instance since all plotting is performed client-side via JS.

h2. Startup

# Start InfluxDB, e.g. with

  <pre>$prefix/opt/influxdb/influxdb -config=$prefix/etc/vdemo_scripts/data/influxdb-config-tmp.toml</pre>

# Ensure that a database exists inside the running DB. In this case, we will call it @data@

  <pre>curl -X POST 'http://localhost:8086/db?u=root&p=root' -d '{"name": "data"}'</pre>

# Start some rsb-performace-monitor instances, assuming that monitoring results will be published on @/monitoring@ and @/host@

# Start rsb-performance-monitor-graphite-adapter with the InfluxDB backend

  <pre>$prefix/bin/rsbperfmon-graphite -d -b influxdb -a</pre>

  Assumes that InfluxDB runs on localhost with port 8086 and root:root as credentials. If not, provide the required arguments. @-d@ pre-calculates derivatives of some values for better visualization purposes later on, @-a@ aggregates all subprocesses into the results of a single monitored process since most of the time only the cumulative results of a functional component are interesting.

# Start a webserver to server the static grafana files, e.g.:

  <pre> cd $prefix/opt/grafana && python2 -m SimpleHTTPServer 8020</pre>

# Optionally, start an elasticsearch server

  <pre>$prefix/opt/elasticsearch/bin/elasticsearch -Des.path.data=$HOME/.elasticsearch</pre>

  Chose an appropriate data path

h2. Usage

# Open the grafana webpage at http://localhost:8020

# Configure the dashboard as needed

# Save the dashboard, either to elasticsearch or to your browser

h2. Notes

* Use meaningful credentials instead of root:root