Structured logging on UCS

4.3. Structured logging on UCS#

Added in version 4.0.0.

The OX Connector app emits log messages in a structured format that follows the Nubus platform logging standard. Each log line contains a fixed set of fields followed by key-value pairs with context-specific data, as shown in Listing 4.13.

Listing 4.13 Structured log line format#
<timestamp> <severity:8> [<request ID>] <message>\t| <key=value ...> <source>

The fields have the following meanings:

timestamp

The timestamp is ISO 8601-formatted and includes sub-second precision and the time zone, for example 2024-06-01T12:00:00.123456+00:00.

severity

The log level field has a width of 8 characters, for example INFO or WARNING. OX_CONNECTOR_LOG_LEVEL controls this value.

request ID

The request ID is the sequence number of the provisioning message. It groups all log lines that belong to a single provisioning job. A dash (-) indicates that no job is active.

message

The message is the human-readable description of the event.

key=value pairs

The structured application data uses the logfmt format, for example dn="uid=user01,dc=example,dc=com" object_type=users ms=42.

source

The source is the Python module name that produced the log entry.

See also

Logging

in Nubus Manual 1.x [6] for information about the Nubus structured logging format, available log levels, and integration with log management systems.