diff --git a/auditbeat/docs/modules.asciidoc b/auditbeat/docs/modules.asciidoc index 061557bfd97c..d94daa75bad1 100644 --- a/auditbeat/docs/modules.asciidoc +++ b/auditbeat/docs/modules.asciidoc @@ -7,9 +7,4 @@ This section contains detailed information about the metric collecting modules contained in {beatname_uc}. More details about each module can be found under the links below. -//pass macro block used here to remove Edit links from modules documentation because it is generated -pass::[] include::modules_list.asciidoc[] - - - diff --git a/docs/devguide/newbeat.asciidoc b/docs/devguide/newbeat.asciidoc index e4a3974c83b6..bc775a467d9f 100644 --- a/docs/devguide/newbeat.asciidoc +++ b/docs/devguide/newbeat.asciidoc @@ -44,7 +44,7 @@ branch ({branch} in the example below): ["source","sh",subs="attributes"] ---- -cd $\{GOPATH\}/src/github.com/elastic/beats +cd ${GOPATH}/src/github.com/elastic/beats git checkout {branch} ---- diff --git a/filebeat/docs/autodiscover-hints.asciidoc b/filebeat/docs/autodiscover-hints.asciidoc index f6bc57a4a1f7..8fd318be8030 100644 --- a/filebeat/docs/autodiscover-hints.asciidoc +++ b/filebeat/docs/autodiscover-hints.asciidoc @@ -42,18 +42,18 @@ Instead of using raw `docker` input, specifies the module to use to parse logs f When module is configured, map container logs to module filesets. You can either configure a single fileset like this: -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- co.elastic.logs/fileset: access -------------------------------------------------------------------------------------- +----- Or configure a fileset per stream in the container (stdout and stderr): -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- co.elastic.logs/fileset.stdout: access co.elastic.logs/fileset.stderr: error -------------------------------------------------------------------------------------- +----- [float] ===== `co.elastic.logs/raw` @@ -61,10 +61,10 @@ When an entire input/module configuration needs to be completely set the `raw` h stringified JSON of the input configuration. `raw` overrides every other hint and can be used to create both a single or a list of configurations. -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- co.elastic.logs/raw: "[{\"containers\":{\"ids\":[\"${data.container.id}\"]},\"multiline\":{\"negate\":\"true\",\"pattern\":\"^test\"},\"type\":\"docker\"}]" -------------------------------------------------------------------------------------- +----- [float] ===== `co.elastic.logs/processors` @@ -75,11 +75,11 @@ of supported processors. In order to provide ordering of the processor definition, numbers can be provided. If not, the hints builder will do arbitrary ordering: -["source","yaml"] -------------------------------------------------------------------------------------- +[source,yaml] +----- co.elastic.logs/processors.1.dissect.tokenizer: "%{key1} %{key2}" co.elastic.logs/processors.dissect.tokenizer: "%{key2} %{key1}" -------------------------------------------------------------------------------------- +----- In the above sample the processor definition tagged with `1` would be executed first. @@ -88,18 +88,18 @@ In the above sample the processor definition tagged with `1` would be executed f Kubernetes autodiscover provider supports hints in Pod annotations. To enable it just set `hints.enabled`: -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- filebeat.autodiscover: providers: - type: kubernetes hints.enabled: true -------------------------------------------------------------------------------------- +----- You can configure the default config that will be launched when a new container is seen, like this: -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- filebeat.autodiscover: providers: - type: kubernetes @@ -108,29 +108,29 @@ filebeat.autodiscover: type: container paths: - /var/log/container/*-${container.id}.log # CRI path -------------------------------------------------------------------------------------- +----- You can also disable default settings entirely, so only Pods annotated like `co.elastic.logs/enabled: true` will be retrieved: -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- filebeat.autodiscover: providers: - type: kubernetes hints.enabled: true hints.default_config.enabled: false -------------------------------------------------------------------------------------- +----- You can annotate Kubernetes Pods with useful info to spin up {beatname_uc} inputs or modules: -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- annotations: co.elastic.logs/multiline.pattern: '^\[' co.elastic.logs/multiline.negate: true co.elastic.logs/multiline.match: after -------------------------------------------------------------------------------------- +----- [float] @@ -141,14 +141,14 @@ hint. For example, these hints configure multiline settings for all containers i specific `exclude_lines` hint for the container called `sidecar`. -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- annotations: co.elastic.logs/multiline.pattern: '^\[' co.elastic.logs/multiline.negate: true co.elastic.logs/multiline.match: after co.elastic.logs.sidecar/exclude_lines: '^DBG' -------------------------------------------------------------------------------------- +----- @@ -157,18 +157,18 @@ annotations: Docker autodiscover provider supports hints in labels. To enable it just set `hints.enabled`: -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- filebeat.autodiscover: providers: - type: docker hints.enabled: true -------------------------------------------------------------------------------------- +----- You can configure the default config that will be launched when a new container is seen, like this: -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- filebeat.autodiscover: providers: - type: docker @@ -177,28 +177,28 @@ filebeat.autodiscover: type: container paths: - /var/log/container/*-${container.id}.log # CRI path -------------------------------------------------------------------------------------- +----- You can also disable default settings entirely, so only containers labeled with `co.elastic.logs/enabled: true` will be retrieved: -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- filebeat.autodiscover: providers: - type: docker hints.enabled: true hints.default_config.enabled: false -------------------------------------------------------------------------------------- +----- You can label Docker containers with useful info to spin up {beatname_uc} inputs, for example: -["source","yaml",subs="attributes"] -------------------------------------------------------------------------------------- +[source,yaml] +----- co.elastic.logs/module: nginx co.elastic.logs/fileset.stdout: access co.elastic.logs/fileset.stderr: error -------------------------------------------------------------------------------------- +----- The above labels configure {beatname_uc} to use the Nginx module to harvest logs for this container. Access logs will be retrieved from stdout stream, and error logs from stderr. diff --git a/filebeat/docs/fields.asciidoc b/filebeat/docs/fields.asciidoc index 10ccf7fb957c..21e4f0571a60 100644 --- a/filebeat/docs/fields.asciidoc +++ b/filebeat/docs/fields.asciidoc @@ -13915,7 +13915,7 @@ Fields from the PostgreSQL log files. + -- -deprecated[7.3.0] +deprecated:[7.3.0] The timestamp from the log line. diff --git a/filebeat/docs/filebeat-general-options.asciidoc b/filebeat/docs/filebeat-general-options.asciidoc index b78e4545ec15..9de97f2949ae 100644 --- a/filebeat/docs/filebeat-general-options.asciidoc +++ b/filebeat/docs/filebeat-general-options.asciidoc @@ -95,7 +95,7 @@ directory format does not already exist. [float] ==== `config_dir` -deprecated[6.0.0, Use <> instead.] +deprecated:[6.0.0, Use <> instead.] The full path to the directory that contains additional input configuration files. Each configuration file must end with `.yml`. Each config file must also specify the full Filebeat diff --git a/filebeat/docs/inputs/input-docker.asciidoc b/filebeat/docs/inputs/input-docker.asciidoc index 7949ce90db66..a1422e19fea4 100644 --- a/filebeat/docs/inputs/input-docker.asciidoc +++ b/filebeat/docs/inputs/input-docker.asciidoc @@ -7,7 +7,7 @@ Docker ++++ -deprecated[7.2.0, Use `container` input instead.] +deprecated:[7.2.0, Use `container` input instead.] Use the `docker` input to read logs from Docker containers. diff --git a/filebeat/docs/inputs/input-redis.asciidoc b/filebeat/docs/inputs/input-redis.asciidoc index 05d3f9ec2075..20ba132c6c77 100644 --- a/filebeat/docs/inputs/input-redis.asciidoc +++ b/filebeat/docs/inputs/input-redis.asciidoc @@ -18,7 +18,7 @@ Example configuration: {beatname_lc}.inputs: - type: redis hosts: ["localhost:6379"] - password: "$\{redis_pwd\}" + password: "${redis_pwd}" ---- diff --git a/filebeat/docs/modules.asciidoc b/filebeat/docs/modules.asciidoc index 0a1a2111fc8b..efe3f1724895 100644 --- a/filebeat/docs/modules.asciidoc +++ b/filebeat/docs/modules.asciidoc @@ -9,6 +9,4 @@ modules. Filebeat modules require Elasticsearch 5.2 or later. -//pass macro block used here to remove Edit links from modules documentation because it is generated -pass::[] include::modules_list.asciidoc[] diff --git a/filebeat/docs/modules/osquery.asciidoc b/filebeat/docs/modules/osquery.asciidoc index 0b317c3ea461..b06c232c010b 100644 --- a/filebeat/docs/modules/osquery.asciidoc +++ b/filebeat/docs/modules/osquery.asciidoc @@ -57,6 +57,8 @@ To specify the same settings at the command line, you use: -M "osquery.result.var.paths=[/path/to/osqueryd.results.log*]" ----- +//set the fileset name used in the included example +:fileset_ex: result include::../include/config-option-intro.asciidoc[] [float] diff --git a/filebeat/module/osquery/_meta/docs.asciidoc b/filebeat/module/osquery/_meta/docs.asciidoc index 8f00e7039ac3..b8601be91749 100644 --- a/filebeat/module/osquery/_meta/docs.asciidoc +++ b/filebeat/module/osquery/_meta/docs.asciidoc @@ -52,6 +52,8 @@ To specify the same settings at the command line, you use: -M "osquery.result.var.paths=[/path/to/osqueryd.results.log*]" ----- +//set the fileset name used in the included example +:fileset_ex: result include::../include/config-option-intro.asciidoc[] [float] diff --git a/heartbeat/docs/heartbeat-options.asciidoc b/heartbeat/docs/heartbeat-options.asciidoc index 476603d99f80..723b7943d01c 100644 --- a/heartbeat/docs/heartbeat-options.asciidoc +++ b/heartbeat/docs/heartbeat-options.asciidoc @@ -1,8 +1,8 @@ [[configuration-heartbeat-options]] -== Set up monitors +== Set up {beatname_uc} monitors ++++ -Set up {beatname_uc} monitors +Set up monitors ++++ To configure {beatname_uc} define a set of `monitors` to check your remote hosts. @@ -574,8 +574,7 @@ The timezone for the scheduler. By default the scheduler uses localtime. [[monitor-watch-poll-file]] ==== `watch.poll_file` -deprecated[6.5.0,Replaced by using dynamic reloading via the -`heartbeat.config.monitors` option.] +deprecated:[6.5.0,Replaced by using dynamic reloading via the `heartbeat.config.monitors` option.] The JSON file to watch for additional monitor configurations. The JSON file can contain multiple objects, each of which specifies a different monitor config. diff --git a/journalbeat/docs/general-options.asciidoc b/journalbeat/docs/general-options.asciidoc index c71e4140ece3..8596fc7dea64 100644 --- a/journalbeat/docs/general-options.asciidoc +++ b/journalbeat/docs/general-options.asciidoc @@ -29,28 +29,28 @@ data path. See the <> section for details. The default is `${p ---- [float] -==== `backoff` deprecated[5.6.1,Use the option under `paths` instead.] +==== `backoff` deprecated:[5.6.1,Use the option under `paths` instead.] This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see <<{beatname_lc}-backoff,`backoff`>>. [float] -==== `max_backoff` deprecated[5.6.1,Use the option under `paths` instead.] +==== `max_backoff` deprecated:[5.6.1,Use the option under `paths` instead.] This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see <<{beatname_lc}-max-backoff,`max_backoff`>>. [float] -==== `seek` deprecated[5.6.1,Use the option under `paths` instead.] +==== `seek` deprecated:[5.6.1,Use the option under `paths` instead.] This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see <>. [float] -==== `include_matches` deprecated[5.6.1,Use the option under `paths` instead.] +==== `include_matches` deprecated:[5.6.1,Use the option under `paths` instead.] This option is valid as a global setting under the +{beatname_lc}+ namespace or under `paths`. For a description of this option, see diff --git a/libbeat/docs/command-reference.asciidoc b/libbeat/docs/command-reference.asciidoc index d80a61e2f59b..42f7fa695fff 100644 --- a/libbeat/docs/command-reference.asciidoc +++ b/libbeat/docs/command-reference.asciidoc @@ -657,12 +657,12 @@ Sets up components related to Elasticsearch index management including template, ILM policy, and write alias (if supported and configured). *`--template`*:: -deprecated[7.2] +deprecated:[7.2] Sets up the index template only. It is recommended to use `--index-management` instead. *`--ilm-policy`*:: -deprecated[7.2] +deprecated:[7.2] Sets up the index lifecycle management policy. It is recommended to use `--index-management` instead. diff --git a/libbeat/docs/config-file-format.asciidoc b/libbeat/docs/config-file-format.asciidoc index f1062e58271a..c1b93772c883 100644 --- a/libbeat/docs/config-file-format.asciidoc +++ b/libbeat/docs/config-file-format.asciidoc @@ -12,27 +12,27 @@ have the same indentation level. Dictionaries are represented by simple `key: value` pairs all having the same indentation level. The colon after `key` must be followed by a space. -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- +[source,yaml] +----- name: John Doe age: 34 country: Canada ------------------------------------------------------------------------------- +----- Lists are introduced by dashes `- `. All list members will be lines beginning with `- ` at the same indentation level. -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- +[source,yaml] +----- - Red - Green - Blue ------------------------------------------------------------------------------- +----- Lists and dictionaries are used in beats to build structured configurations. -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- +[source,yaml] +----- filebeat: inputs: - type: log @@ -41,16 +41,16 @@ filebeat: multiline: pattern: '^[' match: after ------------------------------------------------------------------------------- +----- Lists and dictionaries can also be represented in abbreviated form. Abbreviated form is somewhat similar to JSON using `{}` for dictionaries and `[]` for lists: -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- -person: \{name: "John Doe", age: 34, country: "Canada"} +[source,yaml] +----- +person: {name: "John Doe", age: 34, country: "Canada"} colors: ["Red", "Green", "Blue"] ------------------------------------------------------------------------------- +----- The following topics provide more detail to help you understand and work with config files in YAML: @@ -73,29 +73,25 @@ file. For example this setting: ["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- - +----- output: elasticsearch: index: 'beat-%{[{beat_version_key}]}-%{+yyyy.MM.dd}' +----- ------------------------------------------------------------------------------- - -gets collapsed into +output.elasticsearch.index: \'beat-%{[{beat_version_key}]}-%{+yyyy.MM.dd}\'+. The +gets collapsed into +output.elasticsearch.index: \'beat-%{[{beat_version_key}]}-%{+yyyy.MM.dd}'+. The full name of a setting is based on all parent structures involved. Lists create numeric names starting with 0. For example this filebeat setting: -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- - +[source,yaml] +----- filebeat: inputs: - type: log - ------------------------------------------------------------------------------- +----- Gets collapsed into `filebeat.inputs.0.type: log`. @@ -106,9 +102,8 @@ Note: having two settings with same fully collapsed path is invalid. Simple filebeat example with partially collapsed setting names and use of compact form: -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- - +[source,yaml] +----- filebeat.inputs: - type: log paths: ["/var/log/*.log"] @@ -116,8 +111,7 @@ filebeat.inputs: multiline.match: after output.elasticsearch.hosts: ["http://localhost:9200"] - ------------------------------------------------------------------------------- +----- [[config-file-format-type]] === Config file data types @@ -131,23 +125,23 @@ string is given when a number is required - the beat will fail to start up. Boolean values can be either `true` or `false`. Alternative names for `true` are `yes` and `on`. Instead of `false` the values `no` and `off` can be used. -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- +[source,yaml] +----- enabled: true disabled: false ------------------------------------------------------------------------------- +----- ==== Number Number values require you to enter the number to use without using single or double quotes. Some settings only support a restricted number range though. -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- +[source,yaml] +----- integer: 123 negative: -1 float: 5.4 ------------------------------------------------------------------------------- +----- ==== String @@ -174,12 +168,12 @@ Durations require a numeric value with optional fraction and required unit. Valid time units are `ns`, `us`, `ms`, `s`, `m`, `h`. Sometimes features based on durations can be disabled by using zero or negative durations. -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- +[source,yaml] +----- duration1: 2.5s duration2: 6h duration_disabled: -1s ------------------------------------------------------------------------------- +----- ==== Regular expression @@ -203,12 +197,12 @@ You can also format time stored in the `@timestamp` field using the `+FORMAT` syntax where FORMAT is a valid https://godoc.org/github.com/elastic/beats/libbeat/common/dtfmt[time format]. -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- +[source,yaml] +----- constant-format-string: 'constant string' field-format-string: '%{[fieldname]} string' format-string-with-date: '%{[fieldname]}-%{+yyyy.MM.dd}' ------------------------------------------------------------------------------- +----- [[config-file-format-env-vars]] @@ -226,23 +220,23 @@ referenced to. For example the filebeat registry file defaults to: -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- -filebeat.registry: $\{path.data}/registry ------------------------------------------------------------------------------- +[source,yaml] +----- +filebeat.registry: ${path.data}/registry +----- With `path.data` being an implicit config setting, that is overridable from command line, as well as in the configuration file. Example referencing `es.host` in `output.elasticsearch.hosts`: -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- -es.host: '$\{ES_HOST:localhost}' +[source,yaml] +----- +es.host: '${ES_HOST:localhost}' output.elasticsearch: - hosts: ['http://$\{es.host}:9200'] ------------------------------------------------------------------------------- + hosts: ['http://${es.host}:9200'] +----- Introducing `es.host`, the host can be overwritten from command line using `-E es.host=another-host`. @@ -252,8 +246,8 @@ references or strings can reference complete namespaces. These setting with duplicate content: -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- +[source,yaml] +----- namespace1: subnamespace: host: localhost @@ -263,20 +257,20 @@ namespace2: subnamespace: host: localhost sleep: 1s ------------------------------------------------------------------------------- +----- can be rewritten to -["source","yaml",subs="attributes"] ------------------------------------------------------------------------------- -namespace1: $\{shared} -namespace2: $\{shared} +[source,yaml] +----- +namespace1: ${shared} +namespace2: ${shared} shared: subnamespace: host: localhost sleep: 1s ------------------------------------------------------------------------------- +----- when using plain references. @@ -299,21 +293,21 @@ file is owned by `root` and has file permissions of `0644` (`-rw-r--r--`). You may encounter the following errors if your config file fails these checks: -["source","sh"] --------------------------------------------------------------------------------- +[source,sh] +----- Exiting: error loading config file: config file ("{beatname}.yml") must be owned by the beat user (uid=501) or root --------------------------------------------------------------------------------- +----- To correct this problem you can use either `chown root {beatname}.yml` or `chown 501 {beatname}.yml` to change the owner of the configuration file. -["source","sh"] --------------------------------------------------------------------------------- +[source,sh] +----- Exiting: error loading config file: config file ("{beatname}.yml") can only be writable by the owner but the permissions are "-rw-rw-r--" (to fix the permissions use: 'chmod go-w /etc/{beatname}/{beatname}.yml') --------------------------------------------------------------------------------- +----- To correct this problem, use `chmod go-w /etc/{beatname}/{beatname}.yml` to remove write privileges from anyone other than the owner. @@ -343,27 +337,27 @@ dictionary. For example, given the following configuration: -["source","yaml"] --------------------------------------------------------------------------------- +[source,yaml] +----- output.elasticsearch: hosts: ["http://localhost:9200"] username: username password: password --------------------------------------------------------------------------------- +----- You can disable the Elasticsearch output and write all events to the console by setting: -["source","sh"] --------------------------------------------------------------------------------- +[source,sh] +----- -E output='{elasticsearch.enabled: false, console.pretty: true}' --------------------------------------------------------------------------------- +----- Any complex objects that you specify at the command line are merged with the original configuration, and the following configuration is passed to the Beat: -["source","yaml"] --------------------------------------------------------------------------------- +[source,yaml] +----- output.elasticsearch: enabled: false hosts: ["http://localhost:9200"] @@ -372,7 +366,7 @@ output.elasticsearch: output.console: pretty: true --------------------------------------------------------------------------------- +----- [[config-file-format-tips]] diff --git a/libbeat/docs/outputconfig.asciidoc b/libbeat/docs/outputconfig.asciidoc index d41923d29a21..802caee69617 100644 --- a/libbeat/docs/outputconfig.asciidoc +++ b/libbeat/docs/outputconfig.asciidoc @@ -219,7 +219,7 @@ for more information about the environment variables. ifndef::apm-server[] The index name to write events to when you're using daily indices. The default is -+"{beatname_lc}-%\{[{beat_version_key}]\}-%\{+yyyy.MM.dd\}"+ (for example, ++"{beatname_lc}-%{[{beat_version_key}]}-%{+yyyy.MM.dd}"+ (for example, +"{beatname_lc}-{version}-{localdate}"+). If you change this setting, you also need to configure the `setup.template.name` and `setup.template.pattern` options (see <>). @@ -227,7 +227,7 @@ endif::apm-server[] ifdef::apm-server[] The index name to write events to. The default is -+"apm-%\{[{beat_version_key}]\}-{type\}-%\{+yyyy.MM.dd\}"+ (for example, ++"apm-%{[{beat_version_key}]}-{type}-%{+yyyy.MM.dd}"+ (for example, +"apm-{version}-transaction-{localdate}"+). See <> for more information on default index configuration. @@ -262,7 +262,7 @@ to set the index: ------------------------------------------------------------------------------ output.elasticsearch: hosts: ["http://localhost:9200"] - index: "%\{[fields.log_type]\}-%\{[{beat_version_key}]\}-%\{+yyyy.MM.dd}\" <1> + index: "%{[fields.log_type]}-%{[{beat_version_key}]}-%{+yyyy.MM.dd}" <1> ------------------------------------------------------------------------------ <1> We recommend including +{beat_version_key}+ in the name to avoid mapping issues @@ -283,7 +283,7 @@ to set the index: ------------------------------------------------------------------------------ output.elasticsearch: hosts: ["http://localhost:9200"] - index: "apm-%\{[observer.version]\}-%\{[processor.event]\}-%\{+yyyy.MM.dd}\" <1> + index: "apm-%{[observer.version]}-%{[processor.event]}-%{+yyyy.MM.dd}\" <1> ------------------------------------------------------------------------------ <1> `observer` refers to {beatname_uc}. We recommend including @@ -410,7 +410,7 @@ NOTE: `observer` refers to {beatname_uc}. We recommend including {beatname_uc}. This is the default configuration for {beatname_uc} and results in indices -named in the following format: +"apm-%\{[{beat_version_key}]\}-{type\}-%\{+yyyy.MM.dd\}"+ +named in the following format: +"apm-%{[{beat_version_key}]}-{type}-%{+yyyy.MM.dd}"+ For example: +"apm-{version}-transaction-{localdate}"+. The following example sets the index by taking the name returned by the `index` @@ -473,7 +473,7 @@ access any event field. For example, this configuration uses a custom field, ------------------------------------------------------------------------------ output.elasticsearch: hosts: ["http://localhost:9200"] - pipeline: "%\{[fields.log_type]\}_pipeline" + pipeline: "%{[fields.log_type]}_pipeline" ------------------------------------------------------------------------------ @@ -491,7 +491,7 @@ access any event field. For example, this configuration uses the field, ------------------------------------------------------------------------------ output.elasticsearch: hosts: ["http://localhost:9200"] - pipeline: "%\{[processor.event]\}_pipeline" + pipeline: "%{[processor.event]}_pipeline" ------------------------------------------------------------------------------ @@ -1378,19 +1378,19 @@ See <> for more information. ===== `host_topology` -deprecated[5.0.0] +deprecated:[5.0.0] The Redis host to connect to when using topology map support. Topology map support is disabled if this option is not set. ===== `password_topology` -deprecated[5.0.0] +deprecated:[5.0.0] The password to use for authenticating with the Redis topology server. The default is no authentication. ===== `db_topology` -deprecated[5.0.0] +deprecated:[5.0.0] The Redis database number where the topology information is stored. The default is 1. diff --git a/libbeat/docs/processors-using.asciidoc b/libbeat/docs/processors-using.asciidoc index 29d878134d63..ad48fe6a5338 100644 --- a/libbeat/docs/processors-using.asciidoc +++ b/libbeat/docs/processors-using.asciidoc @@ -94,7 +94,6 @@ collected by {beatname_uc}. * Under a specific {processor-scope}. The processor is applied to the data collected for that {processor-scope}. ifeval::["{beatname_lc}"=="filebeat"] -For example: + [source,yaml] ------ @@ -111,6 +110,7 @@ Similarly, for {beatname_uc} modules, you can define processors under the `input` section of the module definition. endif::[] ifeval::["{beatname_lc}"=="metricbeat"] ++ [source,yaml] ---- - module: @@ -123,7 +123,6 @@ ifeval::["{beatname_lc}"=="metricbeat"] ---- endif::[] ifeval::["{beatname_lc}"=="auditbeat"] -For example: + [source,yaml] ---- @@ -137,7 +136,6 @@ auditbeat.modules: ---- endif::[] ifeval::["{beatname_lc}"=="packetbeat"] -For example: + [source,yaml] ---- @@ -164,7 +162,6 @@ packetbeat.flows: ---- endif::[] ifeval::["{beatname_lc}"=="heartbeat"] -For example: + [source,yaml] ---- @@ -178,7 +175,6 @@ heartbeat.monitors: ---- endif::[] ifeval::["{beatname_lc}"=="winlogbeat"] -For example: + [source,yaml] ---- @@ -715,8 +711,8 @@ processors: with.dots: nested array: - do - - re - - with.field: mi + - re + - with.field: mi ------------------------------------------------------------------------------ Adds these fields to every event: diff --git a/libbeat/docs/regexp.asciidoc b/libbeat/docs/regexp.asciidoc index 9ebd097b71da..8d138ffc2e1f 100644 --- a/libbeat/docs/regexp.asciidoc +++ b/libbeat/docs/regexp.asciidoc @@ -110,7 +110,7 @@ The following patterns are supported: |`[[:blank:]]` |blank (same as `[\t ]`) |`[[:cntrl:]]` |control (same as `[\x00-\x1F\x7F]`) |`[[:digit:]]` |digits (same as `[0-9]`) -|`[[:graph:]]` |graphical (same as `[!-~] == [A-Za-z0-9!"#$%&'()*+,\-./:;<=>?@[\\\\]^_`` `{\|}~]`) +|`[[:graph:]]` |graphical (same as `[!-~] == [A-Za-z0-9!"#$%&'()*+,\-./:;<=>?@[\\\]^_`` `{\|}~]`) |`[[:lower:]]` |lower case (same as `[a-z]`) |`[[:print:]]` |printable (same as `[ -~] == [ [:graph:]]`) |`[[:punct:]]` |punctuation (same as ++[!-/:-@[-`{-~]++) diff --git a/libbeat/docs/shared-ilm.asciidoc b/libbeat/docs/shared-ilm.asciidoc index 918193683c40..8150e8bab136 100644 --- a/libbeat/docs/shared-ilm.asciidoc +++ b/libbeat/docs/shared-ilm.asciidoc @@ -51,7 +51,7 @@ required license; otherwise, {beatname_uc} creates daily indices. ==== `setup.ilm.rollover_alias` The index lifecycle write alias name. The default is -+{beatname_lc}-\{{beat_version_key}\}+. Setting this option changes the alias name. ++{beatname_lc}-%{{beat_version_key}}+. Setting this option changes the alias name. NOTE: If you modify this setting after loading the index template, you must overwrite the template to apply the changes. @@ -81,7 +81,7 @@ overwrite the template to apply the changes. ==== `setup.ilm.policy_name` The name to use for the lifecycle policy. The default is -+{beatname_lc}-\{{beat_version_key}\}+. ++{beatname_lc}-%{[{beat_version_key}]}+. [float] [[setup-ilm-policy_file-option]] diff --git a/libbeat/docs/shared-ssl-config.asciidoc b/libbeat/docs/shared-ssl-config.asciidoc index 9edd36123f9e..0f4d649fb9d8 100644 --- a/libbeat/docs/shared-ssl-config.asciidoc +++ b/libbeat/docs/shared-ssl-config.asciidoc @@ -6,7 +6,7 @@ You can specify SSL options when you configure: * <> that support SSL ifeval::["{beatname_lc}"!="apm-server"] * the <> -endif::["{beatname_lc}"!="apm-server"] +endif::[] ifeval::["{beatname_lc}"=="heartbeat"] * <> that support SSL endif::[] diff --git a/libbeat/docs/template-config.asciidoc b/libbeat/docs/template-config.asciidoc index c0c6dec8704d..2a99f1fe6187 100644 --- a/libbeat/docs/template-config.asciidoc +++ b/libbeat/docs/template-config.asciidoc @@ -24,18 +24,18 @@ you must <>. *`setup.template.name`*:: The name of the template. The default is +{beatname_lc}+. The {beatname_uc} version is always appended to the given -name, so the final name is +{beatname_lc}-%\{[{beat_version_key}]\}+. +name, so the final name is +{beatname_lc}-%{[{beat_version_key}]}+. // Maintainers: a backslash character is required to escape curly braces and // asterisks in inline code examples that contain asciidoc attributes. You'll // note that a backslash does not appear before the asterisk -// in +{beatname_lc}-%\{[{beat_version_key}]\}-*+. This is intentional and formats +// in +{beatname_lc}-%{[{beat_version_key}]}-*+. This is intentional and formats // the example as expected. *`setup.template.pattern`*:: The template pattern to apply to the default index settings. The default pattern is +{beat_default_index_prefix}-\*+. The {beatname_uc} version is always included in the pattern, so the final pattern is -+{beat_default_index_prefix}-%\{[{beat_version_key}]\}-*+. The wildcard character `-*` is used to ++{beat_default_index_prefix}-%{[{beat_version_key}]}-*+. The wildcard character `-*` is used to match all daily indices. + Example: diff --git a/libbeat/scripts/generate_fields_docs.py b/libbeat/scripts/generate_fields_docs.py index c1897af8f001..e6864252d57a 100644 --- a/libbeat/scripts/generate_fields_docs.py +++ b/libbeat/scripts/generate_fields_docs.py @@ -53,7 +53,7 @@ def document_field(output, field, field_path): output.write("*`{}`*::\n+\n--\n".format(field["field_path"])) if "deprecated" in field: - output.write("\ndeprecated[{}]\n\n".format(field["deprecated"])) + output.write("\ndeprecated:[{}]\n\n".format(field["deprecated"])) if "description" in field: output.write("{}\n\n".format(field["description"])) diff --git a/metricbeat/docs/autodiscover-hints.asciidoc b/metricbeat/docs/autodiscover-hints.asciidoc index daf13cc6ce7c..2bb311125161 100644 --- a/metricbeat/docs/autodiscover-hints.asciidoc +++ b/metricbeat/docs/autodiscover-hints.asciidoc @@ -43,7 +43,7 @@ a list of configurations. ["source","yaml",subs="attributes"] ------------------------------------------------------------------------------------- -co.elastic.metrics/raw: "[{\"enabled\":true,\"metricsets\":[\"default\"],\"module\":\"mockmoduledefaults\",\"period\":\"1m\",\"timeout\":\"3s\"}]" +co.elastic.metrics/raw: "[{"enabled\":true,\"metricsets\":[\"default\"],\"module\":\"mockmoduledefaults\",\"period\":\"1m\",\"timeout\":\"3s\"}]" ------------------------------------------------------------------------------------- [float] diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc index 308edc009d5d..3e31d5d2803d 100644 --- a/metricbeat/docs/fields.asciidoc +++ b/metricbeat/docs/fields.asciidoc @@ -5020,7 +5020,7 @@ type: long + -- -deprecated[6.4] +deprecated:[6.4] Number of current reads per second @@ -5072,7 +5072,7 @@ type: long + -- -deprecated[6.4] +deprecated:[6.4] Number of current writes per second @@ -5124,7 +5124,7 @@ type: long + -- -deprecated[6.4] +deprecated:[6.4] Number of reads and writes per second @@ -13781,7 +13781,7 @@ type: keyword + -- -deprecated[6.5] +deprecated:[6.5] Topic name @@ -13793,7 +13793,7 @@ type: keyword + -- -deprecated[6.5] +deprecated:[6.5] Partition ID @@ -13908,7 +13908,7 @@ Partition data. + -- -deprecated[6.5] +deprecated:[6.5] Partition id. @@ -13981,7 +13981,7 @@ type: long + -- -deprecated[6.5] +deprecated:[6.5] topic error code. @@ -13994,7 +13994,7 @@ type: long + -- -deprecated[6.5] +deprecated:[6.5] Topic name @@ -14007,7 +14007,7 @@ type: keyword + -- -deprecated[6.5] +deprecated:[6.5] Broker id @@ -14020,7 +14020,7 @@ type: long + -- -deprecated[6.5] +deprecated:[6.5] Broker address @@ -16860,7 +16860,7 @@ type: float + -- -deprecated[6.4] +deprecated:[6.4] Container CPU nanocores limit @@ -16873,7 +16873,7 @@ type: long + -- -deprecated[6.4] +deprecated:[6.4] Container CPU requested nanocores @@ -25868,7 +25868,7 @@ type: long + -- -deprecated[6.5.0] +deprecated:[6.5.0] Longest output list among current client connections (replaced by max_output_buffer). @@ -25891,7 +25891,7 @@ type: long + -- -deprecated[6.5.0] +deprecated:[6.5.0] Biggest input buffer among current client connections (replaced by max_input_buffer). @@ -26488,7 +26488,7 @@ type: long + -- -deprecated[6.5] +deprecated:[6.5] The server's current replication offset diff --git a/metricbeat/docs/modules.asciidoc b/metricbeat/docs/modules.asciidoc index a4c3e798f3b9..ea572984ff3a 100644 --- a/metricbeat/docs/modules.asciidoc +++ b/metricbeat/docs/modules.asciidoc @@ -7,8 +7,6 @@ This section contains detailed information about the metric collecting modules contained in {beatname_uc}. Each module contains one or multiple metricsets. More details about each module can be found under the links below. -//pass macro block used here to remove Edit links from modules documentation because it is generated -pass::[] include::modules_list.asciidoc[] diff --git a/packetbeat/docs/faq.asciidoc b/packetbeat/docs/faq.asciidoc index 5e304881e06a..eedc28ca649d 100644 --- a/packetbeat/docs/faq.asciidoc +++ b/packetbeat/docs/faq.asciidoc @@ -16,9 +16,9 @@ The index template might not be loaded correctly. See <>. The interface needs to be set to promiscuous mode. Run the following command: ["source","sh",subs="attributes,callouts"] ----------------------------------------------------------------------- +---- ip link set promisc on ----------------------------------------------------------------------- +---- For example: `ip link set enp5s0f1 promisc on` @@ -36,14 +36,14 @@ For the list of devices shown here, you would configure {beatname_uc} to use device `4`: ["source","sh",subs="attributes"] ----------------------------------------------------------------------- -PS C:\Program Files\{beatname_uc} .{backslash}{beatname_lc}.exe -devices +---- +PS C:\Program Files{backslash}{beatname_uc} .{backslash}{beatname_lc}.exe -devices 0: \Device\NPF_NdisWanBh (NdisWan Adapter) 1: \Device\NPF_NdisWanIp (NdisWan Adapter) 2: \Device\NPF_NdisWanIpv6 (NdisWan Adapter) 3: \Device\NPF_{DD72B02C-4E48-4924-8D0F-F80EA2755534} (Intel(R) PRO/1000 MT Desktop Adapter) 4: \Device\NPF_{77DFFCAF-1335-4B0D-AFD4-5A4685674FAA} (MS NDIS 6.0 LoopBack Driver) ----------------------------------------------------------------------- +---- [[packetbeat-missing-transactions]] === {beatname_uc} is missing long running transactions diff --git a/winlogbeat/docs/modules.asciidoc b/winlogbeat/docs/modules.asciidoc index b4d0e8b0feed..a48f0e4ed116 100644 --- a/winlogbeat/docs/modules.asciidoc +++ b/winlogbeat/docs/modules.asciidoc @@ -49,9 +49,5 @@ winlogbeat.event_logs: [float] === Modules -//pass macro block used here to remove Edit links from modules documentation because it is generated -pass::[] -include::modules_list.asciidoc[] - - +include::modules_list.asciidoc[]