summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Nemec <bnemec@redhat.com>2019-06-13 18:18:54 +0000
committerBen Nemec <bnemec@redhat.com>2019-06-26 14:20:12 +0000
commite7a680e4d0542d21cc4272501f95572f8cd6c01e (patch)
treead55bbfeea968245e95cab3c5b6ddbe518922ddc
parent791c3612b3e15cf23fb42873989ceeedc99fdd34 (diff)
downloadoslo-log-e7a680e4d0542d21cc4272501f95572f8cd6c01e.tar.gz
Remove incubator migration docs
Incubator logging has been gone for years. Nobody still needs these docs, and on the off chance that I'm wrong they're still available in git. Change-Id: I4757f93c4194bd821232a2f6cc9abf3be00f15d0
-rw-r--r--doc/source/user/index.rst1
-rw-r--r--doc/source/user/migration.rst119
2 files changed, 0 insertions, 120 deletions
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
index 5e0f2aa..46be8d9 100644
--- a/doc/source/user/index.rst
+++ b/doc/source/user/index.rst
@@ -10,5 +10,4 @@
usage
examples
guidelines
- migration
history
diff --git a/doc/source/user/migration.rst b/doc/source/user/migration.rst
deleted file mode 100644
index 4bd77c8..0000000
--- a/doc/source/user/migration.rst
+++ /dev/null
@@ -1,119 +0,0 @@
-Migrating from Oslo Incubator to oslo.log
-=========================================
-
-Applications using the incubated version of the logging code from Oslo
-may need to make some extra changes.
-
-What do I import?
------------------
-
-Our goal is to allow most libraries to import the Python standard
-library module, ``logging``, and not require ``oslo.log``
-directly. Applications may do the same, but if an application takes
-advantage of features like passing keywords through to the context for
-logging, it is likely to be less confusing to use ``oslo.log``
-everywhere, rather than have different types of loggers in different
-modules of the application.
-
-No more ``audit()``
--------------------
-
-The ``audit()`` method of the old ``ContextAdapter`` class no longer
-exists. We agreed in the `cross project spec`_ to stop using audit
-level anyway, so those calls should be replaced with calls to
-``info()``.
-
-.. _cross project spec: https://opendev.org/openstack/openstack-specs/src/branch/master/specs/log-guidelines.rst
-
-Deprecation tools moved to ``versionutils``
--------------------------------------------
-
-The :meth:`deprecated` decorator and :class:`DeprecatedConfig` have
-moved to :mod:`oslo_log.versionutils`. Replace ``LOG.deprecated()``
-with :mod:`oslo_log.versionutils.report_deprecated_feature`, passing a
-local logger object as the first argument so the log message includes
-the location information.
-
-No more implicit conversion to unicode/str
-------------------------------------------
-
-The old :class:`ContextAdapter` used to convert anything given to it
-to a :class:`unicode` object before passing it to lower layers of the
-logging code. The new logging configuration uses a formatter instead
-of an adapter, so this conversion is no longer possible. All message
-format strings therefore need to be passed as unicode objects --
-that's strictly :class:`unicode`, not :class:`str`. If a message has
-no interpolation for extra parameters, a byte string can be used.
-
-The most common place to encounter this is where :meth:`Logger.error`
-is used by passing an exception object as the first argument.
-
-::
-
- # Old style
- try:
- do_something()
- except Exception as err:
- LOG.error(err)
-
-Now, the error should be converted to unicode either by calling
-:func:`six.text_type` or by using a unicode formatting string to
-provide context. It's even better to replace the redundant message
-produced by passing the exception with a useful message.
-
-::
-
- # New style, preferred approach
- from myapp._i18n import _LE # see oslo.i18n
- try:
- do_something()
- except Exception as err:
- LOG.exception(_LE(u"do_something couldn't do something"))
-
- # New style, with exception
- from myapp._i18n import _LE # see oslo.i18n
- try:
- do_something()
- except Exception as err:
- LOG.error(_LE(u"do_something couldn't do something: %s"), err)
-
- # New style, alternate without context
- import six
- try:
- do_something()
- except Exception as err:
- LOG.error(six.text_type(err))
-
-Failure to do this for exceptions or other objects containing
-translatable strings from ``oslo.i18n`` results in an exception when
-the :class:`_Message` instance is combined in unsupported ways with
-the default formatting string inside the :mod:`logging` module in the
-standard library.
-
-Changes to App Initialization
------------------------------
-
-The logging options are no longer registered on the global
-configuration object defined in ``oslo.config``, and need to be
-registered explicitly on the configuration object being used by the
-application. Do this by calling :func:`~oslo_log.log.register_options`
-before parsing command line options.
-
-The same configuration option passed to
-:func:`~oslo_log.log.register_options` should also be passed as the
-first argument to :func:`~oslo_log.log.setup`.
-
-See :ref:`usage-app` for more details about application setup.
-
-Passing Context
----------------
-
-Applications are expected to be using
-:class:`oslo_context.context.RequestContext` as the base class for
-their application-specific context classes. The base class manages a
-thread-local storage for the "current" context object so that
-``oslo.log`` can retrieve it without having the value passed in
-explicitly. This ensures that all log messages include the same
-context information, such as the request id and user
-identification. See the ``oslo.context`` documentation for details of
-using the class.