openstack.common.log.setup() failures can be hard to understand

[James Li]

Affected version: 2013.1

openstack.common.log.setup() does not check the existence of log conf file. If the specified file is not there, a 'NoSectionError' exception and a messy stack trace will be thrown (see below), which is actually not accurate. Should distinguish between non-existence and invalidation of the file.

# /usr/bin/glance-scrubber --log-config=/home/lijam/log.XX
Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/glance/openstack/common/log.py", line 332, in setup
    logging.config.fileConfig(CONF.log_config)
  File "/usr/lib/python2.7/logging/config.py", line 70, in fileConfig
    formatters = _create_formatters(cp)
  File "/usr/lib/python2.7/logging/config.py", line 106, in _create_formatters
    flist = cp.get("formatters", "keys")
  File "/usr/lib/python2.7/ConfigParser.py", line 607, in get
    raise NoSectionError(section)
NoSectionError: No section: 'formatters'
No handlers could be found for logger "glance"

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/24230

[Mark McLoughlin (markmc)]

Thanks for the report and the patch

I think this is basically a duplicate of bug #1065430 - see the discussion on https://review.openstack.org/#/c/24092/

[Mark McLoughlin (markmc)]

Sorry, sorry - I completely misread this. Nevermind my comment

[Mark McLoughlin (markmc)]

Could you show us what the "messy traceback" is?

[James Li (james-li-3)]

# /usr/bin/glance-scrubber --log-config=/home/lijam/log.XX
Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/glance/openstack/common/log.py", line 332, in setup
    logging.config.fileConfig(CONF.log_config)
  File "/usr/lib/python2.7/logging/config.py", line 70, in fileConfig
    formatters = _create_formatters(cp)
  File "/usr/lib/python2.7/logging/config.py", line 106, in _create_formatters
    flist = cp.get("formatters", "keys")
  File "/usr/lib/python2.7/ConfigParser.py", line 607, in get
    raise NoSectionError(section)
NoSectionError: No section: 'formatters'
No handlers could be found for logger "glance"

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/25111

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/25111
Committed: http://github.com/openstack/oslo-incubator/commit/c87e615bf98981219c2f92242f6ff9ee6753d786
Submitter: Jenkins
Branch: master

commit c87e615bf98981219c2f92242f6ff9ee6753d786
Author: Mark McLoughlin <email address hidden>
Date: Fri Mar 22 07:32:31 2013 +0000

    Gracefully handle errors in logging config files

    Fixes bug #1154245

    If the parameter to the --log-config option cannot be loaded by the
    logging.config.fileConfig() function, you get an exception like this
    raised:

      NoSectionError: No section: 'formatters'

    which doesn't do much to help users understand the error.

    Improve the situation by wrapping the error in a custom exception type
    giving this:

     LogConfigError: Error loading logging config /etc/logging.conf: No section: 'formatters'

    Also add some tests to check we raise this error under the most common
    failure conditions.

    Change-Id: I6ad2eb4867213b6356ce43d75da50218d1b498f6