meta data for this page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
doc_recs4:software_interface [2021/04/30 09:40] – [Components] bil | doc_recs4:software_interface [2023/10/13 10:06] – bil | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Software interface ====== | ====== Software interface ====== | ||
- | There are several software interfaces available to monitor the status of the RECS< | + | There are several software interfaces available to monitor the status of the RECS< |
===== Management WebGUI ===== | ===== Management WebGUI ===== | ||
Line 13: | Line 13: | ||
|{{ : | |{{ : | ||
- | Figure 1 shows the first call of the Management Web****GUI. It is organized into three columns. The first is on the left-hand side and contains the following: | + | Figure 1 shows the first call of the Management Web****GUI. The menu on the left side contains the following: |
[[documentation: | [[documentation: | ||
Line 118: | Line 118: | ||
Example XML: | Example XML: | ||
- | <code xml>< | + | <code xml>< |
actualPEGPowerUsage=" | actualPEGPowerUsage=" | ||
- | baseBoardId=" | + | baseboardId=" |
lastSensorUpdate=" | lastSensorUpdate=" | ||
highestTemperature=" | highestTemperature=" | ||
Line 132: | Line 132: | ||
|'' | |'' | ||
|'' | |'' | ||
- | |'' | + | |'' |
- | |'' | + | |'' |
|'' | |'' | ||
|'' | |'' | ||
Line 175: | Line 175: | ||
Example XML: | Example XML: | ||
- | <code xml><baseBoard | + | <code xml><baseboard |
lastSensorUpdate=" | lastSensorUpdate=" | ||
< | < | ||
Line 185: | Line 185: | ||
< | < | ||
< | < | ||
- | </baseBoard></ | + | </baseboard></ |
The attributes have the following meaning: \\ | The attributes have the following meaning: \\ | ||
Line 205: | Line 205: | ||
Example XML: | Example XML: | ||
- | <code xml>< | + | <code xml>< |
< | < | ||
- | <baseBoardId> | + | <baseboardId> |
- | <baseBoardId> | + | <baseboardId> |
- | <baseBoardId> | + | <baseboardId> |
- | <baseBoardId> | + | <baseboardId> |
- | <baseBoardId> | + | <baseboardId> |
- | <baseBoardId> | + | <baseboardId> |
</ | </ | ||
Line 226: | Line 226: | ||
|'' | |'' | ||
|'' | |'' | ||
+ | |'' | ||
|'' | |'' | ||
|'' | |'' | ||
- | |'' | + | |'' |
In accordance to the component rcu the API offers rcuList which returns multiple instances of rcu. | In accordance to the component rcu the API offers rcuList which returns multiple instances of rcu. | ||
Line 284: | Line 285: | ||
|''/ | |''/ | ||
|''/ | |''/ | ||
+ | |''/ | ||
=== Errors === | === Errors === | ||
Information about the success or failure of management requests are returned via HTTP status codes. Please have a look at [[http:// | Information about the success or failure of management requests are returned via HTTP status codes. Please have a look at [[http:// | ||
+ | |||
+ | ===== Prometheus ===== | ||
+ | |||
+ | A prometheus exporter is built-in and can be enabled. It is accessable at '' | ||
+ | |||
+ | 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< | ||
+ | |||
+ | ==== Prometheus Configuration ==== | ||
+ | |||
+ | Prometheus needs very little configuration to automatically parse all information and write it into a database. This makes all metrics easily accessible. | ||
+ | |||
+ | < | ||
+ | - job_name: ' | ||
+ | scrape_interval: | ||
+ | scrape_timeout: | ||
+ | static_configs: | ||
+ | - targets: [' | ||
+ | basic_auth: | ||
+ | username: ' | ||
+ | password: ' | ||
+ | </ | ||
+ | |||
+ | ==== Grafana Dashboard ==== | ||
+ | |||
+ | 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:// | ||
+ | |||
+ | < | ||
+ | {{ : | ||
+ | |||