The Logger object represents the device and product where events are stored with times for receipt and transmission. This may be at the source device where the event occurred, a remote scanning device, intermediate hops, or the ultimate destination.
- Extends:
_entity
Attributes
Section titled “Attributes”device
- Type:
device - Requirement: recommended
The device where the events are logged.
log_name
- Type:
string_t - Requirement: recommended
The log name for the logging provider log, or the file name of the system log. This may be an intermediate store-and-forward log or a vendor destination log. For example /archive/server1/var/log/messages.0 or /var/log/.
log_provider
- Type:
string_t - Requirement: recommended
The logging provider or logging service that logged the event. This may be an intermediate application store-and-forward log or a vendor destination log.
logged_time
- Type:
timestamp_t - Requirement: recommended
The time when the logging system collected and logged the event.This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.
name
- Type:
string_t - Requirement: recommended
The name of the logging product instance.
product
- Type:
product - Requirement: recommended
The product logging the event. This may be the event source product, a management server product, a scanning product, a SIEM, etc.
transmit_time
- Type:
timestamp_t - Requirement: recommended
The time when the event was transmitted from the logging device to it’s next destination.
uid
- Type:
string_t - Requirement: recommended
The unique identifier of the logging product instance.
event_uid
- Type:
string_t - Requirement: optional
The unique identifier of the event assigned by the logger.
is_truncated
- Type:
boolean_t - Requirement: optional
Indicates whether the OCSF event data has been truncated due to size limitations. When true, some event data may have been omitted to fit within system constraints.
log_format
- Type:
string_t - Requirement: optional
The format of data in the log. For example JSON, syslog or CSV.
log_level
- Type:
string_t - Requirement: optional
The level at which an event was logged. This can be log provider specific. For example the audit level.
log_version
- Type:
string_t - Requirement: optional
The event log schema version of the original event. For example the syslog version or the Cisco Log Schema version
logged_time_dt
- Type:
datetime_t - Requirement: optional
The time when the logging system collected and logged the event.This attribute is distinct from the event time in that event time typically contain the time extracted from the original event. Most of the time, these two times will be different.
transmit_time_dt
- Type:
datetime_t - Requirement: optional
The time when the event was transmitted from the logging device to it’s next destination.
untruncated_size
- Type:
integer_t - Requirement: optional
The original size of the OCSF event data in kilobytes before any truncation occurred. This field is typically populated when is_truncated is true to indicate the full size of the original event.
version
- Type:
string_t - Requirement: optional
The version of the logging provider.
Constraints
Section titled “Constraints”At least one of: name, uid