This Page

Psst... hey. You're reading the latest content, but it might be out of sync with code. You can read Nova 2011.2 docs or all OpenStack docs too.

The nova.notifier.api Module

exception nova.notifier.api.BadPriorityException

Bases: exceptions.Exception

nova.notifier.api.notify(publisher_id, event_type, priority, payload)

Sends a notification using the specified driver

Notify parameters:

publisher_id - the source worker_type.host of the message event_type - the literal type of event (ex. Instance Creation) priority - patterned after the enumeration of Python logging levels in

the set (DEBUG, WARN, INFO, ERROR, CRITICAL)

payload - A python dictionary of attributes

Outgoing message format includes the above parameters, and appends the following:

message_id - a UUID representing the id for this notification timestamp - the GMT timestamp the notification was sent at

The composite message will be constructed as a dictionary of the above attributes, which will then be sent via the transport mechanism defined by the driver.

Message example:

{‘message_id’: str(uuid.uuid4()),
‘publisher_id’: ‘compute.host1’, ‘timestamp’: utils.utcnow(), ‘priority’: ‘WARN’, ‘event_type’: ‘compute.create_instance’, ‘payload’: {‘instance_id’: 12, ... }}
nova.notifier.api.notify_decorator(name, fn)

decorator for notify which is used from utils.monkey_patch()

Parameters:
  • name – name of the function
  • function
    • object of the function
Returns:

function – decorated function

nova.notifier.api.publisher_id(service, host=None)