Merge pull request #2409 from dedemorton/beats_issue#2280_master

Clarify how to set the shipper name
elastic · Aug 31, 2016 · 34d5825 · 34d5825
2 parents 45202c5 + 1bd0293
commit 34d5825
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 6 deletions.
diff --git a/filebeat/docs/fields.asciidoc b/filebeat/docs/fields.asciidoc
@@ -26,7 +26,7 @@ Contains common beat fields available in all event types.
 [float]
 === beat.name
 
-The name of the Beat sending the log messages. If the shipper name is set in the configuration file, then that value is used. If it is not set, the hostname is used.
+The name of the Beat sending the log messages. If the Beat name is set in the configuration file, then that value is used. If it is not set, the hostname is used. To set the Beat name, use the `name` option in the configuration file.
 
 
 [float]

diff --git a/libbeat/_meta/fields.yml b/libbeat/_meta/fields.yml
@@ -14,9 +14,10 @@ fields:
 
     - name: beat.name
       description: >
-        The name of the Beat sending the log messages. If the shipper name is
+        The name of the Beat sending the log messages. If the Beat name is
         set in the configuration file, then that value is used. If it is not
-        set, the hostname is used.
+        set, the hostname is used. To set the Beat name, use the `name`
+        option in the configuration file.
     - name: beat.hostname
       description: >
         The hostname as returned by the operating system on which the Beat is

diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -363,7 +363,7 @@ Contains common beat fields available in all event types.
 [float]
 === beat.name
 
-The name of the Beat sending the log messages. If the shipper name is set in the configuration file, then that value is used. If it is not set, the hostname is used.
+The name of the Beat sending the log messages. If the Beat name is set in the configuration file, then that value is used. If it is not set, the hostname is used. To set the Beat name, use the `name` option in the configuration file.
 
 
 [float]

diff --git a/packetbeat/docs/fields.asciidoc b/packetbeat/docs/fields.asciidoc
@@ -365,7 +365,7 @@ Contains common beat fields available in all event types.
 [float]
 === beat.name
 
-The name of the Beat sending the log messages. If the shipper name is set in the configuration file, then that value is used. If it is not set, the hostname is used.
+The name of the Beat sending the log messages. If the Beat name is set in the configuration file, then that value is used. If it is not set, the hostname is used. To set the Beat name, use the `name` option in the configuration file.
 
 
 [float]

diff --git a/winlogbeat/docs/fields.asciidoc b/winlogbeat/docs/fields.asciidoc
@@ -27,7 +27,7 @@ Contains common beat fields available in all event types.
 [float]
 === beat.name
 
-The name of the Beat sending the log messages. If the shipper name is set in the configuration file, then that value is used. If it is not set, the hostname is used.
+The name of the Beat sending the log messages. If the Beat name is set in the configuration file, then that value is used. If it is not set, the hostname is used. To set the Beat name, use the `name` option in the configuration file.
 
 
 [float]
-Original file line number
+Diff line change
@@ Expand Up / @@ -26,7 +26,7 @@ Contains common beat fields available in all event types. @@
     [float]
     === beat.name
-    The name of the Beat sending the log messages. If the shipper name is set in the configuration file, then that value is used. If it is not set, the hostname is used.
+    The name of the Beat sending the log messages. If the Beat name is set in the configuration file, then that value is used. If it is not set, the hostname is used. To set the Beat name, use the `name` option in the configuration file.
     [float]
@@ Expand Down @@