View the Logbook

IREX Admin has a Logbook command available in the main menu. Click it to access the consolidated system event log.

Being responsible and accountable

View system event details

To view a system event in full detail, click as shown ...

...  -  the event detail sidebar opens to show who did what, when and how.

Find a Case ID-based event

To find entries in the logbook about user actions made based on a Case ID, type this Case ID as shown and click Search.

Filter system events

Use the Users, Date and Time, and Event types to filter system events to show/hide.

To target the search even better, click Additional filters, then use the search options offered on the Additional filters screen to find entries in the logbook relevant, e.g., to a camera (in Cameras under Video surveillance), a building (in Buildings and plans under Location), etc.

Actions performed inside the Logbook are themselves recorded, so searches of the log leave their own audit trail. When a user runs a search in the Logbook, the platform writes a "Search in logbook" entry that captures the standard details — who ran the search and when.

To review these entries, select "Search in logbook" in the Event types filter, then Search.

Search by played-back video date and time

For Live video loaded and Archived video loaded entries, the Logbook records the start and end of the played-back interval. An entry is written when playback ends, or every three hours during a long session.

To find entries for a playback interval:

1. On the Logbook page, open Additional filters.
2. Open the Player tab.
3. Set Played back video date/time to the start and end of the interval, then click Apply.

   

4. Click Search on the Logbook page.

The results include entries whose playback interval intersects the filter range (including matching interval boundaries).

For example, if the filter range is 10:00–10:30, the results include playbacks that intersect it:

• 09:50–10:40 — playback started before and ended after the filter range;
• 10:05–10:20 — playback entirely inside the filter range;
• 09:50–10:10 — playback started before the filter range and ended inside it;
• 10:20–10:40 — playback started inside the filter range and ended after it;
• 10:30–10:45 — playback started at the end of the filter range.

Playbacks that do not intersect the filter range (for example, 09:00–09:59) are not included.

Search by person photo or descriptor

In Additional filters, on the Persons tab, upload a photo or descriptor file to find Logbook entries for actions in the system that used a similar photo or descriptor.

1. On the Logbook page, open Additional filters.
2. Open the Persons tab.
3. In the Photo or descriptor file used form, upload a photo file (JPEG, PNG) or a descriptor file (JSON).

   

4. After the file is uploaded, set Similarity and click Apply.

   Similarity defines the similarity range between a face on the photo (descriptor) and a face in the Logbook entry.

   The Similarity scale is unavailable until a photo or descriptor file is uploaded.

5. Click Search on the Logbook page.

The Logbook page then shows entries for actions that used a similar photo or descriptor, based on the set similarity.

Generate and download a Logbook report

On the Logbook page, generate a CSV report with the Logbook search results for the selected main and additional filters.

1. Set the search criteria on the Logbook page and click Search.

2. Click the icon and select Compile report.

   The platform starts preparing the report. The Reports window opens with the list of initiated reports; a notification about the start of preparation is shown.

3. Wait until the created report status is Ready, then click the download icon.

   

   The report downloads as an archive with one or more CSV files. If the number of entries exceeds 100,000, several files are created in one archive.

To return to previously prepared reports, click the icon and select Report list. The Reports window opens with the list of reports initiated by the current user. For each report, its name and status are shown:

• Ready: the report is prepared and ready to download; click the download icon next to the status.
• In progress: the report is being generated.
• Error: an error occurred while generating the report; to retry, select Retry.

Downloading a report adds a Logbook entry with the event type Logbook report downloaded.

Automatic Logbook export

Automatic Logbook export regularly provides information about user actions in the system for access control and transfer to external monitoring systems.

Automatic export is not configured in the product UI. When export is required, its parameters are set in the cluster configuration. The configuration includes the following:

• User: the user who can access the export files.
• User group: the file includes entries for actions by users in the selected group and its subgroups.
• Frequency: the export run interval (minimum: 10 minutes). Only Logbook entries from that interval are included; already exported entries are not included again. Example: with a frequency of 10 minutes, every 10 minutes a file is created with only the entries from those 10 minutes. If there are no entries in the interval, no file is created.
• Event types: which Logbook entries to include in the file — all entries or only selected types.
• Retention period: how long the file is kept in storage after export. The file is kept from 1 to 30 days.

Export data is saved as JSON files. The files are placed in cluster storage; external systems retrieve them on their own. Each export run creates one file, not an archive. The file contains an array of objects. Each object corresponds to one Logbook entry.

Sample export file

[
  {
    "event_time": "2026-05-26 08:26:17.899000000",
    "type": "AUDIT_SEARCH_PERFORMED",
    "actor_email": "[email protected]",
    "actor_id": 1,
    "actor_first_name": "UNKNOWN_NAME",
    "actor_last_name": "UNKNOWN_NAME",
    "actor_ip": "10.0.0.1",
    "actor_security_groups": ["101"],
    "resource_id": "-",
    "resource_type": "LOGBOOK",
    "resource_name": "-",
    "params": {
      "search_domain": "PERSONS",
      "date_from": "2026-05-26T00:00:00",
      "date_to": "2026-05-26T23:59:59",
      "channel_ids": [42, 57]
    },
    "images": [
      {
        "data": "base64-or-descriptor-data",
        "image_link": null,
        "alg_type": 2,
        "major_version": 20200706,
        "minor_version": 1,
        "quality": null
      }
    ]
  }
]

Parameter values in the export file