You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/configurationParameters.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
This document describes all the configuration parameters that can be set in readout.
4
4
5
-
Some parameters control the behavior of readout as soon as it starts, and valid for the lifetime of the process. (1)
5
+
Some parameters control the behavior of readout as soon as it starts, and are valid for the lifetime of the process. (1)
6
6
7
7
Other parameters (2) are set whenever the control state-machine receives the CONFIGURE command (or shortly after startup when running o2-readout-exe outside from the ECS workflow, typically from the command line) and until the RESET command.
8
8
The corresponding parameters usually come from a local file or from a central reposity, as provided by the O2 system.
@@ -11,20 +11,20 @@ They can be reloaded several time during the lifetime of the process.
11
11
12
12
# Readout defaults (1)
13
13
14
-
These are defined in local file `/etc/o2.d/readout-default.cfg`, which is loaded on `o2-readout-exe` startup (if file exists). They are valid for the lifetime of the o2-readout-exe process. There is usually no need for users to edit these settings. The file format is '.ini' style, with `[sections]` and `key=value` pairs.
14
+
These are defined in local file `/etc/o2.d/readout-default.cfg`, which is loaded on `o2-readout-exe` startup (if the file exists). They are valid for the lifetime of the o2-readout-exe process. There is usually no need for users to edit these settings. The file format is '.ini' style, with `[sections]` and `key=value` pairs.
15
15
16
-
Following table describe the parameters of the `[readout]` section.
16
+
Following table describes the parameters of the `[readout]` section.
17
17
18
18
| Parameter name | Type | Default value | Description |
19
19
|--|--|--|--|
20
20
| memLock | int | 0 | Defines the memory swapping policy. If set, all readout memory is locked in RAM with mlockall() |
21
21
| readoutExe | string || If set, overwrites the current running executable with the one at given path. Used for tests. |
22
22
| readoutConfig | string || If set with readoutExe, launch the new exe with this parameter as argument. Used for tests. |
23
-
| statsPublishAddress | string || If set, address where to publish readout stats, eg "tcp://127.0.0.1:6008". Connect to this service with o2-readout-monitor. |
23
+
| statsPublishAddress | string || If set, address where to publish readout stats, eg "tcp://127.0.0.1:6008" (o2-readout-monitor should listen there). |
24
24
| statsPublishInterval | string || If set, interval for readout stats publish, in seconds. |
25
25
| db | string || If set, defines connection parameters to a MySQL database in the form 'user:password@host/dbname'. Runtime statistics are stored in a table. Structure can be created with o2-readout-admin-db. |
26
26
| customCommandsEnabled | int | 0 | If set, custom commands are enabled, i.e. launching external scripts at some specific state transitions. See customCommands keyword below. |
27
-
| membanksMonitorPath | string || Path to memory banks monitor output (a local file FIFO, to be connected with o2-readout-monitor). |
27
+
| membanksMonitorPath | string || Path to memory banks monitor output (a local file FIFO, to be connected with o2-readout-monitor-memory). |
28
28
| membanksMonitorRate | double | 0 | Rate (in Hertz) at which to publish memory status. |
0 commit comments