From 17218a801123a8efaf8cb516c935d22c74ef80ed Mon Sep 17 00:00:00 2001 From: Lan Qi song Date: Thu, 28 May 2015 23:58:23 +0800 Subject: [PATCH] Use oslo.log instead of oslo.incubator log module oslo.log has graduated from oslo-incubator, magnum need use oslo.log instead of oslo.incubator log module. NOTE: openstack.common.log registers its options at import time, but oslo.log needs to call register_options() explicitly. Change-Id: I671bb020b628bd972813daf5936040b7f1c6bf7a Closes-Bug: #1459736 --- etc/magnum/magnum.conf.sample | 110 ++- magnum/api/controllers/v1/container.py | 2 +- magnum/api/middleware/auth_token.py | 2 +- magnum/api/middleware/parsable_error.py | 2 +- magnum/cmd/api.py | 3 +- magnum/cmd/conductor.py | 5 +- magnum/cmd/db_manage.py | 2 +- magnum/cmd/template_manage.py | 2 +- magnum/common/clients.py | 2 +- magnum/common/exception.py | 2 +- magnum/common/magnum_keystoneclient.py | 2 +- magnum/common/service.py | 5 +- magnum/common/urlfetch.py | 2 +- magnum/common/utils.py | 2 +- magnum/conductor/bay_lock.py | 2 +- magnum/conductor/handlers/bay_conductor.py | 2 +- .../handlers/common/docker_client.py | 2 +- .../conductor/handlers/common/kube_utils.py | 3 +- magnum/conductor/handlers/docker_conductor.py | 2 +- magnum/conductor/handlers/kube.py | 2 +- magnum/db/sqlalchemy/api.py | 2 +- magnum/objects/base.py | 2 +- magnum/openstack/common/log.py | 718 ------------------ magnum/opts.py | 11 +- magnum/tests/base.py | 2 + magnum/tests/conf_fixture.py | 2 + requirements.txt | 1 + tox.ini | 1 + 28 files changed, 136 insertions(+), 759 deletions(-) delete mode 100644 magnum/openstack/common/log.py diff --git a/etc/magnum/magnum.conf.sample b/etc/magnum/magnum.conf.sample index 41dec6dd2c..f8f4f866b3 100644 --- a/etc/magnum/magnum.conf.sample +++ b/etc/magnum/magnum.conf.sample @@ -123,10 +123,104 @@ # them here? (boolean value) #run_external_periodic_tasks = true +# +# From oslo.log +# + +# Print debugging output (set logging level to DEBUG instead of +# default WARNING level). (boolean value) +#debug = false + +# Print more verbose output (set logging level to INFO instead of +# default WARNING level). (boolean value) +#verbose = false + +# The name of a logging configuration file. This file is appended to +# any existing logging configuration files. For details about logging +# configuration files, see the Python logging module documentation. +# (string value) +# Deprecated group/name - [DEFAULT]/log_config +#log_config_append = + +# DEPRECATED. A logging.Formatter log message format string which may +# use any of the available logging.LogRecord attributes. This option +# is deprecated. Please use logging_context_format_string and +# logging_default_format_string instead. (string value) +#log_format = + +# Format string for %%(asctime)s in log records. Default: %(default)s +# . (string value) +#log_date_format = %Y-%m-%d %H:%M:%S + +# (Optional) Name of log file to output to. If no default is set, +# logging will go to stdout. (string value) +# Deprecated group/name - [DEFAULT]/logfile +#log_file = + +# (Optional) The base directory used for relative --log-file paths. +# (string value) +# Deprecated group/name - [DEFAULT]/logdir +#log_dir = + +# Use syslog for logging. Existing syslog format is DEPRECATED during +# I, and changed in J to honor RFC5424. (boolean value) +#use_syslog = false + +# (Optional) Enables or disables syslog rfc5424 format for logging. If +# enabled, prefixes the MSG part of the syslog message with APP-NAME +# (RFC5424). The format without the APP-NAME is deprecated in K, and +# will be removed in M, along with this option. (boolean value) +# This option is deprecated for removal. +# Its value may be silently ignored in the future. +#use_syslog_rfc_format = true + +# Syslog facility to receive log lines. (string value) +#syslog_log_facility = LOG_USER + +# Log output to standard error. (boolean value) +#use_stderr = true + +# Format string to use for log messages with context. (string value) +#logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s + +# Format string to use for log messages without context. (string +# value) +#logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s + +# Data to append to log format when level is DEBUG. (string value) +#logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d + +# Prefix each line of exception output with this format. (string +# value) +#logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s + +# List of logger=LEVEL pairs. (list value) +#default_log_levels = amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,requests.packages.urllib3.util.retry=WARN,urllib3.util.retry=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN + +# Enables or disables publication of error events. (boolean value) +#publish_errors = false + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + +# The format for an instance that is passed with the log message. +# (string value) +#instance_format = "[instance: %(uuid)s] " + +# The format for an instance UUID that is passed with the log message. +# (string value) +#instance_uuid_format = "[instance: %(uuid)s] " + +# Enables or disables fatal status of deprecations. (boolean value) +#fatal_deprecations = false + # # From oslo.messaging # +# Size of RPC connection pool. (integer value) +#rpc_conn_pool_size = 30 + # ZeroMQ bind address. Should be a wildcard (*), an ethernet # interface, or IP. The "host" option should point or resolve to this # address. (string value) @@ -166,7 +260,7 @@ #rpc_thread_pool_size = 64 # The Drivers(s) to handle sending notifications. Possible values are -# messaging, messagingv2, routing,log, test, noop (multi valued) +# messaging, messagingv2, routing, log, test, noop (multi valued) #notification_driver = # AMQP topic used for OpenStack notifications. (list value) @@ -737,10 +831,6 @@ # Deprecated group/name - [DEFAULT]/amqp_auto_delete #amqp_auto_delete = false -# Size of RPC connection pool. (integer value) -# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size -#rpc_conn_pool_size = 30 - # Qpid broker hostname. (string value) # Deprecated group/name - [DEFAULT]/qpid_hostname #qpid_hostname = localhost @@ -806,10 +896,6 @@ # Deprecated group/name - [DEFAULT]/amqp_auto_delete #amqp_auto_delete = false -# Size of RPC connection pool. (integer value) -# Deprecated group/name - [DEFAULT]/rpc_conn_pool_size -#rpc_conn_pool_size = 30 - # SSL version to use (valid only if SSL enabled). Valid values are # TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be # available on some distributions. (string value) @@ -887,9 +973,9 @@ #rabbit_ha_queues = false # Number of seconds after which the Rabbit broker is considered down -# if heartbeat's keep-alive fails (0 disable the heartbeat). (integer -# value) -#heartbeat_timeout_threshold = 60 +# if heartbeat's keep-alive fails (0 disable the heartbeat). +# EXPERIMENTAL (integer value) +#heartbeat_timeout_threshold = 0 # How often times during the heartbeat_timeout_threshold we check the # heartbeat. (integer value) diff --git a/magnum/api/controllers/v1/container.py b/magnum/api/controllers/v1/container.py index d3332bc43f..e685ca11c5 100644 --- a/magnum/api/controllers/v1/container.py +++ b/magnum/api/controllers/v1/container.py @@ -15,6 +15,7 @@ import datetime +from oslo_log import log as logging import pecan from pecan import rest import wsme @@ -28,7 +29,6 @@ from magnum.api.controllers.v1 import types from magnum.api.controllers.v1 import utils as api_utils from magnum.common import exception from magnum import objects -from magnum.openstack.common import log as logging LOG = logging.getLogger(__name__) diff --git a/magnum/api/middleware/auth_token.py b/magnum/api/middleware/auth_token.py index b0b16ef1d1..5302a679eb 100644 --- a/magnum/api/middleware/auth_token.py +++ b/magnum/api/middleware/auth_token.py @@ -13,11 +13,11 @@ import re from keystonemiddleware import auth_token +from oslo_log import log from magnum.common import exception from magnum.common import utils from magnum.i18n import _ -from magnum.openstack.common import log LOG = log.getLogger(__name__) diff --git a/magnum/api/middleware/parsable_error.py b/magnum/api/middleware/parsable_error.py index 3c9c2ad0e1..02ebfa5939 100644 --- a/magnum/api/middleware/parsable_error.py +++ b/magnum/api/middleware/parsable_error.py @@ -21,11 +21,11 @@ Based on pecan.middleware.errordocument import json from xml import etree as et +from oslo_log import log import webob from magnum.i18n import _ from magnum.i18n import _LE -from magnum.openstack.common import log LOG = log.getLogger(__name__) diff --git a/magnum/cmd/api.py b/magnum/cmd/api.py index c3d217e869..ded133531c 100644 --- a/magnum/cmd/api.py +++ b/magnum/cmd/api.py @@ -20,17 +20,18 @@ import sys from wsgiref import simple_server from oslo_config import cfg +from oslo_log import log as logging from magnum.api import app as api_app from magnum.common import service from magnum.i18n import _LI -from magnum.openstack.common import log as logging LOG = logging.getLogger(__name__) def main(): + logging.register_options(cfg.CONF) service.prepare_service(sys.argv) app = api_app.setup_app() diff --git a/magnum/cmd/conductor.py b/magnum/cmd/conductor.py index 4edc1a2982..1694c4eab4 100644 --- a/magnum/cmd/conductor.py +++ b/magnum/cmd/conductor.py @@ -19,6 +19,7 @@ import os import sys from oslo_config import cfg +from oslo_log import log as logging from magnum.common import rpc_service as service from magnum.common import short_id @@ -28,14 +29,14 @@ from magnum.conductor.handlers import docker_conductor from magnum.conductor.handlers import kube as k8s_conductor from magnum.i18n import _LE from magnum.i18n import _LI -from magnum.openstack.common import log as logging LOG = logging.getLogger(__name__) def main(): + logging.register_options(cfg.CONF) cfg.CONF(sys.argv[1:], project='magnum') - logging.setup('magnum') + logging.setup(cfg.CONF, 'magnum') LOG.info(_LI('Starting server in PID %s') % os.getpid()) LOG.debug("Configuration:") diff --git a/magnum/cmd/db_manage.py b/magnum/cmd/db_manage.py index fc29dfff8a..1d7471dc12 100644 --- a/magnum/cmd/db_manage.py +++ b/magnum/cmd/db_manage.py @@ -18,8 +18,8 @@ import os from oslo_config import cfg from oslo_db import options from oslo_db.sqlalchemy.migration_cli import manager +from oslo_log import log as logging -from magnum.openstack.common import log as logging LOG = logging.getLogger(__name__) CONF = cfg.CONF diff --git a/magnum/cmd/template_manage.py b/magnum/cmd/template_manage.py index 9ff4fc700a..d792d14519 100644 --- a/magnum/cmd/template_manage.py +++ b/magnum/cmd/template_manage.py @@ -15,10 +15,10 @@ import operator from oslo_config import cfg +from oslo_log import log as logging from magnum.conductor import template_definition as tdef from magnum.openstack.common import cliutils -from magnum.openstack.common import log as logging LOG = logging.getLogger(__name__) CONF = cfg.CONF diff --git a/magnum/common/clients.py b/magnum/common/clients.py index defe607bfc..41bfcf5c3a 100644 --- a/magnum/common/clients.py +++ b/magnum/common/clients.py @@ -15,11 +15,11 @@ from glanceclient.v2 import client as glanceclient from heatclient.v1 import client as heatclient from oslo_config import cfg +from oslo_log import log as logging from magnum.common import exception from magnum.common import magnum_keystoneclient from magnum.i18n import _ -from magnum.openstack.common import log as logging LOG = logging.getLogger(__name__) diff --git a/magnum/common/exception.py b/magnum/common/exception.py index 1b5bd951bc..34ff047507 100644 --- a/magnum/common/exception.py +++ b/magnum/common/exception.py @@ -24,6 +24,7 @@ import uuid from keystoneclient import exceptions as keystone_exceptions from oslo_config import cfg +from oslo_log import log as logging from oslo_utils import excutils import pecan import six @@ -32,7 +33,6 @@ import wsme from magnum.common import safe_utils from magnum.i18n import _ from magnum.i18n import _LE -from magnum.openstack.common import log as logging LOG = logging.getLogger(__name__) diff --git a/magnum/common/magnum_keystoneclient.py b/magnum/common/magnum_keystoneclient.py index f1f4458eb2..d3d1e87550 100644 --- a/magnum/common/magnum_keystoneclient.py +++ b/magnum/common/magnum_keystoneclient.py @@ -17,6 +17,7 @@ import copy import keystoneclient.exceptions as kc_exception from keystoneclient.v3 import client as kc_v3 from oslo_config import cfg +from oslo_log import log as logging from oslo_utils import importutils from magnum.common import context as magnum_context @@ -24,7 +25,6 @@ from magnum.common import exception from magnum.i18n import _ from magnum.i18n import _LE from magnum.i18n import _LI -from magnum.openstack.common import log as logging LOG = logging.getLogger(__name__) diff --git a/magnum/common/service.py b/magnum/common/service.py index d9f9b6cf78..62ac832c8c 100644 --- a/magnum/common/service.py +++ b/magnum/common/service.py @@ -13,10 +13,9 @@ # limitations under the License. from oslo_config import cfg - -from magnum.openstack.common import log as logging +from oslo_log import log as logging def prepare_service(argv=[]): cfg.CONF(argv[1:], project='magnum') - logging.setup('magnum') + logging.setup(cfg.CONF, 'magnum') diff --git a/magnum/common/urlfetch.py b/magnum/common/urlfetch.py index b4eb78135b..1069887472 100644 --- a/magnum/common/urlfetch.py +++ b/magnum/common/urlfetch.py @@ -14,6 +14,7 @@ """Utility for fetching a resource (e.g. a manifest) from a URL.""" from oslo_config import cfg +from oslo_log import log as logging import requests from requests import exceptions from six.moves import urllib @@ -21,7 +22,6 @@ from six.moves import urllib from magnum.common import exception from magnum.i18n import _ from magnum.i18n import _LI -from magnum.openstack.common import log as logging URLFETCH_OPTS = [ cfg.IntOpt('max_manifest_size', diff --git a/magnum/common/utils.py b/magnum/common/utils.py index c5f36a2584..c73390b79a 100644 --- a/magnum/common/utils.py +++ b/magnum/common/utils.py @@ -31,6 +31,7 @@ import uuid import netaddr from oslo_concurrency import processutils from oslo_config import cfg +from oslo_log import log as logging from oslo_utils import excutils import paramiko import six @@ -39,7 +40,6 @@ from magnum.common import exception from magnum.i18n import _ from magnum.i18n import _LE from magnum.i18n import _LW -from magnum.openstack.common import log as logging UTILS_OPTS = [ cfg.StrOpt('rootwrap_config', diff --git a/magnum/conductor/bay_lock.py b/magnum/conductor/bay_lock.py index a6ac91f285..08c6aa4cfa 100644 --- a/magnum/conductor/bay_lock.py +++ b/magnum/conductor/bay_lock.py @@ -14,6 +14,7 @@ import contextlib from oslo_config import cfg +from oslo_log import log as logging import oslo_messaging as messaging from oslo_utils import excutils @@ -22,7 +23,6 @@ from magnum.conductor.api import ListenerAPI from magnum.i18n import _LI from magnum.i18n import _LW from magnum import objects -from magnum.openstack.common import log as logging cfg.CONF.import_opt('topic', 'magnum.conductor.config', diff --git a/magnum/conductor/handlers/bay_conductor.py b/magnum/conductor/handlers/bay_conductor.py index 35c9ac286a..8d5adc959b 100644 --- a/magnum/conductor/handlers/bay_conductor.py +++ b/magnum/conductor/handlers/bay_conductor.py @@ -15,6 +15,7 @@ from heatclient.common import template_utils from heatclient import exc from oslo_config import cfg +from oslo_log import log as logging from magnum.common import clients from magnum.common import exception @@ -25,7 +26,6 @@ from magnum.i18n import _LE from magnum.i18n import _LI from magnum import objects from magnum.objects.bay import Status as bay_status -from magnum.openstack.common import log as logging from magnum.openstack.common import loopingcall diff --git a/magnum/conductor/handlers/common/docker_client.py b/magnum/conductor/handlers/common/docker_client.py index 7b6266ef34..b9f5f46046 100644 --- a/magnum/conductor/handlers/common/docker_client.py +++ b/magnum/conductor/handlers/common/docker_client.py @@ -15,8 +15,8 @@ from docker import client from docker import tls from oslo_config import cfg +from oslo_log import log as logging -from magnum.openstack.common import log as logging DEFAULT_DOCKER_REMOTE_API_VERSION = '1.17' DEFAULT_DOCKER_TIMEOUT = 10 diff --git a/magnum/conductor/handlers/common/kube_utils.py b/magnum/conductor/handlers/common/kube_utils.py index ed1a9d17e4..9be268dfdd 100644 --- a/magnum/conductor/handlers/common/kube_utils.py +++ b/magnum/conductor/handlers/common/kube_utils.py @@ -14,9 +14,10 @@ import tempfile +from oslo_log import log as logging + from magnum.common import exception from magnum.i18n import _LE -from magnum.openstack.common import log as logging from magnum.openstack.common import utils LOG = logging.getLogger(__name__) diff --git a/magnum/conductor/handlers/docker_conductor.py b/magnum/conductor/handlers/docker_conductor.py index 010188710d..a8e80f90fe 100644 --- a/magnum/conductor/handlers/docker_conductor.py +++ b/magnum/conductor/handlers/docker_conductor.py @@ -15,6 +15,7 @@ from docker import errors import functools from oslo_config import cfg +from oslo_log import log as logging from magnum.common import docker_utils from magnum.common import exception @@ -23,7 +24,6 @@ from magnum.conductor.handlers.common import docker_client from magnum import objects from magnum.objects import container as obj_container from magnum.openstack.common._i18n import _LE -from magnum.openstack.common import log as logging LOG = logging.getLogger(__name__) CONF = cfg.CONF diff --git a/magnum/conductor/handlers/kube.py b/magnum/conductor/handlers/kube.py index 89dce437f5..7d74e9daef 100644 --- a/magnum/conductor/handlers/kube.py +++ b/magnum/conductor/handlers/kube.py @@ -13,6 +13,7 @@ """Magnum Kubernetes RPC handler.""" from oslo_config import cfg +from oslo_log import log as logging from magnum.common import clients from magnum.common import exception @@ -21,7 +22,6 @@ from magnum.common.pythonk8sclient.client import ApivbetaApi from magnum.common.pythonk8sclient.client import swagger from magnum.i18n import _ from magnum import objects -from magnum.openstack.common import log as logging import ast from six.moves.urllib import error diff --git a/magnum/db/sqlalchemy/api.py b/magnum/db/sqlalchemy/api.py index 4ef042c9a3..e3bd9bbd72 100644 --- a/magnum/db/sqlalchemy/api.py +++ b/magnum/db/sqlalchemy/api.py @@ -18,6 +18,7 @@ from oslo_config import cfg from oslo_db import exception as db_exc from oslo_db.sqlalchemy import session as db_session from oslo_db.sqlalchemy import utils as db_utils +from oslo_log import log from oslo_utils import timeutils from sqlalchemy.orm.exc import MultipleResultsFound from sqlalchemy.orm.exc import NoResultFound @@ -27,7 +28,6 @@ from magnum.common import utils from magnum.db import api from magnum.db.sqlalchemy import models from magnum.i18n import _ -from magnum.openstack.common import log CONF = cfg.CONF diff --git a/magnum/objects/base.py b/magnum/objects/base.py index 0176f7954f..46af82f4c1 100644 --- a/magnum/objects/base.py +++ b/magnum/objects/base.py @@ -14,10 +14,10 @@ """Magnum common internal object model""" +from oslo_log import log as logging from oslo_versionedobjects import base as ovoo_base from oslo_versionedobjects import fields as ovoo_fields -from magnum.openstack.common import log as logging LOG = logging.getLogger('object') diff --git a/magnum/openstack/common/log.py b/magnum/openstack/common/log.py deleted file mode 100644 index c41d55e479..0000000000 --- a/magnum/openstack/common/log.py +++ /dev/null @@ -1,718 +0,0 @@ -# Copyright 2011 OpenStack Foundation. -# Copyright 2010 United States Government as represented by the -# Administrator of the National Aeronautics and Space Administration. -# All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. You may obtain -# a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. - -"""OpenStack logging handler. - -This module adds to logging functionality by adding the option to specify -a context object when calling the various log methods. If the context object -is not specified, default formatting is used. Additionally, an instance uuid -may be passed as part of the log message, which is intended to make it easier -for admins to find messages related to a specific instance. - -It also allows setting of formatting information through conf. - -""" - -import copy -import inspect -import itertools -import logging -import logging.config -import logging.handlers -import os -import socket -import sys -import traceback - -from oslo_config import cfg -from oslo_serialization import jsonutils -from oslo_utils import importutils -import six -from six import moves - -_PY26 = sys.version_info[0:2] == (2, 6) - -from magnum.openstack.common._i18n import _ -from magnum.openstack.common import local - - -_DEFAULT_LOG_DATE_FORMAT = "%Y-%m-%d %H:%M:%S" - - -common_cli_opts = [ - cfg.BoolOpt('debug', - short='d', - default=False, - help='Print debugging output (set logging level to ' - 'DEBUG instead of default WARNING level).'), - cfg.BoolOpt('verbose', - short='v', - default=False, - help='Print more verbose output (set logging level to ' - 'INFO instead of default WARNING level).'), -] - -logging_cli_opts = [ - cfg.StrOpt('log-config-append', - metavar='PATH', - deprecated_name='log-config', - help='The name of a logging configuration file. This file ' - 'is appended to any existing logging configuration ' - 'files. For details about logging configuration files, ' - 'see the Python logging module documentation.'), - cfg.StrOpt('log-format', - metavar='FORMAT', - help='DEPRECATED. ' - 'A logging.Formatter log message format string which may ' - 'use any of the available logging.LogRecord attributes. ' - 'This option is deprecated. Please use ' - 'logging_context_format_string and ' - 'logging_default_format_string instead.'), - cfg.StrOpt('log-date-format', - default=_DEFAULT_LOG_DATE_FORMAT, - metavar='DATE_FORMAT', - help='Format string for %%(asctime)s in log records. ' - 'Default: %(default)s .'), - cfg.StrOpt('log-file', - metavar='PATH', - deprecated_name='logfile', - help='(Optional) Name of log file to output to. ' - 'If no default is set, logging will go to stdout.'), - cfg.StrOpt('log-dir', - deprecated_name='logdir', - help='(Optional) The base directory used for relative ' - '--log-file paths.'), - cfg.BoolOpt('use-syslog', - default=False, - help='Use syslog for logging. ' - 'Existing syslog format is DEPRECATED during I, ' - 'and will change in J to honor RFC5424.'), - cfg.BoolOpt('use-syslog-rfc-format', - # TODO(bogdando) remove or use True after existing - # syslog format deprecation in J - default=False, - help='(Optional) Enables or disables syslog rfc5424 format ' - 'for logging. If enabled, prefixes the MSG part of the ' - 'syslog message with APP-NAME (RFC5424). The ' - 'format without the APP-NAME is deprecated in I, ' - 'and will be removed in J.'), - cfg.StrOpt('syslog-log-facility', - default='LOG_USER', - help='Syslog facility to receive log lines.') -] - -generic_log_opts = [ - cfg.BoolOpt('use_stderr', - default=True, - help='Log output to standard error.') -] - -DEFAULT_LOG_LEVELS = ['amqp=WARN', 'amqplib=WARN', 'boto=WARN', - 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', - 'oslo.messaging=INFO', 'iso8601=WARN', - 'requests.packages.urllib3.connectionpool=WARN', - 'urllib3.connectionpool=WARN', 'websocket=WARN', - "keystonemiddleware=WARN", "routes.middleware=WARN", - "stevedore=WARN"] - -log_opts = [ - cfg.StrOpt('logging_context_format_string', - default='%(asctime)s.%(msecs)03d %(process)d %(levelname)s ' - '%(name)s [%(request_id)s %(user_identity)s] ' - '%(instance)s%(message)s', - help='Format string to use for log messages with context.'), - cfg.StrOpt('logging_default_format_string', - default='%(asctime)s.%(msecs)03d %(process)d %(levelname)s ' - '%(name)s [-] %(instance)s%(message)s', - help='Format string to use for log messages without context.'), - cfg.StrOpt('logging_debug_format_suffix', - default='%(funcName)s %(pathname)s:%(lineno)d', - help='Data to append to log format when level is DEBUG.'), - cfg.StrOpt('logging_exception_prefix', - default='%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s ' - '%(instance)s', - help='Prefix each line of exception output with this format.'), - cfg.ListOpt('default_log_levels', - default=DEFAULT_LOG_LEVELS, - help='List of logger=LEVEL pairs.'), - cfg.BoolOpt('publish_errors', - default=False, - help='Enables or disables publication of error events.'), - cfg.BoolOpt('fatal_deprecations', - default=False, - help='Enables or disables fatal status of deprecations.'), - - # NOTE(mikal): there are two options here because sometimes we are handed - # a full instance (and could include more information), and other times we - # are just handed a UUID for the instance. - cfg.StrOpt('instance_format', - default='[instance: %(uuid)s] ', - help='The format for an instance that is passed with the log ' - 'message.'), - cfg.StrOpt('instance_uuid_format', - default='[instance: %(uuid)s] ', - help='The format for an instance UUID that is passed with the ' - 'log message.'), -] - -CONF = cfg.CONF -CONF.register_cli_opts(common_cli_opts) -CONF.register_cli_opts(logging_cli_opts) -CONF.register_opts(generic_log_opts) -CONF.register_opts(log_opts) - - -def list_opts(): - """Entry point for oslo.config-generator.""" - return [(None, copy.deepcopy(common_cli_opts)), - (None, copy.deepcopy(logging_cli_opts)), - (None, copy.deepcopy(generic_log_opts)), - (None, copy.deepcopy(log_opts)), - ] - - -# our new audit level -# NOTE(jkoelker) Since we synthesized an audit level, make the logging -# module aware of it so it acts like other levels. -logging.AUDIT = logging.INFO + 1 -logging.addLevelName(logging.AUDIT, 'AUDIT') - - -try: - NullHandler = logging.NullHandler -except AttributeError: # NOTE(jkoelker) NullHandler added in Python 2.7 - class NullHandler(logging.Handler): - def handle(self, record): - pass - - def emit(self, record): - pass - - def createLock(self): - self.lock = None - - -def _dictify_context(context): - if context is None: - return None - if not isinstance(context, dict) and getattr(context, 'to_dict', None): - context = context.to_dict() - return context - - -def _get_binary_name(): - return os.path.basename(inspect.stack()[-1][1]) - - -def _get_log_file_path(binary=None): - logfile = CONF.log_file - logdir = CONF.log_dir - - if logfile and not logdir: - return logfile - - if logfile and logdir: - return os.path.join(logdir, logfile) - - if logdir: - binary = binary or _get_binary_name() - return '%s.log' % (os.path.join(logdir, binary),) - - return None - - -class BaseLoggerAdapter(logging.LoggerAdapter): - - def audit(self, msg, *args, **kwargs): - self.log(logging.AUDIT, msg, *args, **kwargs) - - def isEnabledFor(self, level): - if _PY26: - # This method was added in python 2.7 (and it does the exact - # same logic, so we need to do the exact same logic so that - # python 2.6 has this capability as well). - return self.logger.isEnabledFor(level) - else: - return super(BaseLoggerAdapter, self).isEnabledFor(level) - - -class LazyAdapter(BaseLoggerAdapter): - def __init__(self, name='unknown', version='unknown'): - self._logger = None - self.extra = {} - self.name = name - self.version = version - - @property - def logger(self): - if not self._logger: - self._logger = getLogger(self.name, self.version) - if six.PY3: - # In Python 3, the code fails because the 'manager' attribute - # cannot be found when using a LoggerAdapter as the - # underlying logger. Work around this issue. - self._logger.manager = self._logger.logger.manager - return self._logger - - -class ContextAdapter(BaseLoggerAdapter): - warn = logging.LoggerAdapter.warning - - def __init__(self, logger, project_name, version_string): - self.logger = logger - self.project = project_name - self.version = version_string - self._deprecated_messages_sent = dict() - - @property - def handlers(self): - return self.logger.handlers - - def deprecated(self, msg, *args, **kwargs): - """Call this method when a deprecated feature is used. - - If the system is configured for fatal deprecations then the message - is logged at the 'critical' level and :class:`DeprecatedConfig` will - be raised. - - Otherwise, the message will be logged (once) at the 'warn' level. - - :raises: :class:`DeprecatedConfig` if the system is configured for - fatal deprecations. - - """ - stdmsg = _("Deprecated: %s") % msg - if CONF.fatal_deprecations: - self.critical(stdmsg, *args, **kwargs) - raise DeprecatedConfig(msg=stdmsg) - - # Using a list because a tuple with dict can't be stored in a set. - sent_args = self._deprecated_messages_sent.setdefault(msg, list()) - - if args in sent_args: - # Already logged this message, so don't log it again. - return - - sent_args.append(args) - self.warn(stdmsg, *args, **kwargs) - - def process(self, msg, kwargs): - # NOTE(jecarey): If msg is not unicode, coerce it into unicode - # before it can get to the python logging and - # possibly cause string encoding trouble - if not isinstance(msg, six.text_type): - msg = six.text_type(msg) - - if 'extra' not in kwargs: - kwargs['extra'] = {} - extra = kwargs['extra'] - - context = kwargs.pop('context', None) - if not context: - context = getattr(local.store, 'context', None) - if context: - extra.update(_dictify_context(context)) - - instance = kwargs.pop('instance', None) - instance_uuid = (extra.get('instance_uuid') or - kwargs.pop('instance_uuid', None)) - instance_extra = '' - if instance: - instance_extra = CONF.instance_format % instance - elif instance_uuid: - instance_extra = (CONF.instance_uuid_format - % {'uuid': instance_uuid}) - extra['instance'] = instance_extra - - extra.setdefault('user_identity', kwargs.pop('user_identity', None)) - - extra['project'] = self.project - extra['version'] = self.version - extra['extra'] = extra.copy() - return msg, kwargs - - -class JSONFormatter(logging.Formatter): - def __init__(self, fmt=None, datefmt=None): - # NOTE(jkoelker) we ignore the fmt argument, but its still there - # since logging.config.fileConfig passes it. - self.datefmt = datefmt - - def formatException(self, ei, strip_newlines=True): - lines = traceback.format_exception(*ei) - if strip_newlines: - lines = [moves.filter( - lambda x: x, - line.rstrip().splitlines()) for line in lines] - lines = list(itertools.chain(*lines)) - return lines - - def format(self, record): - message = {'message': record.getMessage(), - 'asctime': self.formatTime(record, self.datefmt), - 'name': record.name, - 'msg': record.msg, - 'args': record.args, - 'levelname': record.levelname, - 'levelno': record.levelno, - 'pathname': record.pathname, - 'filename': record.filename, - 'module': record.module, - 'lineno': record.lineno, - 'funcname': record.funcName, - 'created': record.created, - 'msecs': record.msecs, - 'relative_created': record.relativeCreated, - 'thread': record.thread, - 'thread_name': record.threadName, - 'process_name': record.processName, - 'process': record.process, - 'traceback': None} - - if hasattr(record, 'extra'): - message['extra'] = record.extra - - if record.exc_info: - message['traceback'] = self.formatException(record.exc_info) - - return jsonutils.dumps(message) - - -def _create_logging_excepthook(product_name): - def logging_excepthook(exc_type, value, tb): - extra = {'exc_info': (exc_type, value, tb)} - getLogger(product_name).critical( - "".join(traceback.format_exception_only(exc_type, value)), - **extra) - return logging_excepthook - - -class LogConfigError(Exception): - - message = _('Error loading logging config %(log_config)s: %(err_msg)s') - - def __init__(self, log_config, err_msg): - self.log_config = log_config - self.err_msg = err_msg - - def __str__(self): - return self.message % dict(log_config=self.log_config, - err_msg=self.err_msg) - - -def _load_log_config(log_config_append): - try: - logging.config.fileConfig(log_config_append, - disable_existing_loggers=False) - except (moves.configparser.Error, KeyError) as exc: - raise LogConfigError(log_config_append, six.text_type(exc)) - - -def setup(product_name, version='unknown'): - """Setup logging.""" - if CONF.log_config_append: - _load_log_config(CONF.log_config_append) - else: - _setup_logging_from_conf(product_name, version) - sys.excepthook = _create_logging_excepthook(product_name) - - -def set_defaults(logging_context_format_string=None, - default_log_levels=None): - # Just in case the caller is not setting the - # default_log_level. This is insurance because - # we introduced the default_log_level parameter - # later in a backwards in-compatible change - if default_log_levels is not None: - cfg.set_defaults( - log_opts, - default_log_levels=default_log_levels) - if logging_context_format_string is not None: - cfg.set_defaults( - log_opts, - logging_context_format_string=logging_context_format_string) - - -def _find_facility_from_conf(): - facility_names = logging.handlers.SysLogHandler.facility_names - facility = getattr(logging.handlers.SysLogHandler, - CONF.syslog_log_facility, - None) - - if facility is None and CONF.syslog_log_facility in facility_names: - facility = facility_names.get(CONF.syslog_log_facility) - - if facility is None: - valid_facilities = facility_names.keys() - consts = ['LOG_AUTH', 'LOG_AUTHPRIV', 'LOG_CRON', 'LOG_DAEMON', - 'LOG_FTP', 'LOG_KERN', 'LOG_LPR', 'LOG_MAIL', 'LOG_NEWS', - 'LOG_AUTH', 'LOG_SYSLOG', 'LOG_USER', 'LOG_UUCP', - 'LOG_LOCAL0', 'LOG_LOCAL1', 'LOG_LOCAL2', 'LOG_LOCAL3', - 'LOG_LOCAL4', 'LOG_LOCAL5', 'LOG_LOCAL6', 'LOG_LOCAL7'] - valid_facilities.extend(consts) - raise TypeError(_('syslog facility must be one of: %s') % - ', '.join("'%s'" % fac - for fac in valid_facilities)) - - return facility - - -class RFCSysLogHandler(logging.handlers.SysLogHandler): - def __init__(self, *args, **kwargs): - self.binary_name = _get_binary_name() - # Do not use super() unless type(logging.handlers.SysLogHandler) - # is 'type' (Python 2.7). - # Use old style calls, if the type is 'classobj' (Python 2.6) - logging.handlers.SysLogHandler.__init__(self, *args, **kwargs) - - def format(self, record): - # Do not use super() unless type(logging.handlers.SysLogHandler) - # is 'type' (Python 2.7). - # Use old style calls, if the type is 'classobj' (Python 2.6) - msg = logging.handlers.SysLogHandler.format(self, record) - msg = self.binary_name + ' ' + msg - return msg - - -def _setup_logging_from_conf(project, version): - log_root = getLogger(None).logger - for handler in log_root.handlers: - log_root.removeHandler(handler) - - logpath = _get_log_file_path() - if logpath: - filelog = logging.handlers.WatchedFileHandler(logpath) - log_root.addHandler(filelog) - - if CONF.use_stderr: - streamlog = ColorHandler() - log_root.addHandler(streamlog) - - elif not logpath: - # pass sys.stdout as a positional argument - # python2.6 calls the argument strm, in 2.7 it's stream - streamlog = logging.StreamHandler(sys.stdout) - log_root.addHandler(streamlog) - - if CONF.publish_errors: - handler = importutils.import_object( - "oslo.messaging.notify.log_handler.PublishErrorsHandler", - logging.ERROR) - log_root.addHandler(handler) - - datefmt = CONF.log_date_format - for handler in log_root.handlers: - # NOTE(alaski): CONF.log_format overrides everything currently. This - # should be deprecated in favor of context aware formatting. - if CONF.log_format: - handler.setFormatter(logging.Formatter(fmt=CONF.log_format, - datefmt=datefmt)) - log_root.info('Deprecated: log_format is now deprecated and will ' - 'be removed in the next release') - else: - handler.setFormatter(ContextFormatter(project=project, - version=version, - datefmt=datefmt)) - - if CONF.debug: - log_root.setLevel(logging.DEBUG) - elif CONF.verbose: - log_root.setLevel(logging.INFO) - else: - log_root.setLevel(logging.WARNING) - - for pair in CONF.default_log_levels: - mod, _sep, level_name = pair.partition('=') - logger = logging.getLogger(mod) - # NOTE(AAzza) in python2.6 Logger.setLevel doesn't convert string name - # to integer code. - if sys.version_info < (2, 7): - level = logging.getLevelName(level_name) - logger.setLevel(level) - else: - logger.setLevel(level_name) - - if CONF.use_syslog: - try: - facility = _find_facility_from_conf() - # TODO(bogdando) use the format provided by RFCSysLogHandler - # after existing syslog format deprecation in J - if CONF.use_syslog_rfc_format: - syslog = RFCSysLogHandler(address='/dev/log', - facility=facility) - else: - syslog = logging.handlers.SysLogHandler(address='/dev/log', - facility=facility) - log_root.addHandler(syslog) - except socket.error: - log_root.error('Unable to add syslog handler. Verify that syslog ' - 'is running.') - - -_loggers = {} - - -def getLogger(name='unknown', version='unknown'): - if name not in _loggers: - _loggers[name] = ContextAdapter(logging.getLogger(name), - name, - version) - return _loggers[name] - - -def getLazyLogger(name='unknown', version='unknown'): - """Returns lazy logger. - - Creates a pass-through logger that does not create the real logger - until it is really needed and delegates all calls to the real logger - once it is created. - """ - return LazyAdapter(name, version) - - -class WritableLogger(object): - """A thin wrapper that responds to `write` and logs.""" - - def __init__(self, logger, level=logging.INFO): - self.logger = logger - self.level = level - - def write(self, msg): - self.logger.log(self.level, msg.rstrip()) - - -class ContextFormatter(logging.Formatter): - """A context.RequestContext aware formatter configured through flags. - - The flags used to set format strings are: logging_context_format_string - and logging_default_format_string. You can also specify - logging_debug_format_suffix to append extra formatting if the log level is - debug. - - For information about what variables are available for the formatter see: - http://docs.python.org/library/logging.html#formatter - - If available, uses the context value stored in TLS - local.store.context - - """ - - def __init__(self, *args, **kwargs): - """Initialize ContextFormatter instance - - Takes additional keyword arguments which can be used in the message - format string. - - :keyword project: project name - :type project: string - :keyword version: project version - :type version: string - - """ - - self.project = kwargs.pop('project', 'unknown') - self.version = kwargs.pop('version', 'unknown') - - logging.Formatter.__init__(self, *args, **kwargs) - - def format(self, record): - """Uses contextstring if request_id is set, otherwise default.""" - - # NOTE(jecarey): If msg is not unicode, coerce it into unicode - # before it can get to the python logging and - # possibly cause string encoding trouble - if not isinstance(record.msg, six.text_type): - record.msg = six.text_type(record.msg) - - # store project info - record.project = self.project - record.version = self.version - - # store request info - context = getattr(local.store, 'context', None) - if context: - d = _dictify_context(context) - for k, v in d.items(): - setattr(record, k, v) - - # NOTE(sdague): default the fancier formatting params - # to an empty string so we don't throw an exception if - # they get used - for key in ('instance', 'color', 'user_identity'): - if key not in record.__dict__: - record.__dict__[key] = '' - - if record.__dict__.get('request_id'): - fmt = CONF.logging_context_format_string - else: - fmt = CONF.logging_default_format_string - - if (record.levelno == logging.DEBUG and - CONF.logging_debug_format_suffix): - fmt += " " + CONF.logging_debug_format_suffix - - if sys.version_info < (3, 2): - self._fmt = fmt - else: - self._style = logging.PercentStyle(fmt) - self._fmt = self._style._fmt - # Cache this on the record, Logger will respect our formatted copy - if record.exc_info: - record.exc_text = self.formatException(record.exc_info, record) - return logging.Formatter.format(self, record) - - def formatException(self, exc_info, record=None): - """Format exception output with CONF.logging_exception_prefix.""" - if not record: - return logging.Formatter.formatException(self, exc_info) - - stringbuffer = moves.StringIO() - traceback.print_exception(exc_info[0], exc_info[1], exc_info[2], - None, stringbuffer) - lines = stringbuffer.getvalue().split('\n') - stringbuffer.close() - - if CONF.logging_exception_prefix.find('%(asctime)') != -1: - record.asctime = self.formatTime(record, self.datefmt) - - formatted_lines = [] - for line in lines: - pl = CONF.logging_exception_prefix % record.__dict__ - fl = '%s%s' % (pl, line) - formatted_lines.append(fl) - return '\n'.join(formatted_lines) - - -class ColorHandler(logging.StreamHandler): - LEVEL_COLORS = { - logging.DEBUG: '\033[00;32m', # GREEN - logging.INFO: '\033[00;36m', # CYAN - logging.AUDIT: '\033[01;36m', # BOLD CYAN - logging.WARN: '\033[01;33m', # BOLD YELLOW - logging.ERROR: '\033[01;31m', # BOLD RED - logging.CRITICAL: '\033[01;31m', # BOLD RED - } - - def format(self, record): - record.color = self.LEVEL_COLORS[record.levelno] - return logging.StreamHandler.format(self, record) - - -class DeprecatedConfig(Exception): - message = _("Fatal call to deprecated config: %(msg)s") - - def __init__(self, msg): - super(Exception, self).__init__(self.message % dict(msg=msg)) diff --git a/magnum/opts.py b/magnum/opts.py index 0ca040dd7e..550465efce 100644 --- a/magnum/opts.py +++ b/magnum/opts.py @@ -15,6 +15,8 @@ import itertools +from oslo_log import log + import magnum.api.app import magnum.api.auth import magnum.common.clients @@ -26,7 +28,6 @@ import magnum.conductor.handlers.docker_conductor import magnum.conductor.template_definition import magnum.db.sqlalchemy.models import magnum.openstack.common.eventlet_backdoor -import magnum.openstack.common.log import magnum.openstack.common.periodic_task @@ -39,10 +40,10 @@ def list_opts(): magnum.common.utils.UTILS_OPTS, (magnum.openstack.common.eventlet_backdoor .eventlet_backdoor_opts), - magnum.openstack.common.log.generic_log_opts, - magnum.openstack.common.log.log_opts, - magnum.openstack.common.log.common_cli_opts, - magnum.openstack.common.log.logging_cli_opts, + log.generic_log_opts, + log.log_opts, + log.common_cli_opts, + log.logging_cli_opts, magnum.openstack.common.periodic_task.periodic_opts, )), ('api', magnum.api.app.API_SERVICE_OPTS), diff --git a/magnum/tests/base.py b/magnum/tests/base.py index 690a87316e..9146285b82 100644 --- a/magnum/tests/base.py +++ b/magnum/tests/base.py @@ -20,6 +20,7 @@ import os import mock from oslo_config import cfg +from oslo_log import log from oslotest import base import pecan from pecan import testing @@ -31,6 +32,7 @@ from magnum.tests import conf_fixture CONF = cfg.CONF +log.register_options(CONF) CONF.set_override('use_stderr', False) diff --git a/magnum/tests/conf_fixture.py b/magnum/tests/conf_fixture.py index 9d7f0b1066..10e52c4fce 100644 --- a/magnum/tests/conf_fixture.py +++ b/magnum/tests/conf_fixture.py @@ -16,10 +16,12 @@ import fixtures from oslo_config import cfg +from oslo_log import log from magnum.common import config cfg.CONF.register_opt(cfg.StrOpt('host', default='localhost', help='host')) +log.register_options(cfg.CONF) class ConfFixture(fixtures.Fixture): diff --git a/requirements.txt b/requirements.txt index e0134bc652..f9a48103e1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -24,6 +24,7 @@ oslo.config>=1.11.0 # Apache-2.0 oslo.context>=0.2.0 # Apache-2.0 oslo.db>=1.7.0 # Apache-2.0 oslo.i18n>=1.5.0 # Apache-2.0 +oslo.log>=1.0.0 # Apache-2.0 oslo.messaging>=1.8.0 # Apache-2.0 oslo.serialization>=1.4.0 # Apache-2.0 oslo.utils>=1.4.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 830421b9db..fe7bca133f 100644 --- a/tox.ini +++ b/tox.ini @@ -41,6 +41,7 @@ commands = --namespace magnum \ --namespace oslo.concurrency \ --namespace oslo.db \ + --namespace oslo.log \ --namespace oslo.messaging \ --namespace keystonemiddleware.auth_token