Logging system - Revision history

Patsyblefebre: Gramps

2013-01-27T01:30:40Z

Gramps

Daleathan at 01:57, 28 September 2011

2011-09-28T01:57:48Z

Daleathan at 01:57, 28 September 2011

2011-09-28T01:57:35Z

Daleathan at 01:56, 28 September 2011

2011-09-28T01:56:59Z

Bmcage: /* Enable Debugging */

2010-03-24T13:17:29Z

‎Enable Debugging

Romjerome: typo

2010-02-17T12:30:57Z

typo

Bmcage: /* If debugging is enabled */

2009-06-28T14:45:56Z

‎If debugging is enabled

Dm1407: formating

2009-06-28T00:19:47Z

formating

Dm1407: /* Handler instances */ table

2009-06-13T01:15:27Z

‎Handler instances: table

Romjerome at 16:57, 21 July 2007

2007-07-21T16:57:51Z

@@ Line 1: / Line 1: @@
-The GRAMPS Logging System is based on [http://docs.python.org/lib/module-logging.html Python]s logging facility.
+The Gramps Logging System is based on [http://docs.python.org/lib/module-logging.html Python]s logging facility.
 ==Handler subclasses==
@@ Line 17: / Line 17: @@
 ==Handler instances==
-Currently there is one instance of each of the above Handler classes in GRAMPS. Additionally there's also a StreamHandler() defined with <tt>sys.stderr</tt> as output stream for debugging purposes. All of these Handlers are attached to the root logger, thus active for any later defined logger.
+Currently there is one instance of each of the above Handler classes in Gramps. Additionally there's also a StreamHandler() defined with <tt>sys.stderr</tt> as output stream for debugging purposes. All of these Handlers are attached to the root logger, thus active for any later defined logger.
 The RotateHandler, GtkHandler and StreamHandler are all instantiated in <tt>gramps.py</tt> (setup_logging), while Warnhandler is instantiated in <tt>DisplayState.py</tt> (DisplayState.__init__). Rotatehandler is attached also to GtkHandler for the purpose described in GtkHandler description. Each Handler instance has a custom formatter assigned.
@@ Line 52: / Line 52: @@
 <blockquote>'''Note!''' The argument of the switch is <u>not</u> optional.</blockquote>
-==So how logging works in GRAMPS after all?==
+==So how logging works in Gramps after all?==
 ===If debugging is not enabled===
 * all WARNING and above level logs will be buffered by WarnHandler and can be seen by pressing the warn_button within 3 minutes after the latest log is received.
@@ Line 71: / Line 71: @@
   _LOG.debug('a debug message')
-:To see this message in a terminal, one starts GRAMPS with the debug option followed by the debug logger one wants to see:
+:To see this message in a terminal, one starts Gramps with the debug option followed by the debug logger one wants to see:
   python src/gramps.py -d '.pageview'

← Older revision		Revision as of 01:57, 28 September 2011
Line 1:		Line 1:
−	The GRAMPS Logging System is based on ~~the~~ [http://docs.python.org/lib/module-logging.html Python]s logging facility.	+	The GRAMPS Logging System is based on [http://docs.python.org/lib/module-logging.html Python]s logging facility.

	==Handler subclasses==		==Handler subclasses==

← Older revision		Revision as of 01:57, 28 September 2011
Line 1:		Line 1:
−	The GRAMPS Logging System is based on the ~~logging facility of~~ [http://docs.python.org/lib/module-logging.html Python].	+	The GRAMPS Logging System is based on the [http://docs.python.org/lib/module-logging.html Python]s logging facility.

	==Handler subclasses==		==Handler subclasses==

@@ Line 1: / Line 1: @@
-==GRAMPS Logging System==
+The GRAMPS Logging System is based on the logging facility of [http://docs.python.org/lib/module-logging.html Python].
-The logging system in GRAMPS is based on the logging facility of [http://docs.python.org/lib/module-logging.html Python].
 ==Handler subclasses==

@@ Line 44: / Line 44: @@
 The usage of the switch is quite simple:
-  python gramps.py -d="name_of_the_logger"
+  python gramps.py -d "name_of_the_logger"
 or:

@@ Line 48: / Line 48: @@
 or:
-  pyhon gramps.py --debug="name_of_the_logger"
+  python gramps.py --debug="name_of_the_logger"
 The name of the root logger is an empty string, thus e.g. <tt>--debug=""</tt> will enable all debug logs.

@@ Line 62: / Line 62: @@
 *all DEBUG and INFO level logs are additionally sent to stderr stream from the enabled logger.
 <blockquote>'''Note!''' All unhandled exception will send an ERROR level log with the traceback included.</blockquote>
 [[Category:Developers/Reference]]
 [[Category:Developers/Tutorials]]
 [[Category:Developers/General]]

@@ Line 1: / Line 1: @@
 ==GRAMPS Logging System==
-The logging system in Gramps is based on the logging facility of [http://docs.python.org/lib/module-logging.html Python].
+The logging system in GRAMPS is based on the logging facility of [http://docs.python.org/lib/module-logging.html Python].
 ==Handler subclasses==
@@ Line 9: / Line 7: @@
 * GtkHandler
 * WarnHandler
 ===RotateHandler(logging.Handle) (GrampsLogging._RotateHandler.py)===
 The RotateHandler just keeps a rotating buffer of the last N (defined at instantiation) log messages sent to it. It can be used e.g. with the GtkHandler to pass a history of log messages to the ErrorReportAssistant().
 ===GtkHandler(logging.Handle) (GrampsLogging._GtkHandler.py)===
 The GtkHandler will pop up a gtk dialog when a log message is sent to it. The dialog offers the user the chance to start ErrorReportAssistant() to send a bug report.
 === WarnHandler(RotateHandler) (DisplayState.py)===
 The WarnHandler is a subclass of RotateHandler thus buffers the last N logs (log level WARNING or above) it received. Additionally it has a button assigned, which will be shown for 180 sec. after a log is received. Activating this button the WarnHandler will pop up a dialog with the list of the buffered logs.
 ==Handler instances==
-Currently there is one instance of each of the above Handler classes in Gramps. Additionally there's also a StreamHandler() defined with <tt>sys.stderr</tt> as output stream for debugging purposes. All of these Handlers are attached to the root logger, thus active for any later defined logger.
+Currently there is one instance of each of the above Handler classes in GRAMPS. Additionally there's also a StreamHandler() defined with <tt>sys.stderr</tt> as output stream for debugging purposes. All of these Handlers are attached to the root logger, thus active for any later defined logger.
 The RotateHandler, GtkHandler and StreamHandler are all instantiated in <tt>gramps.py</tt> (setup_logging), while Warnhandler is instantiated in <tt>DisplayState.py</tt> (DisplayState.__init__). Rotatehandler is attached also to GtkHandler for the purpose described in GtkHandler description. Each Handler instance has a custom formatter assigned.
 {| {{prettytable}}
 |+Handler instance parameters
@@ Line 34: / Line 38: @@
 ==Loggers==
 The log level of the root logger is set to WARNING by default. In case debugging is activated it may be set to DEBUG (see Enable Debugging). In each module it is recommended to define an own Logger object to be able to understand, which module a certain log (error) is generated from. Setting own log level to a logger is not recommended.
 ==Enable Debugging==
 Since the log level of the root logger is set to WARNING by default the StreamHandler will also receive only log at level WARNING and above. To enable debug logs the <tt>-d</tt> or <tt>--debug</tt> command line switch is defined. The debug log can be enabled globally by setting the log level of the root logger, or only for a specific module by setting the log level of the logger defined in that particular module.
 The usage of the switch is quite simple:
   python gramps.py -d="name_of_the_logger"
 or:
   pyhon gramps.py --debug="name_of_the_logger"
 The name of the root logger is an empty string, thus e.g. <tt>--debug=""</tt> will enable all debug logs.
 <blockquote>'''Note!''' The argument of the switch is <u>not</u> optional.</blockquote>
-==So how logging works in Gramps after all?==
 ===If debugging is not enabled===
 * all WARNING and above level logs will be buffered by WarnHandler and can be seen by pressing the warn_button within 3 minutes after the latest log is received.
 * all ERROR and above level logs will raise a dialog showing the log. If user votes on reporting the error the ErrorReportAssistant() window will be called with the latest 20 logs included.
 * all WARNING and above level logs are sent to the stderr stream.
 ===If debugging is enabled===
 *all DEBUG and INFO level logs are additionally sent to stderr stream from the enabled logger.
 <blockquote>'''Note!''' All unhandled exception will send an ERROR level log with the traceback included.</blockquote>