Add a logging guideline to 'effective neutron'

LOG statements should only receive unicode.

Change-Id: I6a6d9fdbcc3ed9c7eee4889bfa6f328f1bd6d729

diff --git a/doc/source/devref/effective_neutron.rst b/doc/source/devref/effective_neutron.rst
index 98bf8e9fb68138d33016623cf294f793c54d2a61..cae770bb2f871de6c7041e6e6ce41a704a97de9c 100644 (file)
--- a/doc/source/devref/effective_neutron.rst
+++ b/doc/source/devref/effective_neutron.rst
@@ -116,8 +116,12 @@ Translation and logging
 
 Document common pitfalls as well as good practices done when instrumenting your code.
 
- * Make yourself familiar with `OpenStack logging guidelines <http://specs.openstack.org/openstack/openstack-specs/specs/log-guidelines.html#definition-of-log-levels>`_
-   to avoid littering the logs with traces logged at inappropriate levels.
+* Make yourself familiar with `OpenStack logging guidelines <http://specs.openstack.org/openstack/openstack-specs/specs/log-guidelines.html#definition-of-log-levels>`_
+  to avoid littering the logs with traces logged at inappropriate levels.
+* The logger should only be passed unicode values. For example, do not pass it
+  exceptions or other objects directly (LOG.error(exc), LOG.error(port), etc.).
+  See http://docs.openstack.org/developer/oslo.log/usage.html#no-more-implicit-conversion-to-unicode-str
+  for more details.
 
 Project interfaces
 ~~~~~~~~~~~~~~~~~~