You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
ess-leadin-short: "Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can try it for free at https://cloud.elastic.co/registration"
49
+
ess-leadin: "You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. Try the Elasticsearch Service for free: https://cloud.elastic.co/registration."
Copy file name to clipboardExpand all lines: docs/reference/dashboard-monitoring-with-elastic-agent.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -144,6 +144,6 @@ A number of dashboards are included to view {{ls}} as a whole, and dashboards th
144
144
From the list of assets, open the **[Metrics {{ls}}] {{ls}} overview** dashboard to view overall performance. Then follow the navigation panel to further drill down into {{ls}} performance.
145
145
146
146
% TO DO: Use `:class: screenshot`
147
-
147
+
148
148
149
149
You can hover over any visualization to adjust its settings, or click the **Edit** button to make changes to the dashboard. To learn more, refer to [Dashboard and visualizations](docs-content://explore-analyze/dashboards.md).
| plugins | Local, non Ruby-Gem plugin files. Each plugin is contained in a subdirectory. Recommended for development only. |``{extract.path}/plugins``|``path.plugins``|
23
-
| data | Data files used by logstash and its plugins for any persistence needs. |``{extract.path}/data``|``path.data``|
18
+
| home | Home directory of the Logstash installation. |`{extract.path}`- Directory created by unpacking the archive ||
19
+
| bin | Binary scripts, including `logstash` to start Logstash and `logstash-plugin` to install plugins |`{extract.path}/bin`||
20
+
| settings | Configuration files, including `logstash.yml` and `jvm.options`|`{extract.path}/config`|`path.settings`|
| plugins | Local, non Ruby-Gem plugin files. Each plugin is contained in a subdirectory. Recommended for development only. |`{extract.path}/plugins`|`path.plugins`|
23
+
| data | Data files used by logstash and its plugins for any persistence needs. |`{extract.path}/data`|`path.data`|
24
24
25
25
26
26
## Directory Layout of Debian and RPM Packages [deb-layout]
@@ -29,13 +29,13 @@ The Debian package and the RPM package each place config files, logs, and the se
29
29
30
30
| Type | Description | Default Location | Setting |
31
31
| --- | --- | --- | --- |
32
-
| home | Home directory of the Logstash installation. |``/usr/share/logstash``||
33
-
| bin | Binary scripts including `logstash` to start Logstash and `logstash-plugin` to install plugins |``/usr/share/logstash/bin``||
34
-
| settings | Configuration files, including `logstash.yml` and `jvm.options`|``/etc/logstash``|``path.settings``|
| plugins | Local, non Ruby-Gem plugin files. Each plugin is contained in a subdirectory. Recommended for development only. |``/usr/share/logstash/plugins``|``path.plugins``|
38
-
| data | Data files used by logstash and its plugins for any persistence needs. |``/var/lib/logstash``|``path.data``|
32
+
| home | Home directory of the Logstash installation. |`/usr/share/logstash`||
33
+
| bin | Binary scripts including `logstash` to start Logstash and `logstash-plugin` to install plugins |`/usr/share/logstash/bin`||
34
+
| settings | Configuration files, including `logstash.yml` and `jvm.options`|`/etc/logstash`|`path.settings`|
35
+
| conf | Logstash pipeline configuration files |`/etc/logstash/conf.d/*.conf`| See `/etc/logstash/pipelines.yml`|
| plugins | Local, non Ruby-Gem plugin files. Each plugin is contained in a subdirectory. Recommended for development only. |`/usr/share/logstash/plugins`|`path.plugins`|
38
+
| data | Data files used by logstash and its plugins for any persistence needs. |`/var/lib/logstash`|`path.data`|
39
39
40
40
41
41
## Directory Layout of Docker Images [docker-layout]
@@ -44,12 +44,12 @@ The Docker images are created from the `.tar.gz` packages, and follow a similar
44
44
45
45
| Type | Description | Default Location | Setting |
46
46
| --- | --- | --- | --- |
47
-
| home | Home directory of the Logstash installation. |``/usr/share/logstash``||
48
-
| bin | Binary scripts, including `logstash` to start Logstash and `logstash-plugin` to install plugins |``/usr/share/logstash/bin``||
49
-
| settings | Configuration files, including `logstash.yml` and `jvm.options`|``/usr/share/logstash/config``|``path.settings``|
| plugins | Local, non Ruby-Gem plugin files. Each plugin is contained in a subdirectory. Recommended for development only. |``/usr/share/logstash/plugins``|``path.plugins``|
52
-
| data | Data files used by logstash and its plugins for any persistence needs. |``/usr/share/logstash/data``|``path.data``|
47
+
| home | Home directory of the Logstash installation. |`/usr/share/logstash`||
48
+
| bin | Binary scripts, including `logstash` to start Logstash and `logstash-plugin` to install plugins |`/usr/share/logstash/bin`||
49
+
| settings | Configuration files, including `logstash.yml` and `jvm.options`|`/usr/share/logstash/config`|`path.settings`|
| plugins | Local, non Ruby-Gem plugin files. Each plugin is contained in a subdirectory. Recommended for development only. |`/usr/share/logstash/plugins`|`path.plugins`|
52
+
| data | Data files used by logstash and its plugins for any persistence needs. |`/usr/share/logstash/data`|`path.data`|
53
53
54
54
::::{note}
55
55
Logstash Docker containers do not create log files by default. They log to standard output.
Copy file name to clipboardExpand all lines: docs/reference/first-event.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -37,16 +37,16 @@ The location of the `bin` directory varies by platform. See [Directory layout](/
37
37
::::{admonition} macOS Gatekeeper warnings
38
38
:class: important
39
39
40
-
Apple’s rollout of stricter notarization requirements affected the notarization of the 9.0.0-beta1 {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}} that interrupts it, you will need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
40
+
Apple’s rollout of stricter notarization requirements affected the notarization of {{version}} {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}} that interrupts it, you will need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
Alternatively, you can add a security override if a Gatekeeper popup appears by following the instructions in the *How to open an app that hasn’t been notarized or is from an unidentified developer* section of [Safely open apps on your Mac](https://support.apple.com/en-us/HT202491).
Copy file name to clipboardExpand all lines: docs/reference/logstash-settings-file.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@ The `logstash.yml` file includes these settings.
59
59
| `config.reload.interval` | How often in seconds Logstash checks the config files for changes. Note that the unit qualifier (`s`) is required. | `3s` |
60
60
| `config.debug` | When set to `true`, shows the fully compiled configuration as a debug log message. You must also set `log.level: debug`. WARNING: The log message will include any *password* options passed to plugin configs as plaintext, and may result in plaintext passwords appearing in your logs! | `false` |
61
61
| `config.support_escapes` | When set to `true`, quoted strings will process the following escape sequences: `\n`becomes a literal newline (ASCII 10). `\r` becomes a literal carriage return (ASCII 13). `\t` becomes a literal tab (ASCII 9). `\\` becomes a literal backslash `\`. `\"` becomes a literal double quotation mark. `\'` becomes a literal quotation mark. | `false` |
62
-
| `config.field_reference.escape_style` | Provides a way to reference fields that contain [field reference special characters](https://www.elastic.co/guide/en/logstash/current/field-references-deepdive.html#formal-grammar-escape-sequences) `[` and `]`.<br><br>::::{note} <br>This feature is in **technical preview** and may change in the future.<br>::::<br><br><br>Current options are:<br><br>* `percent`: URI-style `%`+`HH` hexadecimal encoding of UTF-8 bytes (`[` → `%5B`; `]` → `%5D`)<br>* `ampersand`: HTML-style `&#`+`DD`+`;` encoding of decimal Unicode code-points (`[` → `[`; `]` → `]`)<br>* `none`: field names containing special characters *cannot* be referenced.<br> | `none` |
62
+
| `config.field_reference.escape_style` | Provides a way to reference fields that contain [field reference special characters](https://www.elastic.co/guide/en/logstash/current/field-references-deepdive.html#formal-grammar-escape-sequences) `[` and `]`.<br><br>Note: This feature is in **technical preview** and may change in the future.<br><br>Current options are:<br><br>* `percent`: URI-style `%`+`HH` hexadecimal encoding of UTF-8 bytes (`[` → `%5B`; `]` → `%5D`)<br>* `ampersand`: HTML-style `&#`+`DD`+`;` encoding of decimal Unicode code-points (`[` → `[`; `]` → `]`)<br>* `none`: field names containing special characters *cannot* be referenced.<br> | `none` |
63
63
| `queue.type` | The internal queuing model to use for event buffering. Specify `memory` for legacy in-memory based queuing, or `persisted` for disk-based ACKed queueing ([persistent queues](/reference/persistent-queues.md)). | `memory` |
64
64
| `path.queue` | The directory path where the data files will be stored when persistent queues are enabled (`queue.type: persisted`). | `path.data/queue` |
65
65
| `queue.page_capacity` | The size of the page data files used when persistent queues are enabled (`queue.type: persisted`). The queue data consists of append-only data files separated into pages. | 64mb |
Copy file name to clipboardExpand all lines: docs/reference/running-logstash-command-line.md
+14-6Lines changed: 14 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,16 @@ mapped_pages:
8
8
::::{admonition} macOS Gatekeeper warnings
9
9
:class: important
10
10
11
-
Apple’s rollout of stricter notarization requirements affected the notarization of the 9.0.0-beta1 {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}} that interrupts it, you will need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
11
+
Apple’s rollout of stricter notarization requirements affected the notarization of the {{version}} {{ls}} artifacts. If macOS Catalina displays a dialog when you first run {{ls}} that interrupts it, you will need to take an action to allow it to run. To prevent Gatekeeper checks on the {{ls}} files, run the following command on the downloaded `.tar.gz` archive or the directory to which was extracted:
Alternatively, you can add a security override if a Gatekeeper popup appears by following the instructions in the *How to open an app that hasn’t been notarized or is from an unidentified developer* section of [Safely open apps on your Mac](https://support.apple.com/en-us/HT202491).
@@ -116,7 +116,11 @@ Logstash has the following flags. You can use the `--help` flag to display this
116
116
117
117
118
118
**`--config.debug`**
119
-
: Show the fully compiled configuration as a debug log message (you must also have `--log.level=debug` enabled). WARNING: The log message will include any *password* options passed to plugin configs as plaintext, and may result in plaintext passwords appearing in your logs!
119
+
: Show the fully compiled configuration as a debug log message (you must also have `--log.level=debug` enabled).
120
+
121
+
:::{warning}
122
+
The log message will include any *password* options passed to plugin configs as plaintext, and may result in plaintext passwords appearing in your logs!
123
+
:::
120
124
121
125
**`-i, --interactive SHELL`**
122
126
: Drop to shell instead of running as normal. Valid shells are "irb" and "pry".
@@ -128,7 +132,11 @@ Logstash has the following flags. You can use the `--help` flag to display this
128
132
: Check configuration for valid syntax and then exit. Note that grok patterns are not checked for correctness with this flag. Logstash can read multiple config files from a directory. If you combine this flag with `--log.level=debug`, Logstash will log the combined config file, annotating each config block with the source file it came from.
129
133
130
134
**`-r, --config.reload.automatic`**
131
-
: Monitor configuration changes and reload whenever the configuration is changed. NOTE: Use SIGHUP to manually reload the config. The default is false.
135
+
: Monitor configuration changes and reload whenever the configuration is changed.
136
+
137
+
:::{note}
138
+
Use SIGHUP to manually reload the config. The default is false.
139
+
:::
132
140
133
141
**`--config.reload.interval RELOAD_INTERVAL`**
134
142
: How frequently to poll the configuration location for changes. The default value is "3s". Note that the unit qualifier (`s`) is required.
Copy file name to clipboardExpand all lines: docs/reference/running-logstash.md
+5-6Lines changed: 5 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -9,12 +9,11 @@ Logstash is not started automatically after installation. Starting and stopping
9
9
10
10
As systemd is now the de-facto init system, here are some common operating systems and versions that use it. This list is intended to be informative, not exhaustive.
11
11
12
-
||||
13
-
| --- | --- | --- |
14
-
| Distribution | Service System ||
15
-
| Ubuntu 16.04 and newer |[systemd](#running-logstash-systemd)||
16
-
| Debian 8 "jessie" and newer |[systemd](#running-logstash-systemd)||
17
-
| CentOS (and RHEL) 7 and newer |[systemd](#running-logstash-systemd)||
12
+
| Distribution | Service System |
13
+
| --- | --- |
14
+
| Ubuntu 16.04 and newer |[systemd](#running-logstash-systemd)|
15
+
| Debian 8 "jessie" and newer |[systemd](#running-logstash-systemd)|
16
+
| CentOS (and RHEL) 7 and newer |[systemd](#running-logstash-systemd)|
18
17
19
18
## Running Logstash by Using Systemd [running-logstash-systemd]
Copy file name to clipboardExpand all lines: docs/reference/secure-connection.md
+7-4Lines changed: 7 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,9 @@ Security is enabled by default on the {{es}} cluster (starting in 8.0). You must
24
24
25
25
{{ess}} uses certificates signed by standard publicly trusted certificate authorities, and therefore setting a cacert is not necessary.
26
26
27
-
::::{admonition} Security to {{serverless-full}} $$$serverless$$$
27
+
$$$serverless$$$
28
+
29
+
::::{admonition} Security to {{serverless-full}}
28
30
:class: note
29
31
30
32
{{es-serverless}} simplifies safe, secure communication between {{ls}} and {{es}}.
@@ -39,11 +41,12 @@ For more details, check out [Grant access using API keys](#ls-api-keys).
39
41
40
42
::::
41
43
44
+
$$$hosted-ess$$$
42
45
43
-
::::{admonition} Security to hosted {{ess}}$$$hosted-ess$$$
46
+
::::{admonition} Security to hosted {{ess}}
44
47
:class: note
45
48
46
-
Our hosted {{ess}} on Elastic Cloud simplifies safe, secure communication between {{ls}} and {{es}}. When you configure the [{{ls}} {{es}} output plugin](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md) to use [`cloud_id`](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-cloud_id) with either the [`cloud_auth` option](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-cloud_auth) or the [`api_key` option](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-api_key), no additional SSL configuration steps are needed. {ess-leadin-short}
49
+
Our hosted {{ess}} on Elastic Cloud simplifies safe, secure communication between {{ls}} and {{es}}. When you configure the [{{ls}} {{es}} output plugin](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md) to use [`cloud_id`](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-cloud_id) with either the [`cloud_auth` option](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-cloud_auth) or the [`api_key` option](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md#plugins-outputs-elasticsearch-api_key), no additional SSL configuration steps are needed. {{ess-leadin-short}}
47
50
48
51
Configuration example:
49
52
@@ -217,7 +220,7 @@ output {
217
220
218
221
219
222
::::{note}
220
-
Hosted {{ess}} simplifies security. This configuration step is not necessary for hosted Elasticsearch Service on Elastic Cloud. {ess-leadin-short}
223
+
Hosted {{ess}} simplifies security. This configuration step is not necessary for hosted Elasticsearch Service on Elastic Cloud. {{ess-leadin-short}}
Copy file name to clipboardExpand all lines: docs/reference/serverless-monitoring-with-elastic-agent.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -65,6 +65,6 @@ For the best experience with the Logstash dashboards, we recommend collecting al
65
65
From the list of assets, open the **[Metrics {{ls}}] {{ls}} overview** dashboard to view overall performance. Then follow the navigation panel to further drill down into {{ls}} performance.
66
66
67
67
% TO DO: Use `:class: screenshot`
68
-
68
+
69
69
70
70
You can hover over any visualization to adjust its settings, or click the **Edit** button to make changes to the dashboard. To learn more, refer to [Dashboard and visualizations](docs-content://explore-analyze/dashboards.md).
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?v=4&size=40){kind=avatar}
0 commit comments