Clarify documentation for log.origin.file.*

based on discussions in elastic#563
felixbarny · Sep 25, 2019 · 017d5ef · 017d5ef
1 parent 6855c81
commit 017d5ef
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 14 deletions.
diff --git a/code/go/ecs/log.go b/code/go/ecs/log.go
diff --git a/docs/field-details.asciidoc b/docs/field-details.asciidoc
@@ -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
 
@@ -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
 

diff --git a/generated/beats/fields.ecs.yml b/generated/beats/fields.ecs.yml
@@ -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

diff --git a/generated/ecs/ecs_flat.yml b/generated/ecs/ecs_flat.yml
@@ -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
@@ -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

diff --git a/generated/ecs/ecs_nested.yml b/generated/ecs/ecs_nested.yml
@@ -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
@@ -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

diff --git a/schema.json b/schema.json
@@ -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, 
@@ -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, 

diff --git a/schemas/log.yml b/schemas/log.yml
@@ -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