Troubleshooting Miradore client for Linux

Logging

The basic method for troubleshooting Miradore client for Linux is to see the client log file. The client writes logs into file which can be found from: /var/log/miradore.log.

Log file is rotated daily, with old log moved to store file, and new file emptied. Log files up to 7 days old are stored in the file system. Naming for the old log files are either miradore.log.1-7 or miradore.log-<DATE>, depending on the system log rotation rules. In addition to active log, previous log file is uncompressed. Log files older than that are compressed with gzip compression. The filenames of compressed log files are appended with .gz extension.

Maximum verbosity in logging can be defined while Configuring Miradore client. Level 'Info' has been selected as default value for maximum log level in Miradore client configuration script. This will show only informational events in certain operating phases. To enable more verbose log levels, select either 'Debug' or the most verbose log level 'Verbose'. Limiting log output can be established with setting the maximum log level to either 'Warning' or 'Error'. Available log levels are, from the most verbose to the most severe: "Verbose (VER)", "Debug (DEB)", "Info (INF) ", "Warning (WAR) ", "Error (ERR)", "Critical (CRI)", "Crash (CRA)". Currently all error output up to log level 'Error' is printed into log file, even if user has selected the even stricter maximum levels. String in parentheses denotes the value logged for this severity into log file lines.

See the following line for an example:

Oct  3 07:50:15 COMPUTERNAME miradored[9224]: INF   main.cpp: 81       main Starting miradore client 1.1.0

The log entry consists of date and time, computer name, process name ('miradored' for 'miradoredaemon', 'miradorec' for 'miradoreclient' and 'miradores' for 'miradorescheduler') and number, severity of logged event ('INF' for 'Info'), program source code file, line and function as well as Informational string of the logged event.

Log file can be viewed from the Terminal command line application with command:

less /var/log/miradore.log

This command shows scrollable view of the log file. You can exit the 'less' command with pressing key 'q'.

To follow current log activity from the command line, run command:

tail -f /var/log/miradore.log

This will make the 'tail' utility to continuously show the last lines of the miradore.log as long as it's running. To exit from 'tail -f' program, press 'CTRL-c'.

Linux desktop environments GNOME and KDE have graphical log viewer utilities. In GNOME environment, graphical tool System Log Viewer ( gnome-system-log ) can be used to show system log files in GUI window. Selecting miradore.log from the System log viewer allows the user to follow Miradore Client log output. in KDE environment, KSystemLog ( ksystemlog ) can be used to see system log files. KSystemLog shows by default only standard log files, without Miradore client. Miradore logging can be enabled into one of the standard log file entries by selecting Settings - Configure KSystemLog and adding /var/log/miradore.log into one of the configurations, for example the Daemons' logs. After that, selecting Daemons' Logs into KSystemLog output, user can also see Miradore client logging.

Running processes

To see which Miradore processes are running in the system, run command:  

ps aux | grep miradore

When the client is running, processes "miradoredaemon" (as root), "miradorescheduler" (as root), and "miradoreclient" should be running at all times. The process list may also contain job processes which have been started by the "miradorescheduler" process.

Restarting Miradore client

If number of running processes indicates, that the "miradoreclient" is for some reason not running and it hasn't been restarted by "miradoredaemon", re-launch the Miradore client processes as Adminstrator (user 'root') with command

service miradoreclient restart

This will also poll new events from the server, after configured startup delay. Miradore client will be automatically started in system startup, so restarting the operating system also re-launches the client.

Common configuration issues

If Miradore client can't establish a connection to Miradore server instance, there might be problems in the configuration of Miradore client or network. Miradore client troubleshooting tool can be used to quickly check for some common errors in the configuration like invalid server host names or unavailable server connection port.

To run Miradore client troubleshooing tool, run command:

/var/lib/miradore/troubleshooter.sh

The troubleshooting tool reads the configuration of Miradore client and tests the server connection. If the troubleshooting tool is able to establish the connection successfully,  the tool reports “Connection to server seems to be OK”. In error cases the reason the possible reason for the connection failure is reported.

See also

Configuring Miradore client for Linux

Uninstalling Miradore client for Linux

Related to

Miradore client for Linux