The data model for collected audit event logs from kubernetes or OpenShift api servers.
nolint:govet
| Property | Type | Description |
|---|---|---|
involvedObject |
object |
The object that this event is about. |
reason |
string |
(optional) This should be a short, machine understandable string that gives the reason for the transition into the object's current status. TODO: provide exact specification for format. |
message |
string |
(optional) A human-readable description of the status of this operation. TODO: decide on maximum length. |
source |
object |
(optional) The component reporting this event. Should be a short machine understandable string. |
firstTimestamp |
string |
(optional) The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
lastTimestamp |
string |
(optional) The time at which the most recent occurrence of this event was recorded. |
count |
int |
(optional) The number of times this event has occurred. |
type |
string |
(optional) Type of this event (Normal, Warning), new types could be added in the future |
eventTime |
object |
(optional) Time when this Event was first observed. |
series |
object |
(optional) Data about the Event series this event represents or nil if it's a singleton Event. |
action |
string |
(optional) What action was taken/failed regarding to the Regarding object. |
related |
object |
(optional) Optional secondary object for more complex actions. |
reportingComponent |
string |
(optional) Name of the controller that emitted this Event, e.g. |
reportingInstance |
string |
(optional) ID of the controller instance, e.g. |
@timestamp |
string |
A UTC value that marks when the log payload was created. If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use. format:
|
timestamp |
string |
A UTC value that marks when the log payload was created.
Value derived from legacy
|
message |
string |
(optional) Original log entry text, UTF-8 encoded This field may be absent or empty if a non-empty |
level |
string |
The normalized log level
The logging level from various sources, including
|
hostname |
string |
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as |
pipeline_metadata |
object |
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations |
log_source |
string |
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN |
log_type |
string |
The source type of the log. The
|
viaq_index_name |
string |
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write). The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model. |
viaq_msg_id |
string |
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified. It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218), or some other ASCII value and is used as the |
openshift |
object |
Openshift specific metadata |
| Property | Type | Description |
|---|---|---|
action |
string |
(optional) What action was taken/failed regarding to the Regarding object. |
count |
int |
(optional) The number of times this event has occurred. |
eventTime |
object |
(optional) Time when this Event was first observed. |
firstTimestamp |
string |
(optional) The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
involvedObject |
object |
The object that this event is about. |
lastTimestamp |
string |
(optional) The time at which the most recent occurrence of this event was recorded. |
message |
string |
(optional) A human-readable description of the status of this operation. TODO: decide on maximum length. |
reason |
string |
(optional) This should be a short, machine understandable string that gives the reason for the transition into the object's current status. TODO: provide exact specification for format. |
related |
object |
(optional) Optional secondary object for more complex actions. |
reportingComponent |
string |
(optional) Name of the controller that emitted this Event, e.g. |
reportingInstance |
string |
(optional) ID of the controller instance, e.g. |
series |
object |
(optional) Data about the Event series this event represents or nil if it's a singleton Event. |
source |
object |
(optional) The component reporting this event. Should be a short machine understandable string. |
type |
string |
(optional) Type of this event (Normal, Warning), new types could be added in the future |
(optional) Time when this Event was first observed.
- Type
-
object
| Property | Type | Description |
|---|---|---|
Time |
string |
(optional) The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
- Type
-
string
The object that this event is about.
- Type
-
object
| Property | Type | Description |
|---|---|---|
apiVersion |
string |
(optional) API version of the referent. |
fieldPath |
string |
(optional) If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. |
kind |
string |
(optional) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
name |
string |
(optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
namespace |
string |
(optional) Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
resourceVersion |
string |
(optional) Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
uid |
string |
(optional) UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
(optional) If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.
- Type
-
string
(optional) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Type
-
string
(optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- Type
-
string
(optional) Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
- Type
-
string
(optional) Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- Type
-
string
(optional) UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
- Type
-
string
(optional) The time at which the most recent occurrence of this event was recorded.
- Type
-
string
(optional) A human-readable description of the status of this operation. TODO: decide on maximum length.
- Type
-
string
(optional) This should be a short, machine understandable string that gives the reason for the transition into the object's current status. TODO: provide exact specification for format.
- Type
-
string
(optional) Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.
- Type
-
string
(optional) Data about the Event series this event represents or nil if it's a singleton Event.
- Type
-
object
(optional) The component reporting this event. Should be a short machine understandable string.
- Type
-
object
| Property | Type | Description |
|---|---|---|
component |
string |
(optional) Component from which the event is generated. |
host |
string |
(optional) Node name on which the event is generated. |
(optional) Type of this event (Normal, Warning), new types could be added in the future
- Type
-
string
| Property | Type | Description |
|---|---|---|
@timestamp |
string |
A UTC value that marks when the log payload was created. If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use. format:
|
hostname |
string |
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as |
level |
string |
The normalized log level
The logging level from various sources, including
|
log_source |
string |
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN |
log_type |
string |
The source type of the log. The
|
message |
string |
(optional) Original log entry text, UTF-8 encoded This field may be absent or empty if a non-empty |
openshift |
object |
Openshift specific metadata |
pipeline_metadata |
object |
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations |
timestamp |
string |
A UTC value that marks when the log payload was created.
Value derived from legacy
|
viaq_index_name |
string |
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write). The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model. |
viaq_msg_id |
string |
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified. It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218), or some other ASCII value and is used as the |
A UTC value that marks when the log payload was created.
If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use.
format:
-
yyyy-MM-dd HH:mm:ss,SSSZ
-
yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ
-
yyyy-MM-dd'T'HH:mm:ssZ
-
dateOptionalTime
example: 2024-11-24T14:06:05.071000000Z
- Type
-
string
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as kubernetes.host.
- Type
-
string
The normalized log level
The logging level from various sources, including rsyslog(severitytext property), python's logging module, and others.
The following values come from syslog.h, and are preceded by their numeric equivalents:
-
0=emerg, system is unusable. -
1=alert, action must be taken immediately. -
2=crit, critical conditions. -
3=err, error conditions. -
4=warn, warning conditions. -
5=notice, normal but significant condition. -
6=info, informational. -
7=debug, debug-level messages.
The two following values are not part of syslog.h but are widely used:
-
8=trace, trace-level messages, which are more verbose thandebugmessages. -
9=unknown, when the logging system gets a value it doesn't recognize.
Map the log levels or priorities of other logging systems to their nearest match in the preceding list. For example, from python logging, you can match CRITICAL with crit, ERROR with err, and so on.
- Type
-
string
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN
- Type
-
string
The source type of the log. The log_type field may contain one of these strings, or may have additional dot-separated components, for example "infrastructure.container" or "infrastructure.node".
-
"application": Container logs generated by user applications running in the cluster, except infrastructure containers.
-
"infrastructure": Node logs (such as syslog or journal logs), and container logs from pods in the openshift*, kube*, or default projects.
-
"audit":
-
Node logs from auditd (/var/log/audit/audit.log)
-
Kubernetes and OpenShift apiservers audit logs.
-
OVN audit logs
- Type
-
string
-
(optional) Original log entry text, UTF-8 encoded
This field may be absent or empty if a non-empty structured field is present.
See the description of structured for additional details.
- Type
-
string
Openshift specific metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
cluster_id |
string |
ClusterID is the unique id of the cluster where the workload is deployed |
labels |
object |
(optional) Labels is a set of common, static labels that were spec'd for log forwarding to be sent with the log Records |
sequence |
string |
Sequence is increasing id used in conjunction with the timestamp to establish a linear timeline of log records. This was added as a workaround for logstores that do not have nano-second precision. |
ClusterID is the unique id of the cluster where the workload is deployed
- Type
-
string
(optional) Labels is a set of common, static labels that were spec'd for log forwarding to be sent with the log Records
- Type
-
object
Sequence is increasing id used in conjunction with the timestamp to establish a linear timeline of log records. This was added as a workaround for logstores that do not have nano-second precision.
- Type
-
string
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations
- Type
-
object
| Property | Type | Description |
|---|---|---|
collector |
object |
Collector metadata |
Collector metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
inputname |
string |
(DEPRECATED) |
ipaddr4 |
string |
(optional) Ipaddr4 is the ipV4 address of the collector |
name |
string |
Name is the implementation of the collector agent |
original_raw_message |
string |
OriginalRawMessage captures the original message for eventrouter logs |
received_at |
string |
ReceivedAt the time the collector received the log entry |
version |
string |
Version is collector version information |
(optional) Ipaddr4 is the ipV4 address of the collector
- Type
-
string
OriginalRawMessage captures the original message for eventrouter logs
- Type
-
string
ReceivedAt the time the collector received the log entry
- Type
-
string
A UTC value that marks when the log payload was created.
Value derived from legacy @timestamp for forward compatibility.
format:
-
yyyy-MM-dd HH:mm:ss,SSSZ
-
yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ
-
yyyy-MM-dd'T'HH:mm:ssZ
-
dateOptionalTime
example: 2024-11-24T14:06:05.071000000Z
- Type
-
string
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write).
The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model.
- Type
-
string
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified.
It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218),
or some other ASCII value and is used as the _id of the document when sending to Elasticsearch. The intended use of this field is that if you use another
logging store or application other than Elasticsearch, but you still need to correlate data with the data stored
in Elasticsearch, this field will give you the exact document corresponding to the record.
This is only present when deploying fluentd collector implementations
- Type
-
string
The data model for collected logs from containers.
| Property | Type | Description |
|---|---|---|
@timestamp |
string |
A UTC value that marks when the log payload was created. If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use. format:
|
hostname |
string |
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as |
level |
string |
The normalized log level
The logging level from various sources, including
|
log_source |
string |
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN |
log_type |
string |
The source type of the log. The
|
message |
string |
(optional) Original log entry text, UTF-8 encoded This field may be absent or empty if a non-empty |
openshift |
object |
Openshift specific metadata |
pipeline_metadata |
object |
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations |
timestamp |
string |
A UTC value that marks when the log payload was created.
Value derived from legacy
|
viaq_index_name |
string |
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write). The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model. |
viaq_msg_id |
string |
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified. It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218), or some other ASCII value and is used as the |
docker |
object |
(DEPRECATED) (optional) |
kubernetes |
object |
The Kubernetes-specific metadata |
structured |
object |
(optional) Original log entry as a structured object. Example: |
| Property | Type | Description |
|---|---|---|
@timestamp |
string |
A UTC value that marks when the log payload was created. If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use. format:
|
hostname |
string |
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as |
level |
string |
The normalized log level
The logging level from various sources, including
|
log_source |
string |
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN |
log_type |
string |
The source type of the log. The
|
message |
string |
(optional) Original log entry text, UTF-8 encoded This field may be absent or empty if a non-empty |
openshift |
object |
Openshift specific metadata |
pipeline_metadata |
object |
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations |
timestamp |
string |
A UTC value that marks when the log payload was created.
Value derived from legacy
|
viaq_index_name |
string |
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write). The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model. |
viaq_msg_id |
string |
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified. It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218), or some other ASCII value and is used as the |
A UTC value that marks when the log payload was created.
If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use.
format:
-
yyyy-MM-dd HH:mm:ss,SSSZ
-
yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ
-
yyyy-MM-dd'T'HH:mm:ssZ
-
dateOptionalTime
example: 2024-11-24T14:06:05.071000000Z
- Type
-
string
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as kubernetes.host.
- Type
-
string
The normalized log level
The logging level from various sources, including rsyslog(severitytext property), python's logging module, and others.
The following values come from syslog.h, and are preceded by their numeric equivalents:
-
0=emerg, system is unusable. -
1=alert, action must be taken immediately. -
2=crit, critical conditions. -
3=err, error conditions. -
4=warn, warning conditions. -
5=notice, normal but significant condition. -
6=info, informational. -
7=debug, debug-level messages.
The two following values are not part of syslog.h but are widely used:
-
8=trace, trace-level messages, which are more verbose thandebugmessages. -
9=unknown, when the logging system gets a value it doesn't recognize.
Map the log levels or priorities of other logging systems to their nearest match in the preceding list. For example, from python logging, you can match CRITICAL with crit, ERROR with err, and so on.
- Type
-
string
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN
- Type
-
string
The source type of the log. The log_type field may contain one of these strings, or may have additional dot-separated components, for example "infrastructure.container" or "infrastructure.node".
-
"application": Container logs generated by user applications running in the cluster, except infrastructure containers.
-
"infrastructure": Node logs (such as syslog or journal logs), and container logs from pods in the openshift*, kube*, or default projects.
-
"audit":
-
Node logs from auditd (/var/log/audit/audit.log)
-
Kubernetes and OpenShift apiservers audit logs.
-
OVN audit logs
- Type
-
string
-
(optional) Original log entry text, UTF-8 encoded
This field may be absent or empty if a non-empty structured field is present.
See the description of structured for additional details.
- Type
-
string
Openshift specific metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
cluster_id |
string |
ClusterID is the unique id of the cluster where the workload is deployed |
labels |
object |
(optional) Labels is a set of common, static labels that were spec'd for log forwarding to be sent with the log Records |
sequence |
string |
Sequence is increasing id used in conjunction with the timestamp to establish a linear timeline of log records. This was added as a workaround for logstores that do not have nano-second precision. |
ClusterID is the unique id of the cluster where the workload is deployed
- Type
-
string
(optional) Labels is a set of common, static labels that were spec'd for log forwarding to be sent with the log Records
- Type
-
object
Sequence is increasing id used in conjunction with the timestamp to establish a linear timeline of log records. This was added as a workaround for logstores that do not have nano-second precision.
- Type
-
string
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations
- Type
-
object
| Property | Type | Description |
|---|---|---|
collector |
object |
Collector metadata |
Collector metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
inputname |
string |
(DEPRECATED) |
ipaddr4 |
string |
(optional) Ipaddr4 is the ipV4 address of the collector |
name |
string |
Name is the implementation of the collector agent |
original_raw_message |
string |
OriginalRawMessage captures the original message for eventrouter logs |
received_at |
string |
ReceivedAt the time the collector received the log entry |
version |
string |
Version is collector version information |
(optional) Ipaddr4 is the ipV4 address of the collector
- Type
-
string
OriginalRawMessage captures the original message for eventrouter logs
- Type
-
string
ReceivedAt the time the collector received the log entry
- Type
-
string
A UTC value that marks when the log payload was created.
Value derived from legacy @timestamp for forward compatibility.
format:
-
yyyy-MM-dd HH:mm:ss,SSSZ
-
yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ
-
yyyy-MM-dd'T'HH:mm:ssZ
-
dateOptionalTime
example: 2024-11-24T14:06:05.071000000Z
- Type
-
string
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write).
The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model.
- Type
-
string
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified.
It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218),
or some other ASCII value and is used as the _id of the document when sending to Elasticsearch. The intended use of this field is that if you use another
logging store or application other than Elasticsearch, but you still need to correlate data with the data stored
in Elasticsearch, this field will give you the exact document corresponding to the record.
This is only present when deploying fluentd collector implementations
- Type
-
string
(DEPRECATED) (optional)
- Type
-
object
| Property | Type | Description |
|---|---|---|
container_id |
string |
ContainerID is the id of the container producing the log |
The Kubernetes-specific metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
annotations |
object |
(optional) Annotations associated with the Kubernetes pod |
container_id |
string |
(optional) |
container_image |
string |
(optional) |
container_image_id |
string |
(optional) |
container_iostream |
string |
(optional) The name of the stream the log line was submitted to (e.g.: stdout, stderr) |
container_name |
string |
ContainerName of the the pod container that produced the log |
flat_labels |
array |
(DEPRECATED) (optional) FlatLabels is an array of the pod labels joined as key=value |
host |
string |
(optional) Host is the kubernetes node name that hosts the pod |
labels |
object |
(optional) Labels present on the Pod at time the log was generated |
master_url |
string |
(DEPRECATED) MasterURL is the url to the apiserver |
namespace_id |
string |
(optional) NamespaceID is the unique uuid of the namespace |
namespace_labels |
object |
(optional) NamespaceLabels are the labels present on the pod namespace |
namespace_name |
string |
NamespaceName where the pod is deployed |
pod_id |
string |
(optional) PodID is the unique uuid of the pod |
pod_name |
string |
PodName is the name of the pod |
(optional) The name of the stream the log line was submitted to (e.g.: stdout, stderr)
- Type
-
string
(DEPRECATED) (optional) FlatLabels is an array of the pod labels joined as key=value
- Type
-
array
(optional) NamespaceLabels are the labels present on the pod namespace
- Type
-
object
(optional) Original log entry as a structured object.
Example:
{"pid":21631,"ppid":21618,"worker":0,"message":"starting fluentd worker pid=21631 ppid=21618 worker=0"}
This field may be present if the forwarder was configured to parse structured JSON logs.
If the original log entry was a valid structured log, this field will contain an equivalent JSON structure.
Otherwise this field will be empty or absent, and the message field will contain the original log message.
The structured field includes the same sub-fields as the original log message.
- Type
-
object
The data model for event logs collected from the EventRouter.
| Property | Type | Description |
|---|---|---|
@timestamp |
string |
A UTC value that marks when the log payload was created. If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use. format:
|
hostname |
string |
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as |
level |
string |
The normalized log level
The logging level from various sources, including
|
log_source |
string |
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN |
log_type |
string |
The source type of the log. The
|
message |
string |
(optional) Original log entry text, UTF-8 encoded This field may be absent or empty if a non-empty |
openshift |
object |
Openshift specific metadata |
pipeline_metadata |
object |
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations |
timestamp |
string |
A UTC value that marks when the log payload was created.
Value derived from legacy
|
viaq_index_name |
string |
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write). The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model. |
viaq_msg_id |
string |
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified. It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218), or some other ASCII value and is used as the |
kubernetes |
object |
The Kubernetes-specific metadata |
old_event |
object |
OldEvent is a core KubernetesEvent that was replaced by kubernetes.event |
| Property | Type | Description |
|---|---|---|
@timestamp |
string |
A UTC value that marks when the log payload was created. If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use. format:
|
hostname |
string |
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as |
level |
string |
The normalized log level
The logging level from various sources, including
|
log_source |
string |
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN |
log_type |
string |
The source type of the log. The
|
message |
string |
(optional) Original log entry text, UTF-8 encoded This field may be absent or empty if a non-empty |
openshift |
object |
Openshift specific metadata |
pipeline_metadata |
object |
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations |
timestamp |
string |
A UTC value that marks when the log payload was created.
Value derived from legacy
|
viaq_index_name |
string |
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write). The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model. |
viaq_msg_id |
string |
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified. It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218), or some other ASCII value and is used as the |
A UTC value that marks when the log payload was created.
If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use.
format:
-
yyyy-MM-dd HH:mm:ss,SSSZ
-
yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ
-
yyyy-MM-dd'T'HH:mm:ssZ
-
dateOptionalTime
example: 2024-11-24T14:06:05.071000000Z
- Type
-
string
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as kubernetes.host.
- Type
-
string
The normalized log level
The logging level from various sources, including rsyslog(severitytext property), python's logging module, and others.
The following values come from syslog.h, and are preceded by their numeric equivalents:
-
0=emerg, system is unusable. -
1=alert, action must be taken immediately. -
2=crit, critical conditions. -
3=err, error conditions. -
4=warn, warning conditions. -
5=notice, normal but significant condition. -
6=info, informational. -
7=debug, debug-level messages.
The two following values are not part of syslog.h but are widely used:
-
8=trace, trace-level messages, which are more verbose thandebugmessages. -
9=unknown, when the logging system gets a value it doesn't recognize.
Map the log levels or priorities of other logging systems to their nearest match in the preceding list. For example, from python logging, you can match CRITICAL with crit, ERROR with err, and so on.
- Type
-
string
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN
- Type
-
string
The source type of the log. The log_type field may contain one of these strings, or may have additional dot-separated components, for example "infrastructure.container" or "infrastructure.node".
-
"application": Container logs generated by user applications running in the cluster, except infrastructure containers.
-
"infrastructure": Node logs (such as syslog or journal logs), and container logs from pods in the openshift*, kube*, or default projects.
-
"audit":
-
Node logs from auditd (/var/log/audit/audit.log)
-
Kubernetes and OpenShift apiservers audit logs.
-
OVN audit logs
- Type
-
string
-
(optional) Original log entry text, UTF-8 encoded
This field may be absent or empty if a non-empty structured field is present.
See the description of structured for additional details.
- Type
-
string
Openshift specific metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
cluster_id |
string |
ClusterID is the unique id of the cluster where the workload is deployed |
labels |
object |
(optional) Labels is a set of common, static labels that were spec'd for log forwarding to be sent with the log Records |
sequence |
string |
Sequence is increasing id used in conjunction with the timestamp to establish a linear timeline of log records. This was added as a workaround for logstores that do not have nano-second precision. |
ClusterID is the unique id of the cluster where the workload is deployed
- Type
-
string
(optional) Labels is a set of common, static labels that were spec'd for log forwarding to be sent with the log Records
- Type
-
object
Sequence is increasing id used in conjunction with the timestamp to establish a linear timeline of log records. This was added as a workaround for logstores that do not have nano-second precision.
- Type
-
string
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations
- Type
-
object
| Property | Type | Description |
|---|---|---|
collector |
object |
Collector metadata |
Collector metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
inputname |
string |
(DEPRECATED) |
ipaddr4 |
string |
(optional) Ipaddr4 is the ipV4 address of the collector |
name |
string |
Name is the implementation of the collector agent |
original_raw_message |
string |
OriginalRawMessage captures the original message for eventrouter logs |
received_at |
string |
ReceivedAt the time the collector received the log entry |
version |
string |
Version is collector version information |
(optional) Ipaddr4 is the ipV4 address of the collector
- Type
-
string
OriginalRawMessage captures the original message for eventrouter logs
- Type
-
string
ReceivedAt the time the collector received the log entry
- Type
-
string
A UTC value that marks when the log payload was created.
Value derived from legacy @timestamp for forward compatibility.
format:
-
yyyy-MM-dd HH:mm:ss,SSSZ
-
yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ
-
yyyy-MM-dd'T'HH:mm:ssZ
-
dateOptionalTime
example: 2024-11-24T14:06:05.071000000Z
- Type
-
string
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write).
The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model.
- Type
-
string
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified.
It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218),
or some other ASCII value and is used as the _id of the document when sending to Elasticsearch. The intended use of this field is that if you use another
logging store or application other than Elasticsearch, but you still need to correlate data with the data stored
in Elasticsearch, this field will give you the exact document corresponding to the record.
This is only present when deploying fluentd collector implementations
- Type
-
string
The Kubernetes-specific metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
annotations |
object |
(optional) Annotations associated with the Kubernetes pod |
container_id |
string |
(optional) |
container_image |
string |
(optional) |
container_image_id |
string |
(optional) |
container_iostream |
string |
(optional) The name of the stream the log line was submitted to (e.g.: stdout, stderr) |
container_name |
string |
ContainerName of the the pod container that produced the log |
flat_labels |
array |
(DEPRECATED) (optional) FlatLabels is an array of the pod labels joined as key=value |
host |
string |
(optional) Host is the kubernetes node name that hosts the pod |
labels |
object |
(optional) Labels present on the Pod at time the log was generated |
master_url |
string |
(DEPRECATED) MasterURL is the url to the apiserver |
namespace_id |
string |
(optional) NamespaceID is the unique uuid of the namespace |
namespace_labels |
object |
(optional) NamespaceLabels are the labels present on the pod namespace |
namespace_name |
string |
NamespaceName where the pod is deployed |
pod_id |
string |
(optional) PodID is the unique uuid of the pod |
pod_name |
string |
PodName is the name of the pod |
event |
object |
Event is the core KubernetesEvent |
| Property | Type | Description |
|---|---|---|
annotations |
object |
(optional) Annotations associated with the Kubernetes pod |
container_id |
string |
(optional) |
container_image |
string |
(optional) |
container_image_id |
string |
(optional) |
container_iostream |
string |
(optional) The name of the stream the log line was submitted to (e.g.: stdout, stderr) |
container_name |
string |
ContainerName of the the pod container that produced the log |
flat_labels |
array |
(DEPRECATED) (optional) FlatLabels is an array of the pod labels joined as key=value |
host |
string |
(optional) Host is the kubernetes node name that hosts the pod |
labels |
object |
(optional) Labels present on the Pod at time the log was generated |
master_url |
string |
(DEPRECATED) MasterURL is the url to the apiserver |
namespace_id |
string |
(optional) NamespaceID is the unique uuid of the namespace |
namespace_labels |
object |
(optional) NamespaceLabels are the labels present on the pod namespace |
namespace_name |
string |
NamespaceName where the pod is deployed |
pod_id |
string |
(optional) PodID is the unique uuid of the pod |
pod_name |
string |
PodName is the name of the pod |
(optional) The name of the stream the log line was submitted to (e.g.: stdout, stderr)
- Type
-
string
(DEPRECATED) (optional) FlatLabels is an array of the pod labels joined as key=value
- Type
-
array
(optional) NamespaceLabels are the labels present on the pod namespace
- Type
-
object
Event is the core KubernetesEvent
- Type
-
object
| Property | Type | Description |
|---|---|---|
action |
string |
(optional) What action was taken/failed regarding to the Regarding object. |
count |
int |
(optional) The number of times this event has occurred. |
eventTime |
object |
(optional) Time when this Event was first observed. |
firstTimestamp |
string |
(optional) The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
involvedObject |
object |
The object that this event is about. |
lastTimestamp |
string |
(optional) The time at which the most recent occurrence of this event was recorded. |
message |
string |
(optional) A human-readable description of the status of this operation. TODO: decide on maximum length. |
reason |
string |
(optional) This should be a short, machine understandable string that gives the reason for the transition into the object's current status. TODO: provide exact specification for format. |
related |
object |
(optional) Optional secondary object for more complex actions. |
reportingComponent |
string |
(optional) Name of the controller that emitted this Event, e.g. |
reportingInstance |
string |
(optional) ID of the controller instance, e.g. |
series |
object |
(optional) Data about the Event series this event represents or nil if it's a singleton Event. |
source |
object |
(optional) The component reporting this event. Should be a short machine understandable string. |
type |
string |
(optional) Type of this event (Normal, Warning), new types could be added in the future |
verb |
string |
Verb is indicates if event was created or updated |
| Property | Type | Description |
|---|---|---|
action |
string |
(optional) What action was taken/failed regarding to the Regarding object. |
count |
int |
(optional) The number of times this event has occurred. |
eventTime |
object |
(optional) Time when this Event was first observed. |
firstTimestamp |
string |
(optional) The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
involvedObject |
object |
The object that this event is about. |
lastTimestamp |
string |
(optional) The time at which the most recent occurrence of this event was recorded. |
message |
string |
(optional) A human-readable description of the status of this operation. TODO: decide on maximum length. |
reason |
string |
(optional) This should be a short, machine understandable string that gives the reason for the transition into the object's current status. TODO: provide exact specification for format. |
related |
object |
(optional) Optional secondary object for more complex actions. |
reportingComponent |
string |
(optional) Name of the controller that emitted this Event, e.g. |
reportingInstance |
string |
(optional) ID of the controller instance, e.g. |
series |
object |
(optional) Data about the Event series this event represents or nil if it's a singleton Event. |
source |
object |
(optional) The component reporting this event. Should be a short machine understandable string. |
type |
string |
(optional) Type of this event (Normal, Warning), new types could be added in the future |
(optional) What action was taken/failed regarding to the Regarding object.
- Type
-
string
(optional) Time when this Event was first observed.
- Type
-
object
| Property | Type | Description |
|---|---|---|
Time |
string |
(optional) The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)
- Type
-
string
The object that this event is about.
- Type
-
object
| Property | Type | Description |
|---|---|---|
apiVersion |
string |
(optional) API version of the referent. |
fieldPath |
string |
(optional) If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future. |
kind |
string |
(optional) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
name |
string |
(optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
namespace |
string |
(optional) Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
resourceVersion |
string |
(optional) Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
uid |
string |
(optional) UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
(optional) If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.
- Type
-
string
(optional) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- Type
-
string
(optional) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- Type
-
string
(optional) Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
- Type
-
string
(optional) Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
- Type
-
string
(optional) UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
- Type
-
string
(optional) The time at which the most recent occurrence of this event was recorded.
- Type
-
string
(optional) A human-readable description of the status of this operation. TODO: decide on maximum length.
- Type
-
string
(optional) This should be a short, machine understandable string that gives the reason for the transition into the object's current status. TODO: provide exact specification for format.
- Type
-
string
(optional) Optional secondary object for more complex actions.
- Type
-
object
(optional) Name of the controller that emitted this Event, e.g. kubernetes.io/kubelet.
- Type
-
string
(optional) ID of the controller instance, e.g. kubelet-xyzf.
- Type
-
string
(optional) Data about the Event series this event represents or nil if it's a singleton Event.
- Type
-
object
(optional) The component reporting this event. Should be a short machine understandable string.
- Type
-
object
| Property | Type | Description |
|---|---|---|
component |
string |
(optional) Component from which the event is generated. |
host |
string |
(optional) Node name on which the event is generated. |
(optional) Component from which the event is generated.
- Type
-
string
(optional) Type of this event (Normal, Warning), new types could be added in the future
- Type
-
string
The data model for collected logs from node journal.
| Property | Type | Description |
|---|---|---|
@timestamp |
string |
A UTC value that marks when the log payload was created. If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use. format:
|
hostname |
string |
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as |
level |
string |
The normalized log level
The logging level from various sources, including
|
log_source |
string |
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN |
log_type |
string |
The source type of the log. The
|
message |
string |
(optional) Original log entry text, UTF-8 encoded This field may be absent or empty if a non-empty |
openshift |
object |
Openshift specific metadata |
pipeline_metadata |
object |
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations |
timestamp |
string |
A UTC value that marks when the log payload was created.
Value derived from legacy
|
viaq_index_name |
string |
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write). The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model. |
viaq_msg_id |
string |
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified. It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218), or some other ASCII value and is used as the |
_STREAM_ID |
string |
|
_SYSTEMD_INVOCATION_ID |
string |
|
systemd |
object |
|
tag |
string |
|
time |
string |
| Property | Type | Description |
|---|---|---|
@timestamp |
string |
A UTC value that marks when the log payload was created. If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use. format:
|
hostname |
string |
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as |
level |
string |
The normalized log level
The logging level from various sources, including
|
log_source |
string |
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN |
log_type |
string |
The source type of the log. The
|
message |
string |
(optional) Original log entry text, UTF-8 encoded This field may be absent or empty if a non-empty |
openshift |
object |
Openshift specific metadata |
pipeline_metadata |
object |
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations |
timestamp |
string |
A UTC value that marks when the log payload was created.
Value derived from legacy
|
viaq_index_name |
string |
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write). The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model. |
viaq_msg_id |
string |
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified. It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218), or some other ASCII value and is used as the |
A UTC value that marks when the log payload was created.
If the creation time is not known when the log payload was first collected. The “@” prefix denotes a field that is reserved for a particular use.
format:
-
yyyy-MM-dd HH:mm:ss,SSSZ
-
yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ
-
yyyy-MM-dd'T'HH:mm:ssZ
-
dateOptionalTime
example: 2024-11-24T14:06:05.071000000Z
- Type
-
string
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as kubernetes.host.
- Type
-
string
The normalized log level
The logging level from various sources, including rsyslog(severitytext property), python's logging module, and others.
The following values come from syslog.h, and are preceded by their numeric equivalents:
-
0=emerg, system is unusable. -
1=alert, action must be taken immediately. -
2=crit, critical conditions. -
3=err, error conditions. -
4=warn, warning conditions. -
5=notice, normal but significant condition. -
6=info, informational. -
7=debug, debug-level messages.
The two following values are not part of syslog.h but are widely used:
-
8=trace, trace-level messages, which are more verbose thandebugmessages. -
9=unknown, when the logging system gets a value it doesn't recognize.
Map the log levels or priorities of other logging systems to their nearest match in the preceding list. For example, from python logging, you can match CRITICAL with crit, ERROR with err, and so on.
- Type
-
string
LogSource is the source of a log used along with the LogType to distinguish a subcategory of the LogType. Application logs are always sourced from containers Infrastructure logs are sourced from containers or journal logs from the node Audit logs are sourced from: kubernetes and openshift API servers, node auditd, and OVN
- Type
-
string
The source type of the log. The log_type field may contain one of these strings, or may have additional dot-separated components, for example "infrastructure.container" or "infrastructure.node".
-
"application": Container logs generated by user applications running in the cluster, except infrastructure containers.
-
"infrastructure": Node logs (such as syslog or journal logs), and container logs from pods in the openshift*, kube*, or default projects.
-
"audit":
-
Node logs from auditd (/var/log/audit/audit.log)
-
Kubernetes and OpenShift apiservers audit logs.
-
OVN audit logs
- Type
-
string
-
(optional) Original log entry text, UTF-8 encoded
This field may be absent or empty if a non-empty structured field is present.
See the description of structured for additional details.
- Type
-
string
Openshift specific metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
cluster_id |
string |
ClusterID is the unique id of the cluster where the workload is deployed |
labels |
object |
(optional) Labels is a set of common, static labels that were spec'd for log forwarding to be sent with the log Records |
sequence |
string |
Sequence is increasing id used in conjunction with the timestamp to establish a linear timeline of log records. This was added as a workaround for logstores that do not have nano-second precision. |
ClusterID is the unique id of the cluster where the workload is deployed
- Type
-
string
(optional) Labels is a set of common, static labels that were spec'd for log forwarding to be sent with the log Records
- Type
-
object
Sequence is increasing id used in conjunction with the timestamp to establish a linear timeline of log records. This was added as a workaround for logstores that do not have nano-second precision.
- Type
-
string
(DEPRECATED) (optional) Metadata related to ViaQ log collection pipeline. Everything about log collector, normalizers, mappings goes here. Data in this subgroup is forwarded for troubleshooting and tracing purposes. This is only present when deploying fluentd collector implementations
- Type
-
object
| Property | Type | Description |
|---|---|---|
collector |
object |
Collector metadata |
Collector metadata
- Type
-
object
| Property | Type | Description |
|---|---|---|
inputname |
string |
(DEPRECATED) |
ipaddr4 |
string |
(optional) Ipaddr4 is the ipV4 address of the collector |
name |
string |
Name is the implementation of the collector agent |
original_raw_message |
string |
OriginalRawMessage captures the original message for eventrouter logs |
received_at |
string |
ReceivedAt the time the collector received the log entry |
version |
string |
Version is collector version information |
(optional) Ipaddr4 is the ipV4 address of the collector
- Type
-
string
OriginalRawMessage captures the original message for eventrouter logs
- Type
-
string
ReceivedAt the time the collector received the log entry
- Type
-
string
A UTC value that marks when the log payload was created.
Value derived from legacy @timestamp for forward compatibility.
format:
-
yyyy-MM-dd HH:mm:ss,SSSZ
-
yyyy-MM-dd'T'HH:mm:ss.SSSSSSZ
-
yyyy-MM-dd'T'HH:mm:ssZ
-
dateOptionalTime
example: 2024-11-24T14:06:05.071000000Z
- Type
-
string
(optional) ViaqIndexName used with Elasticsearch 6.x and later, this is a name of a write index alias (e.g. app-write).
The value depends on the log type of this message. Detailed documentation is found at https://github.com/openshift/enhancements/blob/master/enhancements/cluster-logging/cluster-logging-es-rollover-data-design.md#data-model.
- Type
-
string
(optional) ViaqMessageId is a unique ID assigned to each message. The format is not specified.
It may be a UUID or a Base64 (e.g. 82f13a8e-882a-4344-b103-f0a6f30fd218),
or some other ASCII value and is used as the _id of the document when sending to Elasticsearch. The intended use of this field is that if you use another
logging store or application other than Elasticsearch, but you still need to correlate data with the data stored
in Elasticsearch, this field will give you the exact document corresponding to the record.
This is only present when deploying fluentd collector implementations
- Type
-
string
- Type
-
object
| Property | Type | Description |
|---|---|---|
KERNEL_DEVICE |
string |
|
KERNEL_SUBSYSTEM |
string |
|
UDEV_DEVLINK |
string |
|
UDEV_DEVNODE |
string |
|
UDEV_SYSNAME |
string |
- Type
-
object
| Property | Type | Description |
|---|---|---|
AUDIT_LOGINUID |
string |
|
AUDIT_SESSION |
string |
|
BOOT_ID |
string |
|
CAP_EFFECTIVE |
string |
|
CMDLINE |
string |
|
COMM |
string |
|
EXE |
string |
|
GID |
string |
|
HOSTNAME |
string |
|
LINE_BREAK |
string |
|
MACHINE_ID |
string |
|
PID |
string |
|
SELINUX_CONTEXT |
string |
|
STREAM_ID |
string |
|
SYSTEMD_CGROUP |
string |
|
SYSTEMD_INVOCATION_ID |
string |
|
SYSTEMD_OWNER_UID |
string |
|
SYSTEMD_SESSION |
string |
|
SYSTEMD_SLICE |
string |
|
SYSTEMD_UNIT |
string |
|
SYSTEMD_USER_UNIT |
string |
|
TRANSPORT |
string |
|
UID |
string |
- Type
-
object
| Property | Type | Description |
|---|---|---|
CODE_FILE |
string |
|
CODE_FUNCTION |
string |
|
CODE_LINE |
string |
|
ERRNO |
string |
|
MESSAGE_ID |
string |
|
RESULT |
string |
|
SYSLOG_FACILITY |
string |
|
SYSLOG_IDENTIFIER |
string |
|
SYSLOG_PID |
string |
|
UNIT |
string |