diff --git a/filebeat/docs/fields.asciidoc b/filebeat/docs/fields.asciidoc index 97016bfbd2e4..42806cf28745 100644 --- 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 index d6bd321bb281..28c93cc6b8f9 100644 --- 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 index a119933e067d..798a9203f954 100644 --- 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 index 283b0669ca5c..16ccb30bdaff 100644 --- 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 index b5a305310ba5..d8e838a7f50b 100644 --- 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]