Search by Tags

Persistent Journald Logging

 

Article updated at 17 Feb 2021
Compare with Revision


Subscribe for this article updates

Select the version of your OS from the tabs below. If you don't know the version you are using, run the command cat /etc/os-release or cat /etc/issue on the board.

BSP 5.0.0

Introduction

Journald is a system service for collecting and storing log data, introduced with systemd. It tries to make it easier for system administrators to find interesting and relevant information among an ever-increasing amount of log messages.

To avoid excessive wear of the limited flash memory on Toradex modules, the journald data is stored in RAM by default. To debug certain aspects such as unexpected reboots, it is handy to activate persistent journald logging, so the log messages of previous boot cycles can be reviewed.

Attention: Please, use this function with caution, as it can decrease the lifespan of your eMMC/NAND due to flash usage for logging.

For more details about each possible parameter to be set for Journald, please consult the Journald Documentation.

Steps to Activate Persistent Logging

  1. Edit the file /etc/systemd/journald.conf
    Modify the line
#Storage=auto

to

Storage=persistent
  1. Edit the file /etc/tmpfiles.d/00-create-volatile.conf
    delete the following line
d               /var/volatile/log               1777    -       -
  1. Delete the symbolic link to the log folder
# rm /var/log

That's it!

Testing the persistent logging

  1. Reboot the module twice
# reboot
  1. List all boot cycles, and display the detailed messages of the previous (not the current) boot cycle
# journalctl --list-boots
# journalctl -b -1

Final Considerations

Enabling persistent logs on production is a "good thing", but you shall balance it to avoid memory stress and wear-out. When enabling logging keep the following in mind:

  • Research how to only enable logs and log levels to the minimum. Setting the debug-level as "DEBUG" for development, and then changing it to "ERROR" and above in production may be a good idea.
  • Think about how much of the storage space you will allocate for logging, as well as the logging rotation.
  • Consider using external media for logging, like an SD Card. That will spare the internal flash memory, which is critical since it's where the operating system is.

Search the internet for more information. One example is the article Ultimate Guide to Logging.

BSP 4.0.0

Introduction

Journald is a system service for collecting and storing log data, introduced with systemd. It tries to make it easier for system administrators to find interesting and relevant information among an ever-increasing amount of log messages.

To avoid excessive wear of the limited flash memory on Toradex modules, the journald data is stored in RAM by default. To debug certain aspects such as unexpected reboots, it is handy to activate persistent journald logging, so the log messages of previous boot cycles can be reviewed.

Attention: Please, use this function with caution, as it can decrease the lifespan of your eMMC/NAND due to flash usage for logging.

For more details about each possible parameter to be set for Journald, please consult the Journald Documentation.

Steps to Activate Persistent Logging

  1. Edit the file /etc/systemd/journald.conf
    Modify the line
#Storage=auto

to

Storage=persistent
  1. Edit the file /etc/tmpfiles.d/00-create-volatile.conf
    delete the following line
d               /var/volatile/log               1777    -       -
  1. Delete the symbolic link to the log folder
# rm /var/log

That's it!

Testing the persistent logging

  1. Reboot the module twice
# reboot
  1. List all boot cycles, and display the detailed messages of the previous (not the current) boot cycle
# journalctl --list-boots
# journalctl -b -1