Package foolscap :: Package logging :: Module interfaces :: Class IIncidentReporter

Class IIncidentReporter

zope.interface.Interface --+
                           |
                          IIncidentReporter

Instance Methods

[hide private]

incident_declared(triggering_event)
This is called when an Incident needs to be recorded.

source code

new_trigger(triggering_event)
This is called when a triggering event occurs while an incident is already being reported.

source code

is_active()
Returns True if the reporter is still running.

source code

Class Variables

[hide private]

_InterfaceClass__attrs = {'incident_declared': <zope.interface...

__bases__ = (<InterfaceClass zope.interface.Interface>)

__identifier__ = 'foolscap.logging.interfaces.IIncidentReporter'

__iro__ = (<InterfaceClass foolscap.logging.interfaces.IIncide...

__name__ = 'IIncidentReporter'

__sro__ = (<InterfaceClass foolscap.logging.interfaces.IIncide...

_implied = {<InterfaceClass foolscap.logging.interfaces.IIncid...

dependents = <WeakKeyDictionary at 141580108>

Inherited from zope.interface.Interface (private): _Element__tagged_values

Method Details

[hide private]

new_trigger(triggering_event)

source code

This is called when a triggering event occurs while an incident is already being reported. If the event happened later, it would trigger a new incident. Since it overlapped with the existing incident, it will just be added to that incident.

The triggering event will also be reported through the usual event-publish-subscribe mechanism. This method is provided to give the reporter the opportunity to mark the event somehow, for the benefit of incident-file analysis tools.

is_active()

source code

Returns True if the reporter is still running. While in this state, new Incident triggers will be passed to the existing reporter instead of causing a new Incident to be declared. This will tend to coalesce back-to-back problems into a single Incident.

Class Variable Details

[hide private]

_InterfaceClass__attrs

Value:

{'incident_declared': <zope.interface.interface.Method object at 0x870
57ec>,
 'is_active': <zope.interface.interface.Method object at 0x87057ac>,
 'new_trigger': <zope.interface.interface.Method object at 0x87057cc>}

iro

Value:

(<InterfaceClass foolscap.logging.interfaces.IIncidentReporter>,
 <InterfaceClass zope.interface.Interface>)

sro

Value:

(<InterfaceClass foolscap.logging.interfaces.IIncidentReporter>,
 <InterfaceClass zope.interface.Interface>)

_implied

Value:

{<InterfaceClass foolscap.logging.interfaces.IIncidentReporter>: (),
 <InterfaceClass zope.interface.Interface>: ()}