Skip to content

Commit e5d9c46

Browse files
authored
Clarify documentation for log.origin.file.* (#568)
based on discussions in #563
1 parent 6855c81 commit e5d9c46

File tree

7 files changed

+23
-14
lines changed

7 files changed

+23
-14
lines changed

code/go/ecs/log.go

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/field-details.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2121,7 +2121,7 @@ example: `org.elasticsearch.bootstrap.Bootstrap`
21212121
// ===============================================================
21222122

21232123
| log.origin.file.line
2124-
| The line number of the file which originated the log event.
2124+
| The line number of the file containing the source code which originated the log event.
21252125

21262126
type: integer
21272127

@@ -2132,7 +2132,7 @@ example: `42`
21322132
// ===============================================================
21332133

21342134
| log.origin.file.name
2135-
| The name of the source file which originated the log event.
2135+
| The name of the file containing the source code which originated the log event. Note that this is not the name of the log file.
21362136

21372137
type: keyword
21382138

generated/beats/fields.ecs.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1576,13 +1576,15 @@
15761576
- name: origin.file.line
15771577
level: extended
15781578
type: integer
1579-
description: The line number of the file which originated the log event.
1579+
description: The line number of the file containing the source code which originated
1580+
the log event.
15801581
example: 42
15811582
- name: origin.file.name
15821583
level: extended
15831584
type: keyword
15841585
ignore_above: 1024
1585-
description: The name of the source file which originated the log event.
1586+
description: The name of the file containing the source code which originated
1587+
the log event. Note that this is not the name of the log file.
15861588
example: Bootstrap.java
15871589
- name: origin.function
15881590
level: extended

generated/ecs/ecs_flat.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2238,7 +2238,8 @@ log.logger:
22382238
short: Name of the logger.
22392239
type: keyword
22402240
log.origin.file.line:
2241-
description: The line number of the file which originated the log event.
2241+
description: The line number of the file containing the source code which originated
2242+
the log event.
22422243
example: 42
22432244
flat_name: log.origin.file.line
22442245
level: extended
@@ -2247,7 +2248,8 @@ log.origin.file.line:
22472248
short: The line number of the file which originated the log event.
22482249
type: integer
22492250
log.origin.file.name:
2250-
description: The name of the source file which originated the log event.
2251+
description: The name of the file containing the source code which originated the
2252+
log event. Note that this is not the name of the log file.
22512253
example: Bootstrap.java
22522254
flat_name: log.origin.file.name
22532255
ignore_above: 1024

generated/ecs/ecs_nested.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2543,7 +2543,8 @@ log:
25432543
short: Name of the logger.
25442544
type: keyword
25452545
origin.file.line:
2546-
description: The line number of the file which originated the log event.
2546+
description: The line number of the file containing the source code which originated
2547+
the log event.
25472548
example: 42
25482549
flat_name: log.origin.file.line
25492550
level: extended
@@ -2552,7 +2553,8 @@ log:
25522553
short: The line number of the file which originated the log event.
25532554
type: integer
25542555
origin.file.name:
2555-
description: The name of the source file which originated the log event.
2556+
description: The name of the file containing the source code which originated
2557+
the log event. Note that this is not the name of the log file.
25562558
example: Bootstrap.java
25572559
flat_name: log.origin.file.name
25582560
ignore_above: 1024

schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1546,7 +1546,7 @@
15461546
"type": "keyword"
15471547
},
15481548
"log.origin.file.line": {
1549-
"description": "The line number of the file which originated the log event.",
1549+
"description": "The line number of the file containing the source code which originated the log event.",
15501550
"example": "42",
15511551
"footnote": "",
15521552
"group": 2,
@@ -1556,7 +1556,7 @@
15561556
"type": "integer"
15571557
},
15581558
"log.origin.file.name": {
1559-
"description": "The name of the source file which originated the log event.",
1559+
"description": "The name of the file containing the source code which originated the log event. Note that this is not the name of the log file.",
15601560
"example": "Bootstrap.java",
15611561
"footnote": "",
15621562
"group": 2,

schemas/log.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,16 @@
5050
example: Bootstrap.java
5151
short: The file which originated the log event.
5252
description: >
53-
The name of the source file which originated the log event.
53+
The name of the file containing the source code which originated the log event.
54+
Note that this is not the name of the log file.
5455
5556
- name: origin.file.line
5657
level: extended
5758
type: integer
5859
example: 42
5960
short: The line number of the file which originated the log event.
6061
description: >
61-
The line number of the file which originated the log event.
62+
The line number of the file containing the source code which originated the log event.
6263
6364
- name: origin.function
6465
level: extended

0 commit comments

Comments
 (0)