glance/doc/source/notifications.rst
Alex Meade e2f9d15e4c Add notifications for sending an image
An image.send notification is to be sent to the notifier every time an image is
transmitted from glance. This can be used to track things such as bandwidth
usage.

Addresses bug 914440

Change-Id: If8b6504c4250fa6444d17d611de43d9704ca9aae
2012-01-10 19:47:22 +00:00

2.3 KiB

Notifications

Notifications can be generated for each send, upload, update or delete image event. These can be used for auditing, troubleshooting, etc.

Strategies

  • logging

    This strategy uses the standard Python logging infrastructure with the notifications ending up in file specificed by the log_file configuration directive.

  • rabbit

    This strategy sends notifications to a rabbitmq queue. This can then be processed by other services or applications.

  • noop

    This strategy produces no notifications. It is the default strategy.

Content

Every message contains a handful of attributes.

  • message_id

    UUID identifying the message.

  • publisher_id

    The hostname of the glance instance that generated the message.

  • event_type

    Event that generated the message.

  • priority

    One of WARN, INFO or ERROR.

  • timestamp

    UTC timestamp of when event was generated.

  • payload

    Data specific to the event type.

Payload

  • image.send

    The payload for INFO, WARN, and ERROR events contain the following:

    image_id - ID of the image (UUID) owner_id - Tenant or User ID that owns this image (string) receiver_tenant_id - Tenant ID of the account receiving the image (string) receiver_user_id - User ID of the account receiving the image (string) destination_ip bytes_sent - The number of bytes actually sent

  • image.upload

    For INFO events, it is the image metadata. WARN and ERROR events contain a text message in the payload.

  • image.update

    For INFO events, it is the image metadata. WARN and ERROR events contain a text message in the payload.

  • image.delete

    For INFO events, it is the image id. WARN and ERROR events contain a text message in the payload.