Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation for log.origin.file.* #568

Merged
merged 1 commit into from
Sep 25, 2019
Merged

Clarify documentation for log.origin.file.* #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions code/go/ecs/log.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/field-details.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2121,7 +2121,7 @@ example: `org.elasticsearch.bootstrap.Bootstrap`
// ===============================================================

| log.origin.file.line
| The line number of the file which originated the log event.
| The line number of the file containing the source code which originated the log event.

type: integer

Expand All @@ -2132,7 +2132,7 @@ example: `42`
// ===============================================================

| log.origin.file.name
| The name of the source file which originated the log event.
| 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.

type: keyword

Expand Down
6 changes: 4 additions & 2 deletions generated/beats/fields.ecs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1576,13 +1576,15 @@
- name: origin.file.line
level: extended
type: integer
description: The line number of the file which originated the log event.
description: The line number of the file containing the source code which originated
the log event.
example: 42
- name: origin.file.name
level: extended
type: keyword
ignore_above: 1024
description: The name of the source file which originated the log event.
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.
example: Bootstrap.java
- name: origin.function
level: extended
Expand Down
6 changes: 4 additions & 2 deletions generated/ecs/ecs_flat.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2238,7 +2238,8 @@ log.logger:
short: Name of the logger.
type: keyword
log.origin.file.line:
description: The line number of the file which originated the log event.
description: The line number of the file containing the source code which originated
the log event.
example: 42
flat_name: log.origin.file.line
level: extended
Expand All @@ -2247,7 +2248,8 @@ log.origin.file.line:
short: The line number of the file which originated the log event.
type: integer
log.origin.file.name:
description: The name of the source file which originated the log event.
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.
example: Bootstrap.java
flat_name: log.origin.file.name
ignore_above: 1024
Expand Down
6 changes: 4 additions & 2 deletions generated/ecs/ecs_nested.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2543,7 +2543,8 @@ log:
short: Name of the logger.
type: keyword
origin.file.line:
description: The line number of the file which originated the log event.
description: The line number of the file containing the source code which originated
the log event.
example: 42
flat_name: log.origin.file.line
level: extended
Expand All @@ -2552,7 +2553,8 @@ log:
short: The line number of the file which originated the log event.
type: integer
origin.file.name:
description: The name of the source file which originated the log event.
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.
example: Bootstrap.java
flat_name: log.origin.file.name
ignore_above: 1024
Expand Down
4 changes: 2 additions & 2 deletions schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1546,7 +1546,7 @@
"type": "keyword"
},
"log.origin.file.line": {
"description": "The line number of the file which originated the log event.",
"description": "The line number of the file containing the source code which originated the log event.",
"example": "42",
"footnote": "",
"group": 2,
Expand All @@ -1556,7 +1556,7 @@
"type": "integer"
},
"log.origin.file.name": {
"description": "The name of the source file which originated the log event.",
"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.",
"example": "Bootstrap.java",
"footnote": "",
"group": 2,
Expand Down
5 changes: 3 additions & 2 deletions schemas/log.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,16 @@
example: Bootstrap.java
short: The file which originated the log event.
description: >
The name of the source file which originated the log event.
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.

- name: origin.file.line
level: extended
type: integer
example: 42
short: The line number of the file which originated the log event.
description: >
The line number of the file which originated the log event.
The line number of the file containing the source code which originated the log event.

- name: origin.function
level: extended
Expand Down