Differential D278

Use UTC instead of local time in logging
ClosedPublic
Actions

Authored by mkrizek on Feb 17 2015, 6:28 AM.

Details

Reviewers
kparal
tflink
jskladan
Maniphest Tasks
T400: Change libtaskotron logging configuration to use UTC instead of local time
Commits
rLTRNc510152f0cf2: Use UTC instead of local time in logging
Test Plan

Run any task and check time that logging messages print. Worked on my machine.

Diff Detail

Repository
rLTRN libtaskotron
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
mkrizek retitled this revision from to Use UTC instead of local time in logging.Feb 17 2015, 6:28 AM
mkrizek updated this object.
mkrizek edited the test plan for this revision. (Show Details)
mkrizek added reviewers: tflink, kparal, jskladan.
kparal requested changes to this revision.Feb 17 2015, 8:09 AM

Can you please also add a timezone specifier into the log format, now that we don't default to local time? I.e. instead of this

[libtaskotron:runner.py:231] 2015-02-17 08:07:08 DEBUG   Using libtaskotron 0.3.11

it would be something like this

[libtaskotron:runner.py:231] 2015-02-17 08:07:08 UTC DEBUG   Using libtaskotron 0.3.11

Thanks.

This revision now requires changes to proceed.Feb 17 2015, 8:09 AM
mkrizek updated this revision to Diff 768.Feb 17 2015, 10:57 AM
  • Add timezone to datetime formatting
tflink added a comment.Feb 17 2015, 11:50 AM

So, I'm not all that enamoured with the GMT time and the timezone in the same log lines. With this patch, I get stuff like the following on my machine:

[libtaskotron:runner.py:255] 2015-02-17 11:46:16 +0000 INFO    Check execution finished.

I'm of the mind that we either use UTC or put the timezone in there. Using both is silly

kparal added a comment.Feb 17 2015, 1:30 PM

After discussion with Tim, we think it should be sufficient to print the full timestamp including the timezone at the execution start (and possibly the end), and then drop the timezone from the generic logging header displayed on every line. So something like this:

[libtaskotron:runner.py:231] 2015-02-17 08:07:00 INFO     Execution started at: 2015-02-17 08:07:00 +0000
[libtaskotron:runner.py:231] 2015-02-17 08:07:08 DEBUG   Using libtaskotron 0.3.11
[libtaskotron:runner.py:231] 2015-02-17 08:07:10 DEBUG   Look, I'm doing some stuff!
[libtaskotron:runner.py:231] 2015-02-17 08:07:20 INFO     Execution finished at: 2015-02-17 08:07:20 +0000
mkrizek updated this revision to Diff 769.Feb 17 2015, 2:31 PM
  • Fix timezone concern
tflink accepted this revision.Feb 17 2015, 3:40 PM

Please fix the 2 lint errors but outside of that, looks good to me

kparal accepted this revision.Feb 17 2015, 3:55 PM
This revision is now accepted and ready to land.Feb 17 2015, 3:55 PM
Closed by commit rLTRNc510152f0cf2: Use UTC instead of local time in logging (authored by mkrizek). · Explain WhyFeb 18 2015, 6:45 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathPackages
Mlibtaskotron/logger.py (5 lines)
Mlibtaskotron/runner.py (5 lines)

Diff 770

View Options

libtaskotron/logger.py

1# -*- coding: utf-8 -*- 1​# -*- coding: utf-8 -*-
2# Copyright 2009-2014, Red Hat, Inc. 2​# Copyright 2009-2014, Red Hat, Inc.
3# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+> 3​# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4# See the LICENSE file for more details on Licensing 4​# See the LICENSE file for more details on Licensing
5 5​
6from __future__ import absolute_import 6​from __future__ import absolute_import
7import sys 7​import sys
8import os 8​import os
9import tempfile 9​import tempfile
10import logging 10​import logging
11import logging.handlers 11​import logging.handlers
12import traceback 12​import traceback
13​import time
14​
13# you must not import libtaskotron.config here because of cyclic dependencies 15​# you must not import libtaskotron.config here because of cyclic dependencies
14 16​
15# http://docs.python.org/2/howto/logging.html#configuring-logging-for-a-library 17​# http://docs.python.org/2/howto/logging.html#configuring-logging-for-a-library
16#: the main logger for libtaskotron library, easily accessible from all our 18​#: the main logger for libtaskotron library, easily accessible from all our
17#: modules 19​#: modules
18log = logging.getLogger('libtaskotron') 20​log = logging.getLogger('libtaskotron')
19log.setLevel(logging.DEBUG) # need to set level, otherwise root level is inherited 21​log.setLevel(logging.DEBUG) # need to set level, otherwise root level is inherited
20log.addHandler(logging.NullHandler()) # this is needed when running in library mode 22​log.addHandler(logging.NullHandler()) # this is needed when running in library mode
21 23​
24​# set logging time to UTC/GMT
25​logging.Formatter.converter = time.gmtime
26​
22_fmt = '[%(name)s:%(filename)s:%(lineno)d] '\ 27​_fmt = '[%(name)s:%(filename)s:%(lineno)d] '\
23 '%(asctime)s %(levelname)-7s %(message)s' 28​ '%(asctime)s %(levelname)-7s %(message)s'
24_datefmt = '%Y-%m-%d %H:%M:%S' 29​_datefmt = '%Y-%m-%d %H:%M:%S'
25_formatter = logging.Formatter(fmt=_fmt, datefmt=_datefmt) 30​_formatter = logging.Formatter(fmt=_fmt, datefmt=_datefmt)
26 31​
27#: our current stream handler sending logged messages to stderr 32​#: our current stream handler sending logged messages to stderr
28stream_handler = None 33​stream_handler = None
29 34​
▲ Show 20 Lines • Show All 175 Lines • Show Last 20 Lines
View Options

libtaskotron/runner.py

Show First 20 Lines • Show All 222 Lines • ▼ Show 20 Line(s)
223 223​
224def main(): 224​def main():
225 # Preliminary initialization of logging, so all messages before regular 225​ # Preliminary initialization of logging, so all messages before regular
226 # initialization can be logged to stream. 226​ # initialization can be logged to stream.
227 # FIXME: Remove this once this ticket is resolved: 227​ # FIXME: Remove this once this ticket is resolved:
228 # https://phab.qadevel.cloud.fedoraproject.org/T273 228​ # https://phab.qadevel.cloud.fedoraproject.org/T273
229 logger.init_prior_config() 229​ logger.init_prior_config()
230 230​
231​ log.info('Execution started at: %s',
232​ datetime.datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S UTC'))
231 log.debug('Using libtaskotron %s', libtaskotron.__version__) 233​ log.debug('Using libtaskotron %s', libtaskotron.__version__)
232 234​
233 # parse cmdline 235​ # parse cmdline
234 parser = get_argparser() 236​ parser = get_argparser()
235 args = parser.parse_args() 237​ args = parser.parse_args()
236 log.debug('Parsed arguments: %s', args) 238​ log.debug('Parsed arguments: %s', args)
237 239​
238 # full logging initialization 240​ # full logging initialization
239 level_stream = logging.DEBUG if args.debug else None 241​ level_stream = logging.DEBUG if args.debug else None
240 logger.init(level_stream=level_stream) 242​ logger.init(level_stream=level_stream)
241 243​
242 arg_data = process_args(vars(args)) 244​ arg_data = process_args(vars(args))
243 arg_data['taskfile'] = args.task[0] 245​ arg_data['taskfile'] = args.task[0]
244 246​
245 # parse task formula 247​ # parse task formula
246 task_data = taskformula.parse_yaml_from_file(arg_data['taskfile']) 248​ task_data = taskformula.parse_yaml_from_file(arg_data['taskfile'])
247 if not task_data: 249​ if not task_data:
248 raise TaskotronYamlError('Input file should not be empty') 250​ raise TaskotronYamlError('Input file should not be empty')
249 251​
250 # run the task 252​ # run the task
251 task_runner = Runner(task_data, arg_data) 253​ task_runner = Runner(task_data, arg_data)
252 task_runner.run() 254​ task_runner.run()
253 255​
254 # finalization 256​ # finalization
255 log.info('Check execution finished.') 257​ log.info('Execution finished at: %s',
258​ datetime.datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S UTC'))