language
update
keyboard_arrow_up
language

Description

A plugin that allows for custom logging in your scenarios. You can create as many log files as you want, and different log levels are available for each log file. This allows you to organize your scenario logs according to your preferences—for example, by grouping all actions on a single device into the same log, regardless of the scenario.

Logs can be viewed through the standard Jeedom interface. Log purging is also managed through Jeedom’s general settings.

Supported Versions

Component Version
Debian Bullseye(11) & Bookworm(12)
Jeedom >= 4.2

Installation

To use the plugin, you must download, install, and activate it just like any other Jeedom plugin.

Device setup

The plugin is located in the Plugins → Programming menu.

After creating a new device, the usual options are available.

Each device corresponds to a log; the device name will be used as the log file name.

Tip

To avoid potential issues, the device name must consist only of letters from a to z, in lowercase or uppercase, and the underscore character “_”; the first character must be a letter.

In addition, you can select the log level to write: Debug, Info, Warning, Error.

Commands

Each device (log) has a message-type command for each log level:

  • debug
  • info
  • warning
  • error

Simply call the desired command with the message, and the log entry will be written according to the log level configured on the device.

Depending on the configuration, an event will be generated by the plugin (only if the message is actually written to the log). This event can be used as a scenario trigger; this is useful if you want to perform custom actions when a certain level of log is written:

  • #lm-debug#
  • #lm-info#
  • #lm-warning#
  • #lm-error#

There are also the following commands, which behave the same way as the corresponding manual actions in Jeedom:

  • Clear: Clear the log file
  • Delete: Delete the log file

The widget

There are two options:

  • In this case, the log content will be displayed on the tile, without the device commands.
  • either a standard widget will be displayed with the selected commands (to be configured on the device’s “Commands” page).

The selection is made in the device settings.

Change log

View the changelog

Support

If you’re having a problem, start by reading the latest threads related to the plugin on community.

If you still can’t find an answer to your question, feel free to create a new thread—and don’t forget to include the plugin tag (plugin-logmanager).

At a minimum, you must provide:

  • a screenshot of the Jeedom Health page
  • a screenshot of the plugin’s settings page
  • All available plugin logs at the INFO level, pasted into Preformatted Text (use the </> button on the community), no files!
  • Depending on the situation, a screenshot of the error encountered, a screenshot of the problematic configuration…