oops_dictconfig 0.0.1

Dependencies

• python-oops (http://pypi.python.org/pypi/oops)

Also the following dependencies are required depending on the configs you will use:

• python-oops-datedir-repo (http://pypi.python.org/pypi/oops_datedir_repo)

• python-oops-amqp (http://pypi.python.org/pypi/oops_datedir_repo)

For testing all of the above are needed, along with:

• python-testtools

Use

To use run:

from oops_dictconfig import config_from_dict

oops_config = config_from_dict(dict_config)

where dict_config is a dict describing the oops.Config that is wanted.

The empty dict is valid, and will get you an oops.Config with no publishers, however, you will usually want at least one publisher.

To do that have a publishers key in dict_config whose value is a list of dicts. Each of those dicts will add a publisher to the oops.Config.

There is one mandatory key for all publisher types:

• type: the type of publisher, currently “datedir” and “amqp” are

  supported.

All publishers support the following optional key:

• new_only: if this is True then the publisher will be wrapped in

  oops.publish_only_new, meaning that the oops will only be sent to this publisher if no previous publisher in the chain published it.

Each publisher type also has further options detailed below.

Examples

The following would create a DateDirRepo as the only publisher:

{
    'publishers': [
        {
            'type': 'datedir',
            'error_dir': '/var/log/oopses/',
            'instance_id': 'theinstance',
        },
    ],
}

The following is a simple config for an AMQP publisher:

{
    'publishers': [
        {
            'type': 'amqp',
            'host': 'amqp.example.com:5302',
            'user': 'oopsuser',
            'password': 'oopspassword',
            'vhost': 'oopses',
            'exchange_name': 'oopses',
            'routing_key': 'oopses',
        },
    ],
}

The following is an example that publishes to AMQP with a fallback to DateDirRepo if AMQP is not availble:

{
    'publishers': [
        {
            'type': 'amqp',
            'host': 'amqp.example.com:5302',
            'user': 'oopsuser',
            'password': 'oopspassword',
            'vhost': 'oopses',
            'exchange_name': 'oopses',
            'routing_key': 'oopses',
        },
        {
            'type': 'datedir',
            'error_dir': '/var/log/oopses/',
            'instance_id': 'theinstance',
            'new_only': True,
        },
    ],
}

configglue

If you are using configglue to manage your configuration an Option subclass is supplied that can be used in your schema as appropriate:

from configglue import schema
from oops_dictconfig.configglue import OopsOption

class MySchema(schema.Schema):

    oopses = OopsOption()

Once that is defined you can produce the config described above using your configglue config file:

oopses = oopses_config

[oopses_config]
publishers = amqp_publisher
             datedir_publisher

[amqp_publisher]
type = amqp
host = amqp.example.com:6832
user = oopsuser
password = oopspassword
vhost = oopses
exchange_name = oopses
routing_key = oopses

[datedir_publisher]
type = datedir
error_dir = /var/log/oopses
instance_id = theinstance
only_new = True

Running Tests

Install testrepository and python-subunit and run:

testr init
testr run

or run:

python -m testools.run oops_dictconfig.tests.test_suite

Copyright (c) 2012, Canonical Ltd

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, version 3 only.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. GNU Lesser General Public License version 3 (see the file LICENSE).