Skip to main content

Log Event Header Fields

Abstract

Describes the standard fields in the header section of the JSON for every log event stored in the AWS S3 bucket using Log Streaming.

Every logged event has a standard set of JSON fields called a 'Header.' The description of the header's fields is shown in the table below.

Table 2. JSON Header Standard Fields for Log Events

Field Name

Type

Description

CloudConnexaLogVersion

Integer

The version of log event definitions and format.

category

String

The event category.

eventName

String

The type of log event. Specific information about the event will be in a JSON object called log.

timestamp

DateTime

The timestamp of when the event occurred.

cloudId

String

The Cloud ID that identifies the WPC.

service

String

A fixed value with the name of the service - “CloudConnexa"

traceId

String

A unique identifier for an event.

publicIp

String

The IP address of the entity that initiated the event.

Note

The publicIp field above will be deprecated in early 2025 and replaced with the initiatorPublicIp field below.

initiatorPublicIp

String

The IP address of the entity that initiated the event.

initiatorType

String

The entity type that initiated the event. The value can be one of User, Device, or Connector.

initiator

String

A unique identifier for the specific entity that initiated the event. More details about the initiator can be found using the API with the values of this field and the initiatorType field.

initiatorName

String

The name of the Event initiator.

parentEntityType

String

The parent entity type of the initiator The value can be one of User, UserGroup, or NetworkOrHost.

parentEntity

String

A unique identifier for the parent of the specific entity that initiated the event. More details about the parent entity can be found using the API with the values of this field and the parentEntityType field.

parentEntityName

String

The name of the parent of the initiator.

userAgent

String

The HTTP UserAgent field from the request.

Note

The userAgent field above will be deprecated in early 2025 and replaced with the initiatorClientAgent field below.

initiatorClientAgent

String

The HTTP UserAgent field from the request.



In this section: