Prometheus#

This section provides information about Prometheus and the exporters available in Carbonio CE, that are used to fetch information from log files, Carbonio CE nodes, and metrics exposed by Carbonio CE services.

Introduction and Architecture#

Prometheus is a time-series database that stores all the information about the historical data of Carbonio CE, allowing Administrators to obtain a view and evolution of the system.

The monitoring functionality in Carbonio CE is realized thanks to these main tools:

Prometheus Server

The main Prometheus server, which processes log files and metrics to stores time-series data.

Node Exporter

The main exporter, installed on every Node of the Carbonio CE infrastructure, which gathers the metrics exposed by the hardware and Operating System.

Specialised Exporters

These are special-purpose exporters, responsible to collect data and metrics from a given service running on Carbonio CE.

Dependencies#

The Node Exporter component is automatically installed with the carbonio-core package.

To make sure that the correct Exporter in installed along the service from which it fetches data, when a Role in installed, the corresponding Prometheus Exporter is installed. For example, when the Proxy Role is installed, the carbonio-prometheus-nginx-exporter package is installed as well: no additional installation activity is therefore necessary.

The list of available exporters, including some additional information, is shown in Table 5

Table 5 List of Available Prometheus Exporters#

Exporter

Role

Port

carbonio-prometheus-consul-exporter

Mesh and Directory

9107

carbonio-prometheus-openldap-exporter

Mesh and Directory

9330

carbonio-prometheus-mysqld-exporter

Mailstore & Provisioning

9104

carbonio-prometheus-nginx-exporter

Proxy

9113

carbonio-prometheus-node-exporter

Every Carbonio CE node

9100

carbonio-prometheus-postgres-exporter

Database

9187

carbonio-prometheus-process-exporter

As desired [1]

9256

carbonio-prometheus-clamav-exporter

MTA AV/AS

9810

Grafana Dashboards#

The data gathered by the Exporters and stored in Prometheus Server is used to create predefined dashboards to show in real-time the situation of a service or of the system and its evolution.

The list of available Grafana Dashboards and the procedure to install them can be found in Section Import Dashboards.