Difference between revisions of "Logging"

From MythTV Official Wiki
Jump to: navigation, search
m (Log file cleanup: update link to logcleanup.py)
(syslog Logging: mention syslog logging's allowing user-specified file names)
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
MythTV (starting with version 0.25) supports logging to various loggers. Logging to them is enabled with command-line arguments. Additional information about application command-line arguments is available using the <code>--help</code> argument, for example:
+
Current MythTV supports logging to various loggers. Logging options are specified with command-line arguments. Additional information about application command-line arguments is available using the <code>--help</code> argument, for example:
  
 
  mythbackend --help
 
  mythbackend --help
Line 11: Line 11:
 
  mythbackend --help setloglevel
 
  mythbackend --help setloglevel
 
  mythbackend --help logpath
 
  mythbackend --help logpath
 +
 +
{{Note box|The legacy <code>--logfile</code> and <code>-l</code> arguments are no longer supported after 0.24.  Any script using --logfile or -l to start MythTV applications must be updated.}}
 +
 +
{{Note box|Starting with version 0.26, all log requests are handled by the [[Mythlogserver|mythlogserver]] application, which is automatically started as needed.  Logging arguments are still specified for mythbackend and mythfrontend applications and are passed to mythlogserver.}}
 +
  
 
== General ==
 
== General ==
Line 16: Line 21:
 
All logging (regardless of specified logger) is affected by the arguments:
 
All logging (regardless of specified logger) is affected by the arguments:
  
  --setloglevel                  Change logging level of the existing master
+
  --loglevel                      Set the logging level.  All log messages at
                                 backend.
+
                                 lower levels will be discarded.
  --verbose OR -v                 Specify log filtering. Use '-v help' for level
+
                                In descending order: emerg, alert, crit, err,
 +
                                warning, notice, info, debug
 +
                                defaults to info
 +
  -v OR --verbose                 Specify log filtering. Use '-v help' for level
 
                                 info.
 
                                 info.
  
Typically, the default value for <code>--setloglevel</code> and <code>--verbose</code> are appropriate for normal application execution. However, you may be asked to provide logs at a specific log level when helping debug issues.
+
Typically, the default value for <code>--loglevel</code> and <code>--verbose</code> are appropriate for normal application execution. However, you may be asked to provide logs at a specific log level when helping debug issues.
  
 
== Loggers ==
 
== Loggers ==
Line 43: Line 51:
 
File logging is disabled by default and may be enabled with the argument:
 
File logging is disabled by default and may be enabled with the argument:
  
  --logfile OR --logpath OR -l    Writes logging messages to a file at logpath.
+
  --logpath                       Writes logging messages to a file in the directory logpath with
                                If a directory is given, a logfile will be
+
                                  filenames in the format: applicationName.date.pid.log.
                                created in that directory with a filename of
+
                                  This is typically used in combination with --daemon, and if used
                                applicationName.date.pid.log.
+
                                  in combination with --pidfile, this can be used with log
                                If a full filename is given, that file will be
+
                                  rotators, using the HUP call to inform MythTV to reload the file
                                used.
+
                                This is typically used in combination with
+
                                --daemon, and if used in combination with
+
                                --pidfile, this can be used with log rotators,
+
                                using the HUP call to inform MythTV to reload
+
                                the file (currently disabled).
+
  
When specifying a file path, file logging is only enabled for the application you are starting. All logging will be disabled for child processes started by that application (for example, preview generation, commercial detection, transcoding, and other jobs started by mythbackend). Therefore, you should always specify a directory as the argument for <code>--logpath</code> or <code>-l</code>.
+
{{Note box|File logging requires that the process writing the logs (mythlogserver) have permission on the specified logpath directory, as well as on the log files. This can be a challenge to configure properly in environments where different MythTV applications are run as different users.  Since mythlogserver is spawned (and re-spawned) by whichever application needs it, mythlogserver may be run as different users at different times--even during a single MythTV session.  Therefore, you may need to open up permissions or use <code>newgrp</code> to log in to a new group (a secondary group membership, such as mythtv) before starting the MythTV applications.  Alternatively, you can use [[#syslog_Logging|syslog logging]].}}
  
 
File logging output may be challenging to read in a terminal due to the amount of information included.  You may simplify the log file output with a log processor. For example, the command:
 
File logging output may be challenging to read in a terminal due to the amount of information included.  You may simplify the log file output with a log processor. For example, the command:
  
  perl -pwe 's#^(\d{4}(?:-\d{2}){2} \d{2}(?:\:\d{2}){2}\.\d{6} \w) \[\d+/\d+\] \S+ \S+ \(\S+\) - (.*$)#$1  $2#' /path/to/logfile
+
  perl -pwe '$| = 1; s#^(\d{4}(?:-\d{2}){2} \d{2}(?:\:\d{2}){2}\.\d{6} \w) \[\d+/\d+\] \S+ \S+ \(\S+\) - (.*$)#$1  $2#' /path/to/logfile
  
 
will scan the log file at <code>/path/to/logfile</code> and output (to <code>stdout</code>) a simplified log format equivalent to that used by console logging.  Change the <code>/path/to/logfile</code>, as appropriate for your system.
 
will scan the log file at <code>/path/to/logfile</code> and output (to <code>stdout</code>) a simplified log format equivalent to that used by console logging.  Change the <code>/path/to/logfile</code>, as appropriate for your system.
  
{{note box|Currently, <code>mythfilldatabase</code>
+
If you'd like to log full details while following the log file in a console with the above simplification, use the tail command:
has separate logging for the command itself and for the <code>wget</code> command it calls.
+
 
 +
tail -f /path/to/logfile | perl -pwe '$| = 1; s#^(\d{4}(?:-\d{2}){2} \d{2}(?:\:\d{2}){2}\.\d{6} \w) \[\d+/\d+\] \S+ \S+ \(\S+\) - (.*$)#$1  $2#'
  
The following sample changes are made using <code>mythtv-setup</code>; select General, Program Schedule Download Options:
 
Guide data arguments: --logpath /var/log/mythtv (added to existing arguments)
 
Guide data program log path: /var/log/mythtv/mythfilldatabase_wget.log
 
This note should be removed or updated after <code>wget</code> is replaced.
 
}}
 
 
=== syslog Logging ===
 
=== syslog Logging ===
  
Line 78: Line 76:
 
                                 Set to "none" to disable, defaults to none
 
                                 Set to "none" to disable, defaults to none
  
By default, logging to syslog is disabled. You should only enable syslog logging if you have also [[:Category:Syslog Configuration Files|configured syslog]] on your host to handle the MythTV log messages appropriately.
+
By default, logging to syslog is disabled. You should only enable syslog logging if you have also [[:Category:Syslog Configuration Files|configured syslog]] on your host to handle the MythTV log messages appropriately.  Logging to syslog allows (via syslog configuration) user-specified log file names.
  
 
=== Database Logging ===
 
=== Database Logging ===
Line 87: Line 85:
  
 
MythTV automatically cleans up the database logging information, to ensure your database does not grow out of control. All database logging information is removed within 2 weeks, so database logging is primarily useful for short-term log access, and should not be considered a valid long-term logging mechanism.
 
MythTV automatically cleans up the database logging information, to ensure your database does not grow out of control. All database logging information is removed within 2 weeks, so database logging is primarily useful for short-term log access, and should not be considered a valid long-term logging mechanism.
 +
 
== Log file cleanup ==
 
== Log file cleanup ==
  
When using the old <code>--logfile /path/to/log_directory/''appname''.log</code> option, only those logs from that specific application will be written to the fileIt is highly suggested to use the new <code>--logpath /path/to/log_directory</code> option, where each program and each child chooses its own log name inside that path, using the syntax:
+
You may configure external applications, such as [https://fedorahosted.org/logrotate/ logrotate] or [http://www.gnu.org/software/rottlog/ GNU Rottlog], to rotate your log filesThese programs allow you to specify exactly how to handle the multiple log files--including how often to rotate, how many old log files to keep and how long to keep them, where to place the log files, whether to compress them, and much more.  Example configurations are available in the [[:Category:Log Rotation Configuration Files|Log Rotation Configuration Files category]].
''appname''.''date''.''pid''.log
+
  
Mythbackend and mythfrontend will be long running tasks, resulting in large log files for each. As such, it is recommended to run '''logrotate''', or some similar application to automatically cycle and compress those logs.  Examples for the [[Logrotate - mythbackend|backend]] and [[Logrotate - mythfrontend|frontend]] can be found on this wiki.
+
Alternatively, a python script, [https://github.com/MythTV/packaging/blob/master/Gentoo/media-tv/mythtv/files/logcleanup.py logcleanup.py], is available to manage the multiple copies of these logs generated each time the applications restartWith its default settings, it will keep a minimum of five sets of logs for each application, and each set will be kept a minimum of seven days.  One log set is one file, along with any rotated, compressed copies generated by logrotate.  This script can be set to run daily or weekly through cron.
  
Logrotate and similar applications will only handle each file individually, and will not understand the above naming scheme.  A python script, [https://github.com/MythTV/packaging/blob/master/Gentoo/media-tv/mythtv/files/logcleanup.py logcleanup.py], can be found in contrib to manage the multiple copies of these logs generated each time the applications restart.  With its default settings, it will keep a minimum of five sets of logs for each application, and each set will be kept a minimum of seven days.  One log set is one file, along with any rotated, compressed copies generated by logrotate.  This script can be set to run daily or weekly through cron.
+
[[Category:HOWTO]]

Revision as of 18:29, 23 January 2013

Current MythTV supports logging to various loggers. Logging options are specified with command-line arguments. Additional information about application command-line arguments is available using the --help argument, for example:

mythbackend --help

or

mythfrontend --help

Detailed help information is available for each argument by including the argument name after --help, for example:

mythbackend --help setloglevel
mythbackend --help logpath


Important.png Note: The legacy --logfile and -l arguments are no longer supported after 0.24. Any script using --logfile or -l to start MythTV applications must be updated.


Important.png Note: Starting with version 0.26, all log requests are handled by the mythlogserver application, which is automatically started as needed. Logging arguments are still specified for mythbackend and mythfrontend applications and are passed to mythlogserver.


General

All logging (regardless of specified logger) is affected by the arguments:

--loglevel                      Set the logging level.  All log messages at
                                lower levels will be discarded.
                                In descending order: emerg, alert, crit, err,
                                warning, notice, info, debug
                                defaults to info
-v OR --verbose                 Specify log filtering. Use '-v help' for level
                                info.

Typically, the default value for --loglevel and --verbose are appropriate for normal application execution. However, you may be asked to provide logs at a specific log level when helping debug issues.

Loggers

Console Logging

If running a MythTV application in a non-daemon mode, console logging will be enabled. Console logging is output to stdout.

Console logging is automatically disabled with the argument:

--daemon OR -d                  Fork application into background after startup.

(for MythTV daemon applications).

The console logging output contains a shortened format which better fits a standard terminal. Therefore, please provide full file logging output when attaching log files to bug tickets.

File Logging

The primary logger for MythTV applications is the file logger. File logging outputs detailed "debug" logging information about process execution, which can be very useful in debugging issues with MythTV. All log files uploaded to bug tickets should be those created from the file logger.

File logging is disabled by default and may be enabled with the argument:

--logpath                        Writes logging messages to a file in the directory logpath with
                                 filenames in the format: applicationName.date.pid.log.
                                 This is typically used in combination with --daemon, and if used
                                 in combination with --pidfile, this can be used with log
                                 rotators, using the HUP call to inform MythTV to reload the file


Important.png Note: File logging requires that the process writing the logs (mythlogserver) have permission on the specified logpath directory, as well as on the log files. This can be a challenge to configure properly in environments where different MythTV applications are run as different users. Since mythlogserver is spawned (and re-spawned) by whichever application needs it, mythlogserver may be run as different users at different times--even during a single MythTV session. Therefore, you may need to open up permissions or use newgrp to log in to a new group (a secondary group membership, such as mythtv) before starting the MythTV applications. Alternatively, you can use syslog logging.

File logging output may be challenging to read in a terminal due to the amount of information included. You may simplify the log file output with a log processor. For example, the command:

perl -pwe '$| = 1; s#^(\d{4}(?:-\d{2}){2} \d{2}(?:\:\d{2}){2}\.\d{6} \w) \[\d+/\d+\] \S+ \S+ \(\S+\) - (.*$)#$1  $2#' /path/to/logfile

will scan the log file at /path/to/logfile and output (to stdout) a simplified log format equivalent to that used by console logging. Change the /path/to/logfile, as appropriate for your system.

If you'd like to log full details while following the log file in a console with the above simplification, use the tail command:

tail -f /path/to/logfile | perl -pwe '$| = 1; s#^(\d{4}(?:-\d{2}){2} \d{2}(?:\:\d{2}){2}\.\d{6} \w) \[\d+/\d+\] \S+ \S+ \(\S+\) - (.*$)#$1  $2#'

syslog Logging

Logging to syslog may be enabled with the argument:

--syslog                        Set the syslog logging facility.
                                Set to "none" to disable, defaults to none

By default, logging to syslog is disabled. You should only enable syslog logging if you have also configured syslog on your host to handle the MythTV log messages appropriately. Logging to syslog allows (via syslog configuration) user-specified log file names.

Database Logging

Database logging is enabled by default. It may be disabled with the argument:

--nodblog                       Disable database logging.

MythTV automatically cleans up the database logging information, to ensure your database does not grow out of control. All database logging information is removed within 2 weeks, so database logging is primarily useful for short-term log access, and should not be considered a valid long-term logging mechanism.

Log file cleanup

You may configure external applications, such as logrotate or GNU Rottlog, to rotate your log files. These programs allow you to specify exactly how to handle the multiple log files--including how often to rotate, how many old log files to keep and how long to keep them, where to place the log files, whether to compress them, and much more. Example configurations are available in the Log Rotation Configuration Files category.

Alternatively, a python script, logcleanup.py, is available to manage the multiple copies of these logs generated each time the applications restart. With its default settings, it will keep a minimum of five sets of logs for each application, and each set will be kept a minimum of seven days. One log set is one file, along with any rotated, compressed copies generated by logrotate. This script can be set to run daily or weekly through cron.