Skip to content

Commit c9ef727

Browse files
author
Mathieu Martin
committed
Beef up the description of the log field set.
1 parent fef7d6b commit c9ef727

File tree

7 files changed

+32
-11
lines changed

7 files changed

+32
-11
lines changed

code/go/ecs/log.go

Lines changed: 5 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/field-details.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2099,7 +2099,9 @@ example: `1.1`
20992099
[[ecs-log]]
21002100
=== Log Fields
21012101

2102-
Fields which are specific to log events.
2102+
Low level details specific to log events.
2103+
2104+
`log.*` typically contains lower level details about the logging mechanism than `event.*`. For example, The Syslog transport details belongs under `log.*`, whereas the message payloads transmitted via Syslog will likely be parsed out into `event.*` or elsewhere in ECS.
21032105

21042106
==== Log Field Details
21052107

docs/fields.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ all fields are defined.
5252

5353
| <<ecs-http,HTTP>> | Fields describing an HTTP request.
5454

55-
| <<ecs-log,Log>> | Fields which are specific to log events.
55+
| <<ecs-log,Log>> | Low level details specific to log events.
5656

5757
| <<ecs-network,Network>> | Fields describing the communication path over which the event happened.
5858

generated/beats/fields.ecs.yml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1583,7 +1583,12 @@
15831583
- name: log
15841584
title: Log
15851585
group: 2
1586-
description: Fields which are specific to log events.
1586+
description: 'Low level details specific to log events.
1587+
1588+
`log.*` typically contains lower level details about the logging mechanism than
1589+
`event.*`. For example, The Syslog transport details belongs under `log.*`,
1590+
whereas the message payloads transmitted via Syslog will likely be parsed out
1591+
into `event.*` or elsewhere in ECS.'
15871592
type: group
15881593
fields:
15891594
- name: level

generated/ecs/ecs_nested.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2564,7 +2564,12 @@ http:
25642564
title: HTTP
25652565
type: group
25662566
log:
2567-
description: Fields which are specific to log events.
2567+
description: 'Low level details specific to log events.
2568+
2569+
`log.*` typically contains lower level details about the logging mechanism than
2570+
`event.*`. For example, The Syslog transport details belongs under `log.*`, whereas
2571+
the message payloads transmitted via Syslog will likely be parsed out into `event.*`
2572+
or elsewhere in ECS.'
25682573
fields:
25692574
level:
25702575
description: 'Original log level of the log event.
@@ -2644,7 +2649,7 @@ log:
26442649
group: 2
26452650
name: log
26462651
prefix: log.
2647-
short: Fields which are specific to log events.
2652+
short: Low level details specific to log events.
26482653
title: Log
26492654
type: group
26502655
network:

schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1533,7 +1533,7 @@
15331533
"type": "group"
15341534
},
15351535
"log": {
1536-
"description": "Fields which are specific to log events.\n",
1536+
"description": "Low level details specific to log events.\n`log.*` typically contains lower level details about the logging mechanism than `event.*`. For example, The Syslog transport details belongs under `log.*`, whereas the message payloads transmitted via Syslog will likely be parsed out into `event.*` or elsewhere in ECS.\n",
15371537
"fields": {
15381538
"log.level": {
15391539
"description": "Original log level of the log event.\nSome examples are `warn`, `error`, `i`.",

schemas/log.yml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,14 @@
22
- name: log
33
title: Log
44
group: 2
5+
short: Low level details specific to log events.
56
description: >
6-
Fields which are specific to log events.
7+
Low level details specific to log events.
8+
9+
`log.*` typically contains lower level details about the logging mechanism
10+
than `event.*`. For example, The Syslog transport details belongs under `log.*`,
11+
whereas the message payloads transmitted via Syslog will likely be parsed out
12+
into `event.*` or elsewhere in ECS.
713
type: group
814
fields:
915

@@ -42,7 +48,7 @@
4248
example: org.elasticsearch.bootstrap.Bootstrap
4349
short: Name of the logger.
4450
description: >
45-
The name of the logger inside an application. This is usually the name of the class which initialized the logger, or can be a custom name.
51+
The name of the logger inside an application. This is usually the name of the class which initialized the logger, or can be a custom name.
4652
4753
- name: origin.file.name
4854
level: extended
@@ -60,12 +66,11 @@
6066
short: The line number of the file which originated the log event.
6167
description: >
6268
The line number of the file containing the source code which originated the log event.
63-
69+
6470
- name: origin.function
6571
level: extended
6672
type: keyword
6773
example: init
6874
short: The function which originated the log event.
6975
description: >
7076
The name of the function or method which originated the log event.
71-

0 commit comments

Comments
 (0)