Event Log¶

The client records an event log of resolutions, mutations, and notices that happen in-between requests for complex queries and multi-step operations. Typically, such events are things like CNAME and PTR resolution that happen when resolving Host or host records.

Accessing the event log¶

The event log is accessible via the client.events property, which returns an EventLog instance. The size of the log is controlled by the event_log_size argument to MregClient.

client = MregClient(...)
events = client.events.get()

Filtering by event kind¶

Each event is categorized by kind (EventKind). You can filter the event log by kind using the get method with the kind argument:

from mreg_api.events import EventKind

client.events.get(kind=EventKind.RESOLUTION)
client.events.get(kind=EventKind.MUTATION)
client.events.get(kind=EventKind.NOTICE)

Filtering by event level¶

Each event is also categorized by level (EventLevel). You can filter the event log by level using the get method with the level argument:

from mreg_api.events import EventLevel

client.events.get(level=EventLevel.DEBUG)
client.events.get(level=EventLevel.INFO)
client.events.get(level=EventLevel.WARNING)
client.events.get(level=EventLevel.ERROR)
client.events.get(level=EventLevel.CRITICAL)

The min_level argument can be used to retrieve events at or above a certain severity level instead of exactly matching a level:

client.events.get(min_level=EventLevel.WARNING)

Advanced filtering¶

More advanced filtering can be done using the where argument, which takes a callable that receives an Event instance and returns a boolean indicating whether to include the event in the results.

For example, to get all error events that are not resolution events, you can do:

client.events.get(
    level=EventLevel.ERROR,
    where=lambda e: e.kind != EventKind.RESOLUTION,
)

This can also be achieved by supplying a more complex callable to the where argument, performing all filtering in the predicate function itself:

client.events.get(
    where=lambda e: e.subject == "example.com" and e.level >= EventLevel.WARNING
)