summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* dlt-receive: Add option to configure port of dlt receive (#293)Alex2021-03-161-1/+4
| | | Signed-off-by: Alexander Mohr <git@mohr.io>
* Add verbose mode attribute handling (#292)Martin Willers2021-03-161-0/+33
| | | | | | dlt_user_log_write_*_attr() enables to writing these types, but also support adding "attributes" for them, i.e. a "name" and a "unit". Signed-off-by: Martin Willers <M.Willers@gmx.net>
* doc: Limitation to SIGUSR1 usage on AndroidSaya Sugiura2021-01-062-0/+12
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* example: Added customization of CxtID and AppIDdbiastoch2021-01-061-0/+106
| | | | | | | | -It's now possbile to enter a custom app and context ID by using the new implemented "-A" and "-C" arguments. -Also added a markdown manual in the doc directory for dlt-example-user. Signed-off-by: dbiastoch <dbiastoch@de.adit-jv.com>
* doc: Update doc for the maintain logstorage loglevel implementationKHANH LUONG HONG DUY2021-01-061-1/+24
| | | | Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* design doc: update spec for new environment variableBui Nguyen Quoc Thanh2021-01-061-0/+6
| | | | Signed-off-by: Bui Nguyen Quoc Thanh <thanh.buinguyenquoc@vn.bosch.com>
* doc: update disable injection msg for developerBui Nguyen Quoc Thanh2021-01-061-0/+16
| | | | Signed-off-by: Bui Nguyen Quoc Thanh <thanh.buinguyenquoc@vn.bosch.com>
* doc: Rewrote the DLT user documentation.Sebastian Unger2021-01-063-0/+171
| | | | | | | | - Write introduction and prepare new TOC - Intro to Get Started, instructions on how to download and detailed TOC further - Started Run DLT Demo section Signed-off-by: Sebastian Unger <sunger@de.adit-jv.com>
* Add support for logging with VSOCK (#255)Martin Ejdestig2020-12-141-8/+21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | For more information about VSOCK, see "man vsock" ( https://man7.org/linux/man-pages/man7/vsock.7.html ). Makes it possible for processes in a virtual machine to log directly in DLT running on host without setting up a network connection between guest and host. It is also probably more efficient. Have not done any performance measurements (not main reason for patch), but no forwarding is required as when running DLT in a multi-node setup. When building dlt-daemon for host, WITH_DLT_DAEMON_VSOCK_IPC should be enabled for daemon to listen on incoming VSOCK requests. Local communication method between applications and daemon is still determined with DLT_IPC. When building for guest, WITH_DLT_LIB_VSOCK_IPC should be enabled and DLT_IPC will be ignored, which will make libdlt open a VSOCK socket to the deamon for logging messages. VSOCK can be tested without a virtual machine. Since VMADDR_CID_HOST is used by libdlt when connecting, see vsock man page, clients can be run on host to test VSOCK communication. Some modifications has been done to be able to handle logging through FIFO pipe and socket in the same build of dlt-daemon: - dlt_receiver_init/free_unix_socket() is renamed to dlt_receiver_init/free_global_buffer() and used for FIFO as well. Also fixes memory leak since dlt_receiver_free_unix_socket() was used regardless of whether DLT_USE_UNIX_SOCKET was defined or not. - Pass type to dlt_receiver_init() instead of dlt_receiver_receive(). And remove preprocessor conditionals for handling DLT_CONNECTION_APP_MSG in dlt_daemon_process_user_messages(). Also fixes wrong enum type being passed to dlt_receiver_receive() in dlt_client.c (DltClient::mode was used as a DltReceiverType enum but it is a DltClientMode enum). - Add a flag to DltDaemonApplication to indicate whether file descriptor is "owned" by the DltDaemonApplication or not. When dlt_daemon_application_add() is called due to message received on a socket, fd is passed as an argument (app does not own fd). For FIFO, a per application FIFO is opened (app owns the fd). Also fixes so that user handle is reset for both application and all its contexts when resetting any. Prevents fd from being used by accident after it has been closed. dlt_mkdir_recursive() is moved to src/daemon since it is only used in the daemon. Minimizes use of DLT_USE_UNIX_SOCKET_IPC. Other bugfixes: - Call DLT_SEM_FREE() if setting socket to O_NONBLOCK fails in src/lib/dlt_user.c:dlt_initialize_socket_connection(). - Close socket if dlt_receiver_init() fails in src/lib/dlt_user.c:dlt_initialize_socket_connection(). Signed-off-by: Martin Ejdestig <martin.ejdestig@volvocars.com>
* dlt-daemon: Adds an option to disable injection mode (#266)sebastienr2020-11-251-0/+6
| | | | | | A new option named "InjectionMode" allows to select if we want to enable / disable the feature Signed-off-by: Sebastien RAILLET <sebastien.raillet@marelli.com>
* slog2 adapter on QNXNguyen Dinh Thi2020-07-081-0/+102
| | | | | | | | | | | | | | | dlt-qnx-system can be used to send syslog on QNX to dlt-daemon using slog2 API. It was be built with setting cmake option WITH_DLT_QNX_SYSTEM to ON. Add markdown manual page for dlt-qnx-system Signed-off-by: Nguyen Dinh Thi (RBVH/ENG2) <Thi.NguyenDinh@vn.bosch.com> Signed-off-by: Le Hoang Ngoc Quynh <Quynh.LeHoangNgoc@vn.bosch.com> Signed-off-by: Sebastian Unger <sunger@de.adit-jv.com> Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com> Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com> Signed-off-by: Felix Herrmann <fherrmann@de.adit-jv.com>
* doc/CMakeList.txt: replace dlt_design_specification.txt to .mdKHANH LUONG HONG DUY2020-07-061-1/+1
| | | | Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* remove unused featureKHANH LUONG HONG DUY2020-07-061-4/+0
| | | | Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* set DLT_NETWORK_TRACE_ENABLE by cmakedefineFelix Herrmann2020-07-061-0/+3
| | | | | Signed-off-by: Felix Herrmann <fherrmann@de.adit-jv.com> Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* doc: Update dlt_offline_logstorage.mdBui Nguyen Quoc Thanh2020-07-061-0/+1
| | | | | | | Add note/recommendation for the case multiple FILTERs use the same value for `File` setting. Signed-off-by: Bui Nguyen Quoc Thanh <thanh.buinguyenquoc@vn.bosch.com>
* dlt_design_specification: update contentLUONG HONG DUY KHANH(RBVH/ENG42)2020-07-063-125/+314
| | | | Signed-off-by: LUONG HONG DUY KHANH(RBVH/ENG42) <KHANH.LUONGHONGDUY@vn.bosch.com>
* dlt_design_specification: convert from .txt to .md formatLUONG HONG DUY KHANH(RBVH/ENG42)2020-07-062-644/+622
| | | | Signed-off-by: LUONG HONG DUY KHANH(RBVH/ENG42) <KHANH.LUONGHONGDUY@vn.bosch.com>
* doc: md file for dlt_gateway.confBui Nguyen Quoc Thanh2020-07-063-24/+135
| | | | Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* network trace: Add mqueue verificationSaya Sugiura2020-07-061-1/+7
| | | | | | | | | | There is some OS (e.g. Android) which doesn't support message queue. Since network trace uses it as IPC, we need to disable it if following calls are not available: mq_open, mq_close, mq_unlink, mq_send, mq_receive Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com> Signed-off-by: KHANH LUONG HONG DUY <khanh.luonghongduy@vn.bosch.com>
* Redirect stdout to stderrLUONG HONG DUY KHANH(RBVH/ENG42)2020-07-061-1/+1
| | | | | | | | | | | | - daemon: New feature for LoggingMode at /etc/dlt.conf to be able to set value at 3 in order to redirect all stdout messages to stderr. - libdlt: New feature for DLT_LOG_MODE environment variable to be able to set value at 3 in order to redirect all stdout messages to stderr. - unit test: Add test cases for DLT_LOG_TO_STDERR Signed-off-by: LUONG HONG DUY KHANH(RBVH/ENG42) <KHANH.LUONGHONGDUY@vn.bosch.com>
* doc: update a note for logstorage with wildcardBui Nguyen Quoc Thanh2020-07-061-0/+3
| | | | | | | If both of the parameter "LogAppName" and "ContextName" are set to wildcard or not present in the configuration file, "EcuID" must be specified. Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* doc: Logstorage non-verbose filterSaya Sugiura2020-07-061-1/+39
| | | | | | Add explanation and example to non-verbose filter. Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* Add documentation for new sized string functionsMartin Willers2020-05-181-2/+34
| | | | Signed-off-by: Martin Willers <M.Willers@gmx.net>
* doc/dlt_for_developers.md: Fix wrong DLT include directiveSebastian Lipponer2020-02-111-1/+1
| | | | | | | | | | | | The include directive '#include <dlt/dlt.h>' that is stated in the developer guide (see 'doc/dlt_for_developers.md') does not work when the include path is set via the pkg-config file 'automotive-dlt.pc'. The include path set via this file requires users to use the include directive '#include <dlt.h>'. This is also in accordance with older DLT documentation. Signed-off-by: Sebastian Lipponer <mail@sebastianlipponer.de>
* Provide DLT_GET_APPID macro (#187) (#188)Vo Trung Chi2019-11-141-0/+19
| | | Signed-off-by: Christoph Lipka <clipka@jp.adit-jv.com>
* libdlt: reattachment and improvement in dlt thread (#171)Vo Trung Chi2019-10-011-1/+1
| | | | | | | | | | | | | | | | | Improvement: housekeeper thread with poll - Change name receiver thread to housekeeper thread - Use poll() in housekeeper thread to get new received message from DLT Daemon. - Remove resend buffer inside of dlt_user_log_reattach_to_daemon() - Only try to resend buffer if fd is valid. This commit removes the event driven dlt_user_log_reattach_to_daemon() that is called e.g. by DLT_LOG. Now, only the DLT housekeeper thread handles the retrial to attach to daemon. Signed-off-by: Vo Trung Chi <Chi.VoTrung@vn.bosch.com> Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com> Signed-off-by: Simon Herkenhoff <sherkenhoff@jp.adit-jv.com> Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* Update cmakelist, fix build due to copy-paste error (#170)Gianfranco Costamagna2019-09-231-1/+1
| | | | | | dlt-control should generate a dlt-control manpage, not a dlt-system one Signed-off-by: Gianfranco Costamagna <costamagnagianfranco@yahoo.it> Signed-off-by: Gianfranco Costamagna <locutusofborg@debian.org>
* doc: Modify markdown doc generationSaya Sugiura2019-09-131-21/+9
| | | | | | Use pandoc to generate html from markdown. Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Update dlt_for_developers.mdBui Nguyen Quoc Thanh2019-09-131-12/+24
| | | | | | | - Add instructions how to use wildcard with DLT_INITIAL_LOG_LEVEL - Correct the wrong display with underscore in markdown file. Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* console: Tool to merge multiple DLT filesBui Nguyen Quoc Thanh2019-09-132-8/+13
| | | | | | | | | | | | | | - Sort in dlt-sortbytimestamp: first sorted by time, second sorted by timestamp. - Support multiple compressed files in dlt-convert. These changes is based on use case: User can expects to join several dlt files which are compressed in tar.gz file (maybe per component). Moreover, currently the existing sort is only applicaple for single boot cycle. There should be a support for sorting multiple cyclic boots in one dlt file. Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
* Add user custom timestamp interfaceSebastian Unger2019-09-131-0/+31
| | | | | | | | | | | | | Two new macros are introduced so that users can use their customized timestamps for DLT messages: - DLT_LOG_TS(CONTEXT, LOGLEVEL, TS, ARGS ...) - DLT_LOG_ID_TS(CONTEXT, LOGLEVEL, MSGID, TS, ARGS ...) Detailed explanations can be found in dlt_for_developers.md. Also a new option is added to dlt-system to use events' timestamps from journald adapter. Signed-off-by: Sebastian Unger <sunger@de.adit-jv.com>
* UDP Multicast implementation (#155)Sunil-K-S2019-08-231-0/+12
| | | | | The feature can be enabled by setting WITH_UDP_CONNECTION to ON. Signed-off-by: sunil.s <sunil.s@lge.com>
* doc: Remove unused imagesSaya Sugiura2019-08-0715-2/+2
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* Add option to set owner group of daemon FIFO (#122)Jiri Popek2019-07-251-0/+44
| | | | | | | | | | New option to set owner group of daemon FIFO (Default: /tmp/dlt) is added in dlt.conf. If this option is used properly, more secure tracing can be realized. Only application that is in dlt_user_apps_group can write log message to daemon FIFO. Signed-off-by: Yusuke Sato <yusuke-sato@apn.alpine.co.jp>
* doxygen: Align variable for apid and ctidSaya Sugiura2019-07-191-6/+6
| | | | | | | The variables used for application id and context id are aligned with "apid" and "ctid". Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doxygen: Remove licenceSaya Sugiura2019-07-194-8/+0
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doxygen: Get rid of warningsSaya Sugiura2019-07-191-1/+1
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Use pandoc to generate HTML from markdownSaya Sugiura2019-07-191-0/+26
| | | | Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Create missing markdown documentsSaya Sugiura2019-07-194-5/+312
| | | | | | | | | Following documents are created: - dlt-control.1.md - dlt-adaptor-stdin.1.md - dlt-adaptor-udp.1.md Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Documentation updateSaya Sugiura2019-07-197-1141/+80
| | | | | | | | | | | | | | | | As written in README, following documents are removed and necessary information is moved to dlt_for_developers.md: - doc/dlt_user_manual.txt - doc/dlt_cheatsheet.txt - doc/dlt_book.txt Also following documents are removed: - doc/dlt_howto_debug.txt - doc/dlt_loglevel_explained.txt TODO: Update doc/dlt_design_specification.txt Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* cmake: Allow build as a subproject (#145)Vo Trung Chi2019-07-093-19/+19
| | | | | | Use PROJECT_* instead of CMAKE_* to allow build as a subproject of another cmake project. Signed-off-by: Vo Trung Chi <Chi.VoTrung@vn.bosch.com>
* doc: Improve markdown documentsSaya Sugiura2019-06-276-133/+242
| | | | | | | This includes improvement of markdown formatting as well as changes in description itself. Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Improve dlt_for_developers.mdSaya Sugiura2019-06-251-122/+255
| | | | | | | This includes improvement of markdown formatting as well as changes in description itself. Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Update doc/CMakeList.txt after cleanup documentation (#111) (#117)thanhbnq2019-04-168-199/+182
| | | | | | | | | | * doc: Update after cleanup documentation - Add ascii_doc check - Spaces instead of tabs in doc/CMakeList.txt - Change style in markdown files to avoid error while converting from md to html - Since manpages are generated by pandoc, "doc-man" part is removed from doc/CMakeList.txt Signed-off-by: thanhbnq <thanh.buinguyenquoc@vn.bosch.vn>
* doc: Do not allow DLT usage in forked child (#95)Saya Sugiura2019-03-262-4/+4
| | | | | | | | Update the documents to adapt to behavior change of forked child. Relates to following commit: 18321f3 libdlt: Do not allow DLT usage in forked child (#95) Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Raise an awareness of log level syncBui Nguyen Quoc Thanh2019-03-261-0/+2
| | | | | | | Raise an awareness of log level synchronization between DLT Daemon and application after registrations. Signed-off-by: Bui Nguyen Quoc Thanh <thanh.buinguyenquoc@vn.bosch.com>
* doc: Fix PANDOC_TOOL conditionSaya Sugiura2019-03-141-2/+2
| | | | | | | doc/CMakeLists.txt had a wrong condition to check whether PANDOC_TOOL was found. Signed-off-by: Saya Sugiura <ssugiura@jp.adit-jv.com>
* doc: Move all man pages to markdown files (#102)v2.18.1Christoph Lipka2019-02-1238-4029/+1701
| | | | All manpages have been removed, because they will be autogenerated from markdown files using pandoc.
* fix broken/missing links in documentationChristoph Lipka2018-12-211-0/+2
| | | | Signed-off-by: Christoph Lipka <clipka@de.adit-jv.com>
* Documentation updateChristoph Lipka2018-12-219-41/+798
| | | | | Signed-off-by: Manikandan C <mchockalingam@de.adit-jv.com> Signed-off-by: Christoph Lipka <clipka@de.adit-jv.com>