Event logging component
The Event Logging component is an extension component that builds on the ShareAspace event engine to collect and handle events generated within the platform.
The extension uses a defined event message contract and can be configured to subscribe to any event type available in ShareAspace, allowing it to be adapted to different scenarios.
Events received by the extension are:
- written to the Windows Event Log for local access.
- uploaded to ShareAspace at a configurable interval.
Once stored, the event logs can be queried and downloaded using the ShareAspace REST APIs.
For installation instructions, see Event logging component installation.
Using the logging
To use the Event Logging component, it must first be registered by a collection administrator as an External extension of type Nova extension.
Once registered, the extension becomes available when defining event subscriptions. It can be used with both general subscription definitions and personal subscription definitions.
When configuring a subscription, select the EventLogging extension. This
adjusts the event configuration dialog to match the event logger message schema.
The configuration requires the following fields:
- Action
- Context
- Body
The Action and Context values can be freely defined. However, it is
recommended to use the liquid functions
action.name and action.context where applicable.
The Body must include <DATA></DATA> tags. The content within the
tags can be structured as needed.
Example:
- Action: {{action.name}}
- Context: {{action.context}}
- Body: whatever data is required... {{action.target}}
Accessing the logs
Window Event Viewer
The Event Logging component writes entries to a log named Extensions.EventLogging,
located under Applications and Services Logs in the Windows Event Viewer.
Example log entry:
Category: Eurostep.SAS.EventLogging.Internal.DefaultLoggingService
EventId: 0
SpanId: 272a2e83a96cb8ca
TraceId: afc0267274c6fcae9922960e164fc4c7
ParentId: 0acba60d3152a3d9
RequestId: 40000006-0001-eb00-b63f-84710c7967bb
RequestPath: /EventLogging/nova/extension/EventLogging
<action>Part.Update</action>
<creator>john.doe@eurostep.com</creator>
<created>5/19/2026 5:38:57 PM</created>
<issuer>https://esaz143.esxops.com/api</issuer>
<context>ips</context>
<BODY>whatever data is required... 2a01000000000000120103000000</DATA>
ShareAspace logging APIs
The Event Logging component uploads log files to ShareAspace at a configurable interval. These logs can be downloaded or queried using the event log file APIs.
Download all logs
To download all available logs as a ZIP archive:
GET /space/{spaceId}/eventlogFile/download
This endpoint returns a compressed ZIP file containing all stored log files.
Query logs
To query log contents without downloading full files:
GET /space/{spaceId}/eventlogFile/download
This endpoint returns results in JSON Lines (JSONL) format.
The following optional query parameters can be used to filter results:
- from – Start date/time
- to – End date/time
- action – Filter by action name
- creator – Filter by creator
- issuer – Filter by issuer
Authorization
Access to these APIs requires a one-time token.
To request a one-time token, the user must have:
- a valid JWT, or
- a Personal Access Token (PAT)
In addition, the user must have a role with the Manage Space Definition
access modifier to access the eventlogFile resource.
Requesting a one-time token
To obtain a one-time token:
POST /oneTimeToken
Request body example:
{
"route": "/space/{spaceId}/eventlogFile/download",
"method": "GET"
}
The route and method fields must match the API endpoint the token will be used for.