eXo Monitoring stack

Table of Contents

• Architecture
• install
• local testing

status : beta

This repository aims to give a ready to use Monitoring stack for eXo Platform 5+.

Warning

this configuration should not be exposed to internet due to very few security constraints applied on this configuration (ex: Influxdb is open for read and write access)

Architecture

install

Note	prerequisites : docker-compose 1.18+ docker 17.12.0-ce+ internet connection

First you need to checkout the project :

user@host:/opt/ $ git clone git@github.com:exoplatform/monitoring-stack.git

then create a /opt/monitoring-stack/.env file for your local configuration

user@host:/opt/monitoring-stack/ $ touch /opt/monitoring-stack/.env

and update it according to your needs :

/opt/monitoring-stack/.env

# DNS hostname for Grafana (your DNS need to be configured accordingly)
VHOST_GRAFANA=grafana.my-domain.com
# The mysql password for exo user
DB_GRAFANA_USER_PASSWORD=database-secret-password
# password of the first Grafana administrator
GF_SECURITY_ADMIN_PASSWORD=admin-secret-password
# DNS hostname for Influxdb (your DNS need to be configured accordingly)
VHOST_INFLUXDB=influxdb.my-domain.com

Finally start the monitoring stack

user@host:/opt/monitoring-stack/ $ docker-compose -f /opt/monitoring-stack/docker-compose.yml up -d

Note	If you want to use host network instead of standard bridge network, start the monitoring stack with the following command :

user@host:/opt/monitoring-stack/ $ docker-compose -f /opt/monitoring-stack/docker-compose.yml -f /opt/monitoring-stack/docker-compose.network-host.yml  up -d

and go to http://grafana.my-domain.com and login with admin / admin-secret-password

local testing

Add the following entries in your /etc/hosts file :

127.0.0.1 grafana.docker.local
127.0.0.1 influxdb.docker.local
127.0.0.1 traefik.docker.local

Launch the monitoring stack with :

user@host:~/monitoring-stack $ docker-compose -f ./docker-compose.yml up -d

Then the following components are available :

• Grafana : http://grafana.docker.local

• Influxdb : http://influxdb.docker.local (no user interface)

• Traefik : http://traefik.docker.local