Skip to content

Commit fdb2ce1

Browse files
authored
Merge pull request #70811 from libander/OBSDOCS-771
OBSDOCS-771 - Fix exported fields headers
2 parents 65a2db8 + 3fb4b85 commit fdb2ce1

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

modules/cluster-logging-exported-fields-top-level-fields.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
The top level fields may be present in every record.
1111

12+
[discrete]
1213
== message
1314

1415
The 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 more.
@@ -17,6 +18,7 @@ The original log entry text, UTF-8 encoded. This field may be absent or empty if
1718
Data type:: text
1819
Example value:: `HAPPY`
1920

21+
[discrete]
2022
== structured
2123

2224
Original log entry as a structured object. 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 can have any subfields that are included in the log message, there are no restrictions defined here.
@@ -25,6 +27,7 @@ Original log entry as a structured object. This field may be present if the forw
2527
Data type:: group
2628
Example value:: map[message:starting fluentd worker pid=21631 ppid=21618 worker=0 pid:21631 ppid:21618 worker:0]
2729

30+
[discrete]
2831
== @timestamp
2932

3033
A UTC value that marks when the log payload was created or, 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. By default, most tools look for “@timestamp” with ElasticSearch.
@@ -33,27 +36,31 @@ A UTC value that marks when the log payload was created or, if the creation time
3336
Data type:: date
3437
Example value:: `2015-01-24 14:06:05.071000000 Z`
3538

39+
[discrete]
3640
== hostname
3741

3842
The name of the host where this log message originated. In a Kubernetes cluster, this is the same as `kubernetes.host`.
3943

4044
[horizontal]
4145
Data type:: keyword
4246

47+
[discrete]
4348
== ipaddr4
4449

4550
The IPv4 address of the source server. Can be an array.
4651

4752
[horizontal]
4853
Data type:: ip
4954

55+
[discrete]
5056
== ipaddr6
5157

5258
The IPv6 address of the source server, if available. Can be an array.
5359

5460
[horizontal]
5561
Data type:: ip
5662

63+
[discrete]
5764
== level
5865

5966
The logging level from various sources, including `rsyslog(severitytext property)`, a Python logging module, and others.
@@ -80,13 +87,15 @@ Map the log levels or priorities of other logging systems to their nearest match
8087
Data type:: keyword
8188
Example value:: `info`
8289

90+
[discrete]
8391
== pid
8492

8593
The process ID of the logging entity, if available.
8694

8795
[horizontal]
8896
Data type:: keyword
8997

98+
[discrete]
9099
== service
91100

92101
The name of the service associated with the logging entity, if available. For example, syslog's `APP-NAME` and rsyslog's `programname` properties are mapped to the service field.
@@ -101,13 +110,15 @@ Optional. An operator-defined list of tags placed on each log by the collector o
101110
[horizontal]
102111
Data type:: text
103112

113+
[discrete]
104114
== file
105115

106116
The path to the log file from which the collector reads this log entry. Normally, this is a path in the `/var/log` file system of a cluster node.
107117

108118
[horizontal]
109119
Data type:: text
110120

121+
[discrete]
111122
== offset
112123

113124
The offset value. Can represent bytes to the start of the log line in the file (zero- or one-based), or log line numbers (zero- or one-based), so long as the values are strictly monotonically increasing in the context of a single log file. The values are allowed to wrap, representing a new version of the log file (rotation).

0 commit comments

Comments
 (0)