meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
doc_recs4:software_interface [2022/02/17 14:02] – vordoc_recs4:software_interface [2022/02/17 14:42] – vor
Line 292: Line 292:
  
 A prometheus exporter is built-in and can be enabled. It is accessable at ''https://TOR-Master/metrics/'' or ''http://TOR-Master/metrics/'' and needs a http basic authentication.  A prometheus exporter is built-in and can be enabled. It is accessable at ''https://TOR-Master/metrics/'' or ''http://TOR-Master/metrics/'' and needs a http basic authentication. 
 +
 +The big advantage of the Prometheus exporter compared to other APIs is that it dynamically exports its own metrics and thus, additional metrics can be added or removed during runtime after changing or hotplugging hardware. This allows to export only metrics of those microservers that are plugged in. As the RECS<sup>(r)</sup>%%|%%Box has a modular approach and every RECS<sup>(r)</sup>%%|%%Box can be equipped with different carrier blades and microserver configurations, this approach is of high relevance. Using traditional monitoring tools that don’t support the export of dynamic metrics needs regular manual changes of the configuration files which is annoying. 
  
 ==== Prometheus Configuration ==== ==== Prometheus Configuration ====
  
-A typical configuration prometheus could look like this:+Prometheus needs very little configuration to automatically parse all information and write it into a database. This makes all metrics easily accessible. 
  
 <code> <code>
Line 310: Line 312:
 ==== Grafana Dashboard ==== ==== Grafana Dashboard ====
  
-An example grafana dashboard is published on https://grafana.com/grafana/dashboards/14622 and can be integrated in Grafana using the "Import" function in grafana.+It is recommended to use Grafana as a graphical dashboard to read out these captured metrics. A pre-build Grafana dashboard is publicly available at https://grafana.com/grafana/dashboards/14622. It can be integrated in Grafana using the "Import" function. It automatically reads the available metrics from the database and dynamically adapts to the number of available microservers, see the following picture: 
 + 
 +<imgcaption web-gui-overview|> 
 +{{ :documentation:grafana.png?direct&500 |Grafana Dashboard}}</imgcaption>