exporters.notifications package

Submodules

exporters.notifications.base_notifier module

class exporters.notifications.base_notifier.BaseNotifier(options, metadata, *args, **kwargs)

Bases: exporters.pipeline.base_pipeline_item.BasePipelineItem

This module takes care of notifications delivery. It has a slightly different architecture than the others due to the support of multiple notification endpoints to be loaded at the same time. As you can see in the provided example, the notifications parameter is an array of notification objects. To extend and add notification endpoints, they can implement the following methods:

get_all_metadata(module='notifier')

get_metadata(key, module='notifier')

notify_complete_dump(receivers=None)

Notifies the end of a dump to the receivers

notify_failed_job(mgs, stack_trace, receivers=None)

Notifies the failure of a dump to the receivers

notify_start_dump(receivers=None)

Notifies the start of a dump to the receivers

set_metadata(key, value, module='notifier')

supported_options = {}

update_metadata(data, module='notifier')

exporters.notifications.notifiers_list module

class exporters.notifications.notifiers_list.NotifiersList(options, metadata)

Bases: object

This class is only used to support a list of notifications modules.

notify_complete_dump(receivers=None)

notify_failed_job(msg, stack_strace, receivers=None)

notify_start_dump(receivers=None)

exporters.notifications.receiver_groups module

exporters.notifications.s3_mail_notifier module

exporters.notifications.webhook_notifier module

class exporters.notifications.webhook_notifier.WebhookNotifier(*args, **kwargs)

Bases: exporters.notifications.base_notifier.BaseNotifier

Performs a POST request to provided endpoints

• endpoints (list)

  Endpoints waiting for a start notification

notify_complete_dump(receivers=None, info=None)

notify_failed_job(msg, stack_trace, receivers=None, info=None)

notify_start_dump(receivers=None, info=None)

supported_options = {'endpoints': {'default': [], 'type': <class 'exporters.utils.list[unicode]'>}}

Module contents