From 29290a938e9472cc55777292cb16d0997559db5a Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Wed, 14 Dec 2016 22:54:48 -0800 Subject: [PATCH] Backport: PRs #3160, #3176, and #3173 (#3196) * Add edits for docker module docs (#3176) * Restructure and edit processors content (#3160) * Deprecate filters option in metrictbeat --- .../docs/reference/configuration.asciidoc | 2 +- .../configuration/filebeat-options.asciidoc | 4 +- libbeat/docs/processors-config.asciidoc | 278 ++++++++++-------- metricbeat/_meta/beat.full.yml | 2 +- metricbeat/docs/fields.asciidoc | 36 +-- metricbeat/docs/metricbeat-filtering.asciidoc | 38 +-- metricbeat/docs/modules/docker.asciidoc | 6 +- metricbeat/docs/modules_list.asciidoc | 2 +- .../docs/reference/configuration.asciidoc | 2 +- .../configuration/metricbeat-options.asciidoc | 10 +- metricbeat/metricbeat.full.yml | 2 +- metricbeat/module/docker/_meta/docs.asciidoc | 4 +- metricbeat/module/docker/_meta/fields.yml | 4 +- .../docker/container/_meta/docs.asciidoc | 5 +- .../module/docker/container/_meta/fields.yml | 8 +- .../module/docker/cpu/_meta/docs.asciidoc | 4 +- metricbeat/module/docker/cpu/_meta/fields.yml | 12 +- .../module/docker/diskio/_meta/docs.asciidoc | 4 +- .../module/docker/diskio/_meta/fields.yml | 4 +- .../module/docker/info/_meta/docs.asciidoc | 5 +- .../module/docker/info/_meta/fields.yml | 4 +- .../module/docker/memory/_meta/docs.asciidoc | 4 +- .../module/docker/memory/_meta/fields.yml | 2 +- .../module/docker/network/_meta/docs.asciidoc | 4 +- .../module/docker/network/_meta/fields.yml | 2 +- packetbeat/docs/packetbeat-filtering.asciidoc | 2 +- .../docs/reference/configuration.asciidoc | 2 +- .../configuration/packetbeat-options.asciidoc | 5 +- .../docs/reference/configuration.asciidoc | 2 +- .../configuration/winlogbeat-options.asciidoc | 5 +- 30 files changed, 235 insertions(+), 229 deletions(-) diff --git a/filebeat/docs/reference/configuration.asciidoc b/filebeat/docs/reference/configuration.asciidoc index 8ab66d00c8c7..309158a36ed7 100644 --- a/filebeat/docs/reference/configuration.asciidoc +++ b/filebeat/docs/reference/configuration.asciidoc @@ -12,7 +12,6 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> * <> -* <> * <> * <> * <> @@ -22,6 +21,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> * <> +* <> include::configuration/filebeat-options.asciidoc[] diff --git a/filebeat/docs/reference/configuration/filebeat-options.asciidoc b/filebeat/docs/reference/configuration/filebeat-options.asciidoc index 17d81c628267..2e384f87dd8a 100644 --- a/filebeat/docs/reference/configuration/filebeat-options.asciidoc +++ b/filebeat/docs/reference/configuration/filebeat-options.asciidoc @@ -560,11 +560,11 @@ filebeat.shutdown_timeout: 5s include::../../../../libbeat/docs/generalconfig.asciidoc[] -include::../../../../libbeat/docs/processors-config.asciidoc[] - include::../../../../libbeat/docs/outputconfig.asciidoc[] include::../../../../libbeat/docs/shared-path-config.asciidoc[] include::../../../../libbeat/docs/loggingconfig.asciidoc[] +include::../../../../libbeat/docs/processors-config.asciidoc[] + diff --git a/libbeat/docs/processors-config.asciidoc b/libbeat/docs/processors-config.asciidoc index f339b4679320..c1201dcabed5 100644 --- a/libbeat/docs/processors-config.asciidoc +++ b/libbeat/docs/processors-config.asciidoc @@ -11,22 +11,21 @@ ////////////////////////////////////////////////////////////////////////// [[configuration-processors]] -=== Processors Configuration +== Processors include::../../libbeat/docs/processors.asciidoc[] -Each processor has associated an action with a set of parameters and optionally a condition. If the condition is -present, then the action is executed only if the condition -is fulfilled. If no condition is passed then the action is always executed. +To define a processor, you specify the processor name, an optional condition, +and a set of parameters: [source,yaml] ------ processors: - - : + - : when: - - : + - : when: @@ -34,21 +33,33 @@ processors: ------ -where can be a way to select the fields that are exported or a way to add meta data to the event , contains the definition of the condition. -and is the list of parameters passed along the . +Where: + +* specifies a <> that performs some kind +of action, such as selecting the fields that are exported or adding metadata to +the event. +* specifies an optional <>. If the +condition is present, then the action is executed only if the condition is +fulfilled. If no condition is passed, then the action is always executed. +* is the list of parameters to pass to the processor. See <> for specific {beatname_uc} examples. -[[filtering-condition]] -==== Condition +[float] +[[conditions]] +=== Conditions -Each condition receives a field to compare or multiple fields under the same condition and then `AND` is used between -them. You can see a list of the <>. +Each condition receives a field to compare. You can specify multiple fields +under the same condition by using `AND` between the fields (for example, +`field1 AND field2`). -For each field, you can specify a simple field name or a nested map, for example `dns.question.name`. +For each field, you can specify a simple field name or a nested map, for +example `dns.question.name`. +See <> for a list of all the fields that are exported by +{beatname_uc}. -A condition can be: +The supported conditions are: * <> * <> @@ -59,14 +70,15 @@ A condition can be: * <> - +[float] [[condition-equals]] -===== equals +==== equals -With the `equals` condition, you can compare if a field has a certain value. The condition accepts only an integer or a string -value. +With the `equals` condition, you can compare if a field has a certain value. +The condition accepts only an integer or a string value. -For example, the following condition checks if the response code of the HTTP transaction is 200: +For example, the following condition checks if the response code of the HTTP +transaction is 200: [source,yaml] ------- @@ -74,13 +86,15 @@ equals: http.response.code: 200 ------- +[float] [[condition-contains]] -===== contains +==== contains The `contains` condition checks if a value is part of a field. The field can be a string or an array of strings. The condition accepts only a string value. -For example, the following condition checks if an error is part of the transaction status: +For example, the following condition checks if an error is part of the +transaction status: [source,yaml] ------ @@ -88,13 +102,15 @@ contains: status: "Specific error" ------ - +[float] [[condition-regexp]] -===== regexp +==== regexp -The `regexp` condition checks the field against a regular expression. The condition accepts only strings. +The `regexp` condition checks the field against a regular expression. The +condition accepts only strings. -For example, the following condition checks if the process name starts with `foo`: +For example, the following condition checks if the process name starts with +`foo`: [source,yaml] ----- @@ -102,14 +118,16 @@ reqexp: system.process.name: "foo.*" ----- +[float] [[condition-range]] -===== range +==== range -The `range` condition checks if the field is in a certain range of values. The condition supports `lt`, `lte`, `gt` and `gte`. The -condition accepts only integer or float values. +The `range` condition checks if the field is in a certain range of values. The +condition supports `lt`, `lte`, `gt` and `gte`. The condition accepts only +integer or float values. -For example, the following condition checks for failed HTTP transaction by comparing the `http.response.code` field with -400. +For example, the following condition checks for failed HTTP transactions by +comparing the `http.response.code` field with 400. [source,yaml] @@ -119,7 +137,7 @@ range: gte: 400 ------ -that can be also translated to: +This can also be written as: [source,yaml] ---- @@ -127,7 +145,8 @@ range: http.response.code.gte: 400 ---- -For example, the following condition checks if the CPU usage in percentage has a value between 0.5 and 0.8. +The following condition checks if the CPU usage in percentage has a value +between 0.5 and 0.8. [source,yaml] ------ @@ -137,8 +156,9 @@ range: ------ +[float] [[condition-or]] -===== OR +==== OR The `or` operator receives a list of conditions. @@ -152,7 +172,8 @@ or: ------- -For example the condition `http.response.code = 304 OR http.response.code = 404` translates to: +For example, to configure the condition +`http.response.code = 304 OR http.response.code = 404`: [source,yaml] ------ @@ -163,9 +184,9 @@ or: http.response.code: 404 ------ - +[float] [[condition-and]] -===== AND +==== AND The `and` operator receives a list of conditions. @@ -179,7 +200,8 @@ and: ------- -For example the condition `http.response.code = 200 AND status = OK` translates to: +For example, to configure the condition +`http.response.code = 200 AND status = OK`: [source,yaml] ------ @@ -202,8 +224,9 @@ or: ------ +[float] [[condition-not]] -===== NOT +==== NOT The `not` operator receives the condition to negate. @@ -214,7 +237,7 @@ not: ------- -For example the condition `NOT status = OK` translates to: +For example, to configure the condition `NOT status = OK`: [source,yaml] ------ @@ -223,82 +246,24 @@ not: status: OK ------ +[float] +[[processors]] +=== Processors +The supported processors are: -==== Actions - -The supported actions are: - - * <> - * <> - * <> * <> * <> - -See <> for the full list of possible fields. - -[[include-fields]] -===== include_fields - -The `include_fields` action specifies what fields to export if a certain condition is fulfilled. The condition is -optional and if it's missing then the defined fields are always exported. The `@timestamp` and -`type` fields are always exported, even if they are not defined in the `include_fields` list. - -[source,yaml] -------- -processors: - - include_fields: - when: - condition - fields: ["field1", "field2", ...] -------- - -You can specify multiple `include_fields` actions under the `processors` section. - - -NOTE: If you define an empty list of fields under `include_fields`, then only the required fields, `@timestamp` and `type`, are -exported. - - -[[drop-fields]] -===== drop_fields - -The `drop_fields` action specifies what fields to drop if a certain condition is fulfilled. The condition is optional -and if it's missing then the defined fields are always dropped. The `@timestamp` and `type` fields cannot be dropped, -even if they show up in the `drop_fields` list. - -[source,yaml] ------------------------------------------------------ -processors: - - drop_fields: - when: - condition - fields: ["field1", "field2", ...] ------------------------------------------------------ - -NOTE: If you define an empty list of fields under `drop_fields`, then no fields are dropped. - - -[[drop-event]] -===== drop_event - -The `drop_event` action drops the entire event if the associated condition is fulfilled. The condition is mandatory, as -without one all the events are dropped. - -[source,yaml] ------- -processors: - - drop_event: - when: - condition ------- + * <> + * <> + * <> [[add-cloud-metadata]] -===== add_cloud_metadata +=== add_cloud_metadata -The `add_cloud_metadata` action enriches each event with instance metadata from -the machine's hosting provider. At startup it will detect the hosting provider -and cache the instance metadata. +The `add_cloud_metadata` processor enriches each event with instance metadata +from the machine's hosting provider. At startup it will detect the hosting +provider and cache the instance metadata. Three cloud providers are supported. @@ -309,14 +274,16 @@ Three cloud providers are supported. The simple configuration below enables the processor. [source,yaml] --------------------------------------------------------------------------------- +------------------------------------------------------------------------------- processors: - add_cloud_metadata: --------------------------------------------------------------------------------- +------------------------------------------------------------------------------- -The `add_cloud_metadata` action has one optional configuration setting named +The `add_cloud_metadata` processor has one optional configuration setting named `timeout` that specifies the maximum amount of time to wait for a successful -response when detecting the hosting provider. The default timeout value is `3s`. +response when detecting the hosting provider. The default timeout value is +`3s`. + If a timeout occurs then no instance metadata will be added to the events. This makes it possible to enable this processor for all your deployments (in the cloud or on-premise). @@ -327,7 +294,7 @@ examples for each of the supported providers. _EC2_ [source,json] --------------------------------------------------------------------------------- +------------------------------------------------------------------------------- { "meta": { "cloud": { @@ -339,12 +306,12 @@ _EC2_ } } } --------------------------------------------------------------------------------- +------------------------------------------------------------------------------- _Digital Ocean_ [source,json] --------------------------------------------------------------------------------- +------------------------------------------------------------------------------- { "meta": { "cloud": { @@ -354,12 +321,12 @@ _Digital Ocean_ } } } --------------------------------------------------------------------------------- +------------------------------------------------------------------------------- _GCE_ [source,json] --------------------------------------------------------------------------------- +------------------------------------------------------------------------------- { "meta": { "cloud": { @@ -371,12 +338,13 @@ _GCE_ } } } --------------------------------------------------------------------------------- +------------------------------------------------------------------------------- [[decode-json-fields]] -===== decode_json_fields +=== decode_json_fields -The `decode_json_fields` action decodes fields containing JSON strings and replaces the strings with valid JSON objects. +The `decode_json_fields` processor decodes fields containing JSON strings and +replaces the strings with valid JSON objects. [source,yaml] ----------------------------------------------------- @@ -387,8 +355,74 @@ processors: max_depth: 1 ----------------------------------------------------- -The `decode_json_fields` action has the following configuration settings: +The `decode_json_fields` processor has the following configuration settings: `fields`:: The fields containing JSON strings to decode. -`process_array`:: (Optional) A boolean that specifies whether to process arrays. The default is false. +`process_array`:: (Optional) A boolean that specifies whether to process +arrays. The default is false. `max_depth`:: (Optional) The maximum parsing depth. The default is 1. + +[[drop-event]] +=== drop_event + +The `drop_event` processor drops the entire event if the associated condition +is fulfilled. The condition is mandatory, because without one, all the events +are dropped. + +[source,yaml] +------ +processors: + - drop_event: + when: + condition +------ + +See <> for a list of supported conditions. + +[[drop-fields]] +=== drop_fields + +The `drop_fields` processor specifies which fields to drop if a certain +condition is fulfilled. The condition is optional. If it's missing, the +specified fields are always dropped. The `@timestamp` and `type` fields cannot +be dropped, even if they show up in the `drop_fields` list. + +[source,yaml] +----------------------------------------------------- +processors: + - drop_fields: + when: + condition + fields: ["field1", "field2", ...] +----------------------------------------------------- + +See <> for a list of supported conditions. + +NOTE: If you define an empty list of fields under `drop_fields`, then no fields +are dropped. + +[[include-fields]] +=== include_fields + +The `include_fields` processor specifies which fields to export if a certain +condition is fulfilled. The condition is optional. If it's missing, the +specified fields are always exported. The `@timestamp` and `type` fields are +always exported, even if they are not defined in the `include_fields` list. + +[source,yaml] +------- +processors: + - include_fields: + when: + condition + fields: ["field1", "field2", ...] +------- + +See <> for a list of supported conditions. + +You can specify multiple `include_fields` processors under the `processors` +section. + +NOTE: If you define an empty list of fields under `include_fields`, then only +the required fields, `@timestamp` and `type`, are exported. + diff --git a/metricbeat/_meta/beat.full.yml b/metricbeat/_meta/beat.full.yml index a915b2b4221f..8bcb0c7ec7c9 100644 --- a/metricbeat/_meta/beat.full.yml +++ b/metricbeat/_meta/beat.full.yml @@ -67,7 +67,7 @@ metricbeat.modules: # Password of hosts. Empty by default #password: test123 -#------------------------------- docker Module ------------------------------- +#------------------------------- Docker Module ------------------------------- #- module: docker #metricsets: ["cpu", "info", "memory", "network", "diskio", "container"] #hosts: ["unix:///var/run/docker.sock"] diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc index 00e568fe07b7..d025cacf4509 100644 --- a/metricbeat/docs/fields.asciidoc +++ b/metricbeat/docs/fields.asciidoc @@ -506,7 +506,7 @@ The document type. Always set to "metricsets". [[exported-fields-docker]] -== docker Fields +== Docker Fields experimental[] Docker stats collected from Docker. @@ -516,14 +516,14 @@ Docker stats collected from Docker. [float] == docker Fields -docker contains different informations and statistics of docker's containers running +Information and statistics about docker's running containers. [float] == container Fields -Docker container metrics +Docker container metrics. @@ -532,7 +532,7 @@ Docker container metrics type: keyword -Executed command in docker container. +Command that was executed in the Docker container. [float] @@ -540,7 +540,7 @@ Executed command in docker container. type: date -Date then the container was created. +Date when the container was created. [float] @@ -595,13 +595,13 @@ Total size of all the files in the container. type: long -Size of the files which have been created or changed since creation. +Size of the files that have been created or changed since creation. [float] == cpu Fields -Runtime cpu metrics. +Runtime CPU metrics. @@ -612,7 +612,7 @@ type: scaled_float format: percentage -The system kernel consumed by The Docker server. +The system kernel consumed by the Docker server. [float] @@ -620,7 +620,7 @@ The system kernel consumed by The Docker server. type: long -Cpu kernel tikcs +CPU kernel ticks. [float] @@ -637,7 +637,7 @@ format: percentage type: long -Cpu system tikcs +CPU system ticks. [float] @@ -654,7 +654,7 @@ format: percentage type: long -Cpu user tikcs +CPU user ticks [float] @@ -664,13 +664,13 @@ type: scaled_float format: percentage -Total cpu usage. +Total CPU usage. [float] == diskio Fields -Diskio metrics. +Disk I/O metrics. @@ -695,14 +695,14 @@ Number of writes. type: scaled_float -Reads and writes numbers combined. +Number of reads and writes combined. [float] == info Fields experimental[] -info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information +Info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information. @@ -750,7 +750,7 @@ Total number of existing containers. type: keyword -Unique docker host identifier. +Unique Docker host identifier. [float] @@ -789,7 +789,7 @@ Memory limit. [float] == rss Fields -Rss memory stats. +RSS memory stats. @@ -849,7 +849,7 @@ Total memory usage. [float] == network Fields -Netowrk metrics. +Network metrics. diff --git a/metricbeat/docs/metricbeat-filtering.asciidoc b/metricbeat/docs/metricbeat-filtering.asciidoc index 82eb123c49d6..e312d18ce8ca 100644 --- a/metricbeat/docs/metricbeat-filtering.asciidoc +++ b/metricbeat/docs/metricbeat-filtering.asciidoc @@ -1,44 +1,10 @@ [[filtering-and-enhancing-data]] == Filtering and Enhancing the Exported Data -When your use case requires only a subset of the data exported by Metricbeat or you need to add metadata, -you can <>, or you can <>. - - -[float] -[[metricbeat-filtering-overview]] -=== Metricbeat Module Filtering - -Each module accepts a list of filters in its configuration. These filters are -applied to the data generated by the module. These filters are applied to the -module data prior to the addition of the common beat fields like `beat.hostname` -and `type` so they can only be used to filter fields from the module. - -The following example reduces the exported fields of the Redis module to -include only the `redis.info.memory` fields. - -[source,yaml] ----- -metricbeat.modules: -- module: redis - metricsets: ["info"] - period: 1s - hosts: ["127.0.0.1:6379"] - enabled: true - filters: - - include_fields: - fields: ['memory'] ----- - -[float] -[[defining-processors]] -=== Defining Processors - include::../../libbeat/docs/processors.asciidoc[] -For example, the following filters configuration reduces the exported fields by -dropping the `beat.name` and `beat.hostname` fields under `beat`, from all documents. +For example, the following configuration reduces the exported fields by +dropping the `beat.name` and `beat.hostname` fields under `beat` from all documents. [source, yaml] ---- diff --git a/metricbeat/docs/modules/docker.asciidoc b/metricbeat/docs/modules/docker.asciidoc index bf916b54a437..e743c67e7037 100644 --- a/metricbeat/docs/modules/docker.asciidoc +++ b/metricbeat/docs/modules/docker.asciidoc @@ -3,18 +3,18 @@ This file is generated! See scripts/docs_collector.py //// [[metricbeat-module-docker]] -== docker Module +== Docker Module experimental[] -This is the docker Module. +This module fetches metrics from https://www.docker.com/[Docker] containers. [float] === Example Configuration -The docker module supports the standard configuration options that are described +The Docker module supports the standard configuration options that are described in <>. Here is an example configuration: [source,yaml] diff --git a/metricbeat/docs/modules_list.asciidoc b/metricbeat/docs/modules_list.asciidoc index e4e2e8a4a81d..3229b250582a 100644 --- a/metricbeat/docs/modules_list.asciidoc +++ b/metricbeat/docs/modules_list.asciidoc @@ -3,7 +3,7 @@ This file is generated! See scripts/docs_collector.py //// * <> - * <> + * <> * <> * <> * <> diff --git a/metricbeat/docs/reference/configuration.asciidoc b/metricbeat/docs/reference/configuration.asciidoc index af2bdc7c0b37..4e47584f9777 100644 --- a/metricbeat/docs/reference/configuration.asciidoc +++ b/metricbeat/docs/reference/configuration.asciidoc @@ -10,7 +10,6 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> -* <> * <> * <> * <> @@ -20,5 +19,6 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> * <> +* <> include::configuration/metricbeat-options.asciidoc[] diff --git a/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc b/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc index 0a4f06bb0b34..a44607d2fa6f 100644 --- a/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc +++ b/metricbeat/docs/reference/configuration/metricbeat-options.asciidoc @@ -62,15 +62,17 @@ A list of tags that will be sent with the metricset event. This setting is optio ===== filters -A list of filters to apply to the data generated by the module. For more detail on how to configure -filters, see <>. +deprecated[5.1,This option will be renamed and changed in a future release] -include::../../../../libbeat/docs/generalconfig.asciidoc[] +A list of filters to apply to the data generated by the module. -include::../../../../libbeat/docs/processors-config.asciidoc[] +include::../../../../libbeat/docs/generalconfig.asciidoc[] include::../../../../libbeat/docs/outputconfig.asciidoc[] include::../../../../libbeat/docs/shared-path-config.asciidoc[] include::../../../../libbeat/docs/loggingconfig.asciidoc[] + +include::../../../../libbeat/docs/processors-config.asciidoc[] + diff --git a/metricbeat/metricbeat.full.yml b/metricbeat/metricbeat.full.yml index 40bdf7c8c6ca..e791cb4b9495 100644 --- a/metricbeat/metricbeat.full.yml +++ b/metricbeat/metricbeat.full.yml @@ -67,7 +67,7 @@ metricbeat.modules: # Password of hosts. Empty by default #password: test123 -#------------------------------- docker Module ------------------------------- +#------------------------------- Docker Module ------------------------------- #- module: docker #metricsets: ["cpu", "info", "memory", "network", "diskio", "container"] #hosts: ["unix:///var/run/docker.sock"] diff --git a/metricbeat/module/docker/_meta/docs.asciidoc b/metricbeat/module/docker/_meta/docs.asciidoc index 4ca0b02df71e..1369b66cf521 100644 --- a/metricbeat/module/docker/_meta/docs.asciidoc +++ b/metricbeat/module/docker/_meta/docs.asciidoc @@ -1,6 +1,6 @@ -== docker Module +== Docker Module experimental[] -This is the docker Module. +This module fetches metrics from https://www.docker.com/[Docker] containers. diff --git a/metricbeat/module/docker/_meta/fields.yml b/metricbeat/module/docker/_meta/fields.yml index 868be127473e..4dabcc016420 100644 --- a/metricbeat/module/docker/_meta/fields.yml +++ b/metricbeat/module/docker/_meta/fields.yml @@ -1,5 +1,5 @@ - key: docker - title: "docker" + title: "Docker" description: > experimental[] @@ -9,5 +9,5 @@ - name: docker type: group description: > - docker contains different informations and statistics of docker's containers running + Information and statistics about docker's running containers. fields: diff --git a/metricbeat/module/docker/container/_meta/docs.asciidoc b/metricbeat/module/docker/container/_meta/docs.asciidoc index a3eee73e7bfa..3c095e4e9c0e 100644 --- a/metricbeat/module/docker/container/_meta/docs.asciidoc +++ b/metricbeat/module/docker/container/_meta/docs.asciidoc @@ -1,3 +1,4 @@ -=== docker container MetricSet +=== Docker Container Metricset -This is the container metricset of the module docker. +The Docker `container` metricset collects information and statistics about +running Docker containers. diff --git a/metricbeat/module/docker/container/_meta/fields.yml b/metricbeat/module/docker/container/_meta/fields.yml index 6aaadc43dcfa..cf56b0a142f8 100644 --- a/metricbeat/module/docker/container/_meta/fields.yml +++ b/metricbeat/module/docker/container/_meta/fields.yml @@ -1,16 +1,16 @@ - name: container type: group description: > - Docker container metrics + Docker container metrics. fields: - name: command type: keyword description: > - Executed command in docker container. + Command that was executed in the Docker container. - name: created type: date description: > - Date then the container was created. + Date when the container was created. - name: id type: keyword description: > @@ -39,4 +39,4 @@ - name: rw type: long description: > - Size of the files which have been created or changed since creation. + Size of the files that have been created or changed since creation. diff --git a/metricbeat/module/docker/cpu/_meta/docs.asciidoc b/metricbeat/module/docker/cpu/_meta/docs.asciidoc index d39b779e1ece..16ae50695c15 100644 --- a/metricbeat/module/docker/cpu/_meta/docs.asciidoc +++ b/metricbeat/module/docker/cpu/_meta/docs.asciidoc @@ -1,3 +1,3 @@ -=== docker cpu MetricSet +=== Docker CPU Metricset -This is the cpu metricset of the module docker. +The Docker `cpu` metricset collects runtime CPU metrics. diff --git a/metricbeat/module/docker/cpu/_meta/fields.yml b/metricbeat/module/docker/cpu/_meta/fields.yml index 5d71f7dfc742..3d7704a88444 100644 --- a/metricbeat/module/docker/cpu/_meta/fields.yml +++ b/metricbeat/module/docker/cpu/_meta/fields.yml @@ -1,17 +1,17 @@ - name: cpu type: group description: > - Runtime cpu metrics. + Runtime CPU metrics. fields: - name: kernel.pct type: scaled_float format: percentage description: > - The system kernel consumed by The Docker server. + The system kernel consumed by the Docker server. - name: kernel.ticks type: long description: > - Cpu kernel tikcs + CPU kernel ticks. - name: system.pct type: scaled_float format: percentage @@ -19,7 +19,7 @@ - name: system.ticks type: long description: > - Cpu system tikcs + CPU system ticks. - name: user.pct type: scaled_float format: percentage @@ -27,12 +27,12 @@ - name: user.ticks type: long description: > - Cpu user tikcs + CPU user ticks - name: total.pct type: scaled_float format: percentage description: > - Total cpu usage. + Total CPU usage. # TODO: how to document cpu list? #- name: core # type: list diff --git a/metricbeat/module/docker/diskio/_meta/docs.asciidoc b/metricbeat/module/docker/diskio/_meta/docs.asciidoc index fd866e984226..3bd99f6633d2 100644 --- a/metricbeat/module/docker/diskio/_meta/docs.asciidoc +++ b/metricbeat/module/docker/diskio/_meta/docs.asciidoc @@ -1,3 +1,3 @@ -=== docker diskio MetricSet +=== Docker Diskio Metricset -This is the diskio metricset of the module docker. +The Docker `diskio` metricset collects disk I/O metrics. \ No newline at end of file diff --git a/metricbeat/module/docker/diskio/_meta/fields.yml b/metricbeat/module/docker/diskio/_meta/fields.yml index e5f51ad5dc14..540735d6b693 100644 --- a/metricbeat/module/docker/diskio/_meta/fields.yml +++ b/metricbeat/module/docker/diskio/_meta/fields.yml @@ -1,7 +1,7 @@ - name: diskio type: group description: > - Diskio metrics. + Disk I/O metrics. fields: - name: reads type: scaled_float @@ -14,4 +14,4 @@ - name: total type: scaled_float description: > - Reads and writes numbers combined. + Number of reads and writes combined. diff --git a/metricbeat/module/docker/info/_meta/docs.asciidoc b/metricbeat/module/docker/info/_meta/docs.asciidoc index e81f04e10d5c..fc4b8cb81c10 100644 --- a/metricbeat/module/docker/info/_meta/docs.asciidoc +++ b/metricbeat/module/docker/info/_meta/docs.asciidoc @@ -1,3 +1,4 @@ -=== docker info MetricSet +=== Docker Info Metricset -This is the info metricset of the module docker. +The Docker `info` metricset collects system-wide information based on the +https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information[Docker Remote API]. \ No newline at end of file diff --git a/metricbeat/module/docker/info/_meta/fields.yml b/metricbeat/module/docker/info/_meta/fields.yml index 51fc8c71cc73..76dfcb402910 100644 --- a/metricbeat/module/docker/info/_meta/fields.yml +++ b/metricbeat/module/docker/info/_meta/fields.yml @@ -3,7 +3,7 @@ description: > experimental[] - info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information + Info metrics based on https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/display-system-wide-information. fields: - name: containers type: group @@ -29,7 +29,7 @@ - name: id type: keyword description: > - Unique docker host identifier. + Unique Docker host identifier. - name: images type: long diff --git a/metricbeat/module/docker/memory/_meta/docs.asciidoc b/metricbeat/module/docker/memory/_meta/docs.asciidoc index f880881a84a0..0ee70f959323 100644 --- a/metricbeat/module/docker/memory/_meta/docs.asciidoc +++ b/metricbeat/module/docker/memory/_meta/docs.asciidoc @@ -1,3 +1,3 @@ -=== docker memory MetricSet +=== Docker Memory Metricset -This is the memory metricset of the module docker. +The Docker `memory` metricset collects memory metrics. \ No newline at end of file diff --git a/metricbeat/module/docker/memory/_meta/fields.yml b/metricbeat/module/docker/memory/_meta/fields.yml index a26b8590b029..be8b2a8c6d4b 100644 --- a/metricbeat/module/docker/memory/_meta/fields.yml +++ b/metricbeat/module/docker/memory/_meta/fields.yml @@ -16,7 +16,7 @@ - name: rss type: group description: > - Rss memory stats. + RSS memory stats. fields: - name: total type: long diff --git a/metricbeat/module/docker/network/_meta/docs.asciidoc b/metricbeat/module/docker/network/_meta/docs.asciidoc index 6b5e778a1827..78bb5abef2ad 100644 --- a/metricbeat/module/docker/network/_meta/docs.asciidoc +++ b/metricbeat/module/docker/network/_meta/docs.asciidoc @@ -1,3 +1,3 @@ -=== docker network MetricSet +=== Docker Network Metricset -This is the network metricset of the module docker. +The Docker `network` metricset collects network metrics. \ No newline at end of file diff --git a/metricbeat/module/docker/network/_meta/fields.yml b/metricbeat/module/docker/network/_meta/fields.yml index 98a668729853..e443e345366c 100644 --- a/metricbeat/module/docker/network/_meta/fields.yml +++ b/metricbeat/module/docker/network/_meta/fields.yml @@ -1,7 +1,7 @@ - name: network type: group description: > - Netowrk metrics. + Network metrics. fields: - name: interface diff --git a/packetbeat/docs/packetbeat-filtering.asciidoc b/packetbeat/docs/packetbeat-filtering.asciidoc index af01dafc8d4a..d8d75e166658 100644 --- a/packetbeat/docs/packetbeat-filtering.asciidoc +++ b/packetbeat/docs/packetbeat-filtering.asciidoc @@ -8,7 +8,7 @@ requests and their response codes are reported: [source, yaml] ----------------------------------------------------- -filters: +processors: - include_fields: fields: - bytes_in diff --git a/packetbeat/docs/reference/configuration.asciidoc b/packetbeat/docs/reference/configuration.asciidoc index 73f6bd074036..8abf934423c8 100644 --- a/packetbeat/docs/reference/configuration.asciidoc +++ b/packetbeat/docs/reference/configuration.asciidoc @@ -13,7 +13,6 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> * <> -* <> * <> * <> * <> @@ -24,6 +23,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> * <> +* <> NOTE: Packetbeat maintains a real-time topology map of all the servers in your network. See <> for more details. diff --git a/packetbeat/docs/reference/configuration/packetbeat-options.asciidoc b/packetbeat/docs/reference/configuration/packetbeat-options.asciidoc index e62dd3dc2cfc..75bf10008e46 100644 --- a/packetbeat/docs/reference/configuration/packetbeat-options.asciidoc +++ b/packetbeat/docs/reference/configuration/packetbeat-options.asciidoc @@ -794,8 +794,6 @@ process' command line as read from `/proc//cmdline`. include::../../../../libbeat/docs/generalconfig.asciidoc[] -include::../../../../libbeat/docs/processors-config.asciidoc[] - include::../../../../libbeat/docs/outputconfig.asciidoc[] include::../../../../libbeat/docs/shared-path-config.asciidoc[] @@ -804,3 +802,6 @@ include::../../../../libbeat/docs/loggingconfig.asciidoc[] include::./runconfig.asciidoc[] +include::../../../../libbeat/docs/processors-config.asciidoc[] + + diff --git a/winlogbeat/docs/reference/configuration.asciidoc b/winlogbeat/docs/reference/configuration.asciidoc index 8b8dbc5f349b..8794d8ce7505 100644 --- a/winlogbeat/docs/reference/configuration.asciidoc +++ b/winlogbeat/docs/reference/configuration.asciidoc @@ -11,7 +11,6 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> -* <> * <> * <> * <> @@ -21,6 +20,7 @@ configuration settings, you need to restart {beatname_uc} to pick up the changes * <> * <> * <> +* <> include::configuration/winlogbeat-options.asciidoc[] diff --git a/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc b/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc index 20e8c74ceb20..c5922243bef1 100644 --- a/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc +++ b/winlogbeat/docs/reference/configuration/winlogbeat-options.asciidoc @@ -319,10 +319,11 @@ The metrics are served as a JSON document. The metrics include: include::../../../../libbeat/docs/generalconfig.asciidoc[] -include::../../../../libbeat/docs/processors-config.asciidoc[] - include::../../../../libbeat/docs/outputconfig.asciidoc[] include::../../../../libbeat/docs/shared-path-config.asciidoc[] include::../../../../libbeat/docs/loggingconfig.asciidoc[] + +include::../../../../libbeat/docs/processors-config.asciidoc[] +