summaryrefslogtreecommitdiff
path: root/doc/dlt.conf.5.txt
blob: ebc3a69ff814d9faf04ef6d43e0dccfbd937c303 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
DLT.CONF(5)
=============
:doctype: manpage

NAME
----
dlt.conf - DLT daemon configuration file

DESCRIPTION
-----------
The DLT daemon is the central place where logs and traces are gathered
from different applications, stored temporarily or permanently and
transferred to a DLT client application, which can run directly on the
GENIVI system or more likely on a external tester device.

The configuration file dlt.conf allows to configure the different
runtime behaviour of the dlt-daemon. The configuration file is loaded
during startup of dlt-daemon.

dlt-daemon loads by default the configuration file /etc/dlt.conf. An
alternative configuration file can be loaded with the option -c.

GENERAL OPTIONS
---------------

*Daemonize*::
    If set to 1 DLT daemon is started in background as daemon. This option
    is only needed in System V init systems. In systemd based startup
    systems the daemon is started by spawning own process.

    Default: 0

*SendSerialHeader*::
    If set to 1 DLT daemon sends each DLT message to the client with
    prepanding the serial header "DLS0x01".

    Default: 0

*SendContextRegistration*::
    If set to 1 each context which is registered from an application in the
    DLT daemon generates a message to inform the DLT client about the new
    context.

    Default: 0

*SendMessageTime*::
    If set to 1 DLt daemon sends each second a DLT control message to the
    client with the current timestamp from the system.

    Default: 0

*ECUId*::
    This value sets the ECU Id, which is sent with each DLT message.

    Default: ECU1

*SharedMemorySize*::
    This value sets the size of the shared memory, which is used to exchange
    DLT messages between applications and daemon. This value is defined in
    bytes. If this value is changed the system must be rebooted to take
    effect.

    Default: 100000

*PersistanceStoragePath*::
    This is the directory path, where the DLT daemon stores its runtime
    configuration. Runtime configuration includes stored log levels, trace
    status and changed logging mode.

    Default: /tmp

OFFLINE TRACE OPTIONS
---------------------

*OfflineTraceDirectory*::
    If this option is set, offline trace is enabled. This value sets the
    directory path to the offline trace memory. The directory must already
    exist.

    Default: Offline tracing is disabled.

*OfflineTraceFileSize*::
    This value defines the max size of a offline trace file, if offline trace
    is enabled. This value is defined in bytes. If the files size of the
    current used log file is exceeded, a new log file is created.

    Default: 1000000

*OfflineTraceMaxSize*::
    This value defines the max offline Trace memory size, if offline trace
    is enabled. This value is defined in bytes. If the overall offline trace
    size is excedded, the oldest log files are deleted, until a new trace
    file fits the overall offline trace max size.

    Default: 4000000

LOCAL CONSOLE OUTPUT OPTIONS
----------------------------

*PrintASCII*::
    Prints each received DLT message from the application in ASCII to the
    local console.
    This option should only be anabled for debugging purpose.

    Default: Function is disabled

*PrintHex*::
    Prints each received DLT message from the application in ASCII to the
    local console. The payload is printed in Hex.
    This option should only be anabled for debugging purpose.

    Default: Function is disabled

*PrintHeadersOnly*::
    Prints each received DLT message from the application in ASCII to the
    local console. Only the header is printed.
    This option should only be anabled for debugging purpose.

    Default: Function is disabled

SERIAL CLIENT OPTIONS
---------------------

*RS232DeviceName*::
    If this value is set to a serial device name, e.g. /dev/ttyS0, a serial
    port is used for logging to a client.

    Default: Serial port for logging is disabled

*RS232Baudrate*::
    The used serial baud rate, if serial loggin is enabled. The
    RS232DeviceName must be set to enable serial logging.

    Default: 115200

*RS232SyncSerialHeader*::
    If serial logging is enabled, each received DLT message is checked to
    contain a serial header. If the DLT message contains no serial header,
    the message is ignored.

    Default: Function is disabled

TCP CLIENT OPTIONS
------------------

*TCPSyncSerialHeader*::
    Each received DLT message on a TCP connection is checked to contain a
    serial header. If the DLT message contains no serial header, the message
    is ignored.

ECU Software version info
-------------------------

*SendECUSoftwareVersion*::
    Send periodic ECU version info. 0=disabled, 1=enabled.

    Default: 0

*PathToECUSoftwareVersion*::
    Absolute path to file storing version information - if disabled the DLT version will be send.

Offline Logstorage OPTIONS
--------------------------

*OfflineLogstorageMaxDevices*::
    Maximum devices to be used as offline logstorage devices (1 .. DLT_OFFLINE_LOGSTORAGE_MAX_DEVICES).

    Default: Off, zero logstorage devices are supported.

EXAMPLES
--------
Start DLT daemon in background mode::
    *dlt-daemon -d*

Start DLT daemon with own configuration::
    *dlt-daemon -c ~/my-dlt-configuration.cfg*

AUTHOR
------
Alexander Wenzel (alexander.aw.wenzel (at) bmw.de)

RESOURCES
---------
Main web site: <http://projects.genivi.org/diagnostic-log-trace> +
Mailinglist: <https://lists.genivi.org/mailman/listinfo/genivi-diagnostic-log-and-trace>

SEE ALSO
--------
dlt-daemon(1) +
dlt-system(1)