Skip to content

Commit 63b1432

Browse files
committed
fixes for OLOG-6
1 parent 72482b2 commit 63b1432

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

doc/README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ the logging database content.
2727

2828
## Installation
2929

30-
Installation described here is for standard CERN CentOS 7 (CC7) operating system
31-
(http://linux.web.cern.ch/linux/centos7/).
30+
Installation described here is for standard [CERN CentOS 7 (CC7)](http://linux.web.cern.ch/linux/centos7/) operating system.
31+
It was tested fine on machines installed with the default 'desktop recommended setup' selected during CERN PXE-boot setup phase.
32+
Some minor tweaks might be needed on different systems.
33+
3234

3335
Infologger RPM packages can be installed through yum repository.
3436
At the moment, everything is bundled in a single RPM named o2-InfoLogger-standalone, containing all components described above.
@@ -111,7 +113,7 @@ collected centrally.
111113
`/opt/o2-InfoLogger/bin/infoBrowser &`
112114
* When launched, it goes in "online" mode, i.e. it connects to the infoLoggerServer and displays messages in real time.
113115
* To browse previously stored messages, click the green "online" button (to exit online mode), fill-in selection filters, and push "query".
114-
* Detailed usage of infoBrowser can be found in the historical ALICE DAQ documentation, e.g. at https://alice-daq.web.cern.ch/operations/infobrowser.
116+
* Detailed usage of infoBrowser can be found in the historical [ALICE DAQ documentation](https://alice-daq.web.cern.ch/operations/infobrowser).
115117
The interface has not changed.
116118
117119
* Log a test message from command line:
@@ -125,6 +127,11 @@ collected centrally.
125127
Archive menu.
126128
* See other administrative commands possible with `/opt/o2-InfoLogger/bin/infoLoggerAdminDB -h`
127129
130+
131+
## API for developers
132+
133+
The InfoLogger library allows to inject messages directly from programs, as shown in the examples below.
134+
128135
* Compile a sample program using InfoLogger library:
129136
* (C++ 14):
130137
`vi myLog.cpp`
@@ -171,15 +178,15 @@ collected centrally.
171178
172179
## Configuration
173180
174-
* Description and example of parameters for each InfoLogger component can be foud in /opt/o2-InfoLogger/etc/*.cfg.
181+
* Description and example of parameters for each InfoLogger component can be found in /opt/o2-InfoLogger/etc/*.cfg.
175182
The parameters can usually be mixed in a single configuration file, as they are grouped in sections ([infoLoggerServer], [infoLoggerD], [infoBrowser], ...).
176183
177184
* On multiple-hosts systems, the serverHost configuration key should be set for infoLoggerD and infoBrowser, so that they are able to connect infoLoggerServer
178185
if not running locally.
179186
180187
* On the infoLoggerServer host, the firewall should allow incoming connections
181188
on ports 6006 (infoLoggerD), 6102 (infoBrowser) and 3306 (MySQL). It can be
182-
achieved on CentOS 7 with e.g.:
189+
achieved on CentOS 7 with e.g. (as root):
183190
```
184191
firewall-cmd --permanent --zone=public --add-port=6006/tcp
185192
firewall-cmd --permanent --zone=public --add-port=6102/tcp

0 commit comments

Comments
 (0)