openstack
/
castellan
Code Issues Proposed changes

Merge "Add some documentation on enabling logging"

This commit is contained in:
Jenkins 2015-12-01 19:28:12 +00:00 committed by Gerrit Code Review
parent 318d212e34 96df616023
commit f1df6f4a29
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/usage.rst
View File

@ -1,6 +1,6 @@
========
=====
Usage
========
=====
This document describes some of the common usage patterns for Castellan. When
incorporating this package into your applications, care should be taken to
@ -164,6 +164,24 @@ configuration.**
options.set_defaults(cfg.CONF, api_class='some.other.KeyManager')
manager = key_manager.API()
Logging from within Castellan
-----------------------------
Castellan uses ``oslo_log`` for logging. Log information will be generated
if your application has configured the ``oslo_log`` module. If your
application does not use ``oslo_log`` then you can enable default logging
using ``enable_logging`` in the ``castellan.options`` module.
**Example. Enabling default logging.**
.. code:: python
from castellan import options
from castellan import key_manager
options.enable_logging()
manager = key_manager.API()
Generating sample configuration files
-------------------------------------