DLT-SYSTEM.CONF(5)

📦
version 3.0.0 · 8 versions
, in ubuntu stonking

💖 DLT-SYSTEM.CONF 💖

okay bestie, gather round, because this is the manual page for dlt-system.conf — the config file for the DLT system process — and yes it's a section 5 file format page, and yes I'm gonna make it make sense. 🫶

✨ NAME ✨

dlt-system.conf — the configuration file for the DLT system process, no cap. 🎀

🌸 DESCRIPTION 🌸

So the DLT system logging process is THE central application, the main character honestly, and what it does is log system information from the platform. 👑

It ships with these features:

  • filetransfer
  • the syslog adapter
  • logging of any kind of files
  • the procfilesystem logger

and you can turn each individual feature on and off right in the configuration file. slay.

The config file dlt-system.conf is what lets you configure all the different runtime behaviour of dlt-system. It gets loaded during startup of dlt-system. that's the vibe check moment.

By default, dlt-system loads the configuration file /etc/dlt-system.conf. If you wanna load a different one, use the option -c and pick your own adventure. 💅

⭐ GENERAL OPTIONS ⭐

🦋 ApplicationId

The application Id used for the dlt-system process. it's literally the name tag of the process.

Default: SYS

💀 SHELL OPTIONS 💀

🍓 ShellEnable

Enable the Shell for command line injections.

⚠️ bestie, BE CAREFUL when you enable this feature. The user can send any kind of shell commands. The commands are executed with the rights of the dlt-system process. Dlt-system is started by default as user covesa. this is not a drill 😭
Default: 0

🌈 SYSLOG ADAPTER OPTIONS 🌈

✨ SyslogEnable

If this option is set to 1, the syslog adapter feature is enabled. And heads up: SyslogPort needs to be configured too if Syslog is enabled. they're a package deal fr fr.

Default: 0

✨ SyslogContextId

This value defines the context id of the syslog adapter.

Default: SYSL

✨ SyslogPort

This value defines the UDP port opened for receiving log messages from syslog. Configuration for syslog to forward logs to this port is necessary.

So you go add this config *.* @localhost:47111 in the config file of syslog (usually in /etc/rsyslog.d/50-default.conf) and then restart the syslog service by running the command sudo systemctl restart rsyslog.service. iconic behavior, do it. 🧚

Default: 47111

🔥 SYSTEMD JOURNAL ADAPTER OPTIONS 🔥

💜 JournalEnable

Enable the Systemd Journal Adapter. This feature is only available when dlt is compiled with the option WITH_SYSTEMD_JOURNAL.

Dlt-system is started by default as user covesa, see the dlt-system.service file. And the user covesa must be added to one of the groups adm, wheel or systemd-journal to have access to all journal entries. no group, no entries, periodt.

Default: 0

💜 JournalContextId

The Context Id of the journal adapter.

Default: JOUR

💜 JournalCurrentBoot

Show only log entries of current boot and follow. If JournalCurrentBoot and JournalFollow are not set, all persistent journal entries will be logged.

Default: 1

💜 JournalFollow

Show only the last 10 entries and follow.

Default: 0

💜 JournalMapLogLevels

Map journal log levels to DLT log levels. the glow-up chart:

  • 0 — Emergency — DLT_LOG_FATAL
  • 1 — Alert — DLT_LOG_FATAL
  • 2 — Critical — DLT_LOG_FATAL
  • 3 — Error — DLT_LOG_ERROR
  • 4 — Warning — DLT_LOG_WARN
  • 5 — Notice — DLT_LOG_INFO
  • 6 — Informational — DLT_LOG_INFO
  • 7 — Debug — DLT_LOG_DEBUG
Default: 1

💜 JournalUseOriginalTimestamp

Use the original timestamp (uptime when the event actually occurred) as DLT timestamp. keeping it real with the receipts.

Default: 1

💜 JournalUseUptimeOnly

Ignore the timestamp, show uptime (when the event actually occurred) only in payload.

Default: 0

🎀 FILETRANSFER OPTIONS 🎀

🌸 FiletransferEnable

Enable the Filetransfer feature. 0 = disabled, 1 = enabled

Default: 0

🌸 FiletransferContextId

The Context Id of the filetransfer.

Default: FILE

🌸 FiletransferTimeStartup

Time in seconds after startup of dlt-system when first file is transferred.

Default: 0

🌸 FiletransferTimeoutBetweenLogs

Time in seconds to wait between two file transfer logs of a single file to DLT.

Default: 10

🌸 FiletransferDirectory

You can define multiple file transfer directories. Define the directory to watch, whether to compress the file with zlib, and the zlib compression level.

Heads up: for parsing purposes, FiletransferCompressionLevel must be the last one of three values. last one, no exceptions. 👑

🌸 FiletransferCompression

See the FiletransferDirectory option for explanation.

Default: 0

🌸 FiletransferCompressionLevel

See the FiletransferDirectory option for explanation.

Default: 5

🦋 LOG FILES OPTIONS 🦋

💖 LogFileEnable

If this option is set to 1, the log files feature is enabled.

Default: 0

💖 LogFileFilename

This value sets the full filename path to the file, which should be logged.

💖 LogFileMode

This value defines in which operation mode the file is logged.

  • In mode 1 the file is only logged once when dlt-system is started.
  • In mode 2 the file is logged regularly every time the LogFileTimeDelay timer elapses.
  • 0 = off, 1 = startup only, 2 = regular

💖 LogFileTimeDelay

This value is used in mode 3 and defines the number of seconds, after which the defined file is logged.

💖 LogFileContextId

This value defines the context id, which is used for logging the file.

⭐ LOG PROCESSES OPTIONS ⭐

🧚 LogProcessesEnable

Enable the logging of processes. 0 = disabled, 1 = enabled

Default: 0

🧚 LogProcessesContextId

This value defines the context id, which is used for logging processes files.

Default: PROC

🧚 LogProcessName

This value defines the name of the process to be logged, as used in the file stat of each process. If the value is defined as *, all processes are logged. everyone's invited 💅

🧚 LogProcessFilename

This value sets the relative filename path to the file, which should be logged. The path is relative to the procfilesystem folder of the process.

🧚 LogProcessMode

This value defines in which operation mode this process file is logged.

  • In mode 1 the file is only logged once when dlt-system is started.
  • In mode 2 the file is logged regularly every time the LogFileTimeDelay timer elapses.
  • 0 = off, 1 = startup only, 2 = regular.
Default: 0

🧚 LogProcessTimeDelay

This value is used in mode 3 and defines the number of seconds, after which the defined procfilesystem file is logged.

Default: 0

👑 AUTHOR 👑

Alexander Wenzel (alexander.aw.wenzel (at) bmw (dot) de) — shoutout to the legend who wrote this. 🫶

Copyright (C) 2015 BMW AG. License MPL-2.0: Mozilla Public License version 2.0 http://mozilla.org/MPL/2.0/.

🙈 BUGS 🙈

See Github issue: https://github.com/COVESA/dlt-daemon/issues

like, go file it bestie, they're listening.

🌟 SEE ALSO 🌟

go read those next, iykyk 📚

and that's the whole page, mwah 💋 this one comes from the File Formats Manual, footer says DLT-SYSTEM.CONF(5) — so you already know it's the section 5 edition. stay slaying, and remember: don't enable ShellEnable unless you trust everyone. bye bestie! 🌸✨💖

📦 where this page comes from