Skip to content

Basic

The exporters allow you to export the event audit logs to a different file format.

The following exporters are available:

  1. CSV Exporter: Exports the event audit logs to a CSV file.
  2. JSON Exporter: Exports the event audit logs to a JSON file.
  3. TSV Exporter: Exports the event audit logs to a TSV file.
  4. XLSX Exporter: Exports the event audit logs to an XLSX file.

Each exporter has its own configuration options. The configuration options are described in the respective exporter's documentation section.

Base exporter class

Base class for all exporters.

Exporters are used to export a lsit of events to a specific file format.

export(events) abstractmethod

Export events to a specific format.

We are not providing a specific return type, because it will depend on the specific exporter implementation.

PARAMETER DESCRIPTION
events

events to export

TYPE: Iterable[Event]

RETURNS DESCRIPTION
Any

exported data.

TYPE: Any

from_filters(filters, repo_name=None)

Export events from a repo using the given filters.

If repo_name is not provided, the active repo is used.

PARAMETER DESCRIPTION
filters

search filters.

TYPE: Filters

repo_name

name of the repo to use. Defaults to None.

TYPE: str | None DEFAULT: None

RETURNS DESCRIPTION
Any

exported data.

TYPE: Any