Skip to content

Commit dafc272

Browse files
authored
Docs for DPL users (#145)
1 parent c1a64a3 commit dafc272

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

doc/DPL.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Instructions for DPL users
2+
3+
DPL stands for [Data Processing Layer](https://github.com/AliceO2Group/AliceO2/tree/dev/Framework/Core) and it is part of ALICE O<sup>2</sup> Framework.
4+
5+
### Monitoring in DPL
6+
7+
A URL to the monitoring backend can be passed through `monitoring-url` parameter. This will redirect all the metric to the selected backend. The list of supported backends is available in the [Monitoring README](https://github.com/AliceO2Group/Monitoring#monitoring-instance) file.
8+
9+
Then, from the `DataProcessingDevice` source Monitoring instance can be accessed via [Monitoring service](https://github.com/AliceO2Group/AliceO2/tree/dev/Framework/Core#monitoring-service).
10+
11+
### Monitoring backends at CERN
12+
13+
There are so-called _Community Services_ available at CERN GPN network and O<sup>2</sup> developers are welcome to use them in order to store and display metrics.
14+
15+
#### Time-series database
16+
A time-series database, called [InfluxDB](https://docs.influxdata.com/influxdb/v1.7/), is used for metric storage.
17+
18+
Pass the following Monitoring URL via `--monitoring-url` to your workflow in order to redirect metrics to _Community Services_ instance:
19+
```
20+
influxdb-udp://aido2mon-gpn:8089
21+
```
22+
23+
#### Dashboard
24+
25+
Time-series can be visualised in [Grafana](https://grafana.com) using a web browser.
26+
27+
1. Go to: https://alice-o2-mon.cern.ch:3000
28+
2. Sign in with CERN SSO
29+
3. Create a new dashboard, then and a new panel and use [Query Editor](http://docs.grafana.org/features/datasources/influxdb/#query-editor) to visualise previously stored metrics.

0 commit comments

Comments
 (0)