mirror of
https://github.com/elastic/logstash.git
synced 2025-06-28 01:37:28 -04:00
clean up cross-repo links (#17190)
This commit is contained in:
parent
86785815bd
commit
24fd2a6c75
204 changed files with 291 additions and 291 deletions
|
@ -402,7 +402,7 @@ With these both defined, the install process will search for the required jar fi
|
||||||
|
|
||||||
## Document your plugin [_document_your_plugin_2]
|
## Document your plugin [_document_your_plugin_2]
|
||||||
|
|
||||||
Documentation is an important part of your plugin. All plugin documentation is rendered and placed in the [Logstash Reference](/reference/index.md) and the [Versioned plugin docs](logstash-docs://docs/reference/integration-plugins.md).
|
Documentation is an important part of your plugin. All plugin documentation is rendered and placed in the [Logstash Reference](/reference/index.md) and the [Versioned plugin docs](logstash-docs://reference/integration-plugins.md).
|
||||||
|
|
||||||
See [Document your plugin](/extend/plugin-doc.md) for tips and guidelines.
|
See [Document your plugin](/extend/plugin-doc.md) for tips and guidelines.
|
||||||
|
|
||||||
|
|
|
@ -403,7 +403,7 @@ With these both defined, the install process will search for the required jar fi
|
||||||
|
|
||||||
## Document your plugin [_document_your_plugin_3]
|
## Document your plugin [_document_your_plugin_3]
|
||||||
|
|
||||||
Documentation is an important part of your plugin. All plugin documentation is rendered and placed in the [Logstash Reference](/reference/index.md) and the [Versioned plugin docs](logstash-docs://docs/reference/integration-plugins.md).
|
Documentation is an important part of your plugin. All plugin documentation is rendered and placed in the [Logstash Reference](/reference/index.md) and the [Versioned plugin docs](logstash-docs://reference/integration-plugins.md).
|
||||||
|
|
||||||
See [Document your plugin](/extend/plugin-doc.md) for tips and guidelines.
|
See [Document your plugin](/extend/plugin-doc.md) for tips and guidelines.
|
||||||
|
|
||||||
|
|
|
@ -443,7 +443,7 @@ With these both defined, the install process will search for the required jar fi
|
||||||
|
|
||||||
## Document your plugin [_document_your_plugin]
|
## Document your plugin [_document_your_plugin]
|
||||||
|
|
||||||
Documentation is an important part of your plugin. All plugin documentation is rendered and placed in the [Logstash Reference](/reference/index.md) and the [Versioned plugin docs](logstash-docs://docs/reference/integration-plugins.md).
|
Documentation is an important part of your plugin. All plugin documentation is rendered and placed in the [Logstash Reference](/reference/index.md) and the [Versioned plugin docs](logstash-docs://reference/integration-plugins.md).
|
||||||
|
|
||||||
See [Document your plugin](/extend/plugin-doc.md) for tips and guidelines.
|
See [Document your plugin](/extend/plugin-doc.md) for tips and guidelines.
|
||||||
|
|
||||||
|
|
|
@ -360,7 +360,7 @@ With these both defined, the install process will search for the required jar fi
|
||||||
|
|
||||||
## Document your plugin [_document_your_plugin_4]
|
## Document your plugin [_document_your_plugin_4]
|
||||||
|
|
||||||
Documentation is an important part of your plugin. All plugin documentation is rendered and placed in the [Logstash Reference](/reference/index.md) and the [Versioned plugin docs](logstash-docs://docs/reference/integration-plugins.md).
|
Documentation is an important part of your plugin. All plugin documentation is rendered and placed in the [Logstash Reference](/reference/index.md) and the [Versioned plugin docs](logstash-docs://reference/integration-plugins.md).
|
||||||
|
|
||||||
See [Document your plugin](/extend/plugin-doc.md) for tips and guidelines.
|
See [Document your plugin](/extend/plugin-doc.md) for tips and guidelines.
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,7 @@ mapped_pages:
|
||||||
|
|
||||||
Documentation is a required component of your plugin. Quality documentation with good examples contributes to the adoption of your plugin.
|
Documentation is a required component of your plugin. Quality documentation with good examples contributes to the adoption of your plugin.
|
||||||
|
|
||||||
The documentation that you write for your plugin will be generated and published in the [Logstash Reference](/reference/index.md) and the [Logstash Versioned Plugin Reference](logstash-docs://docs/reference/integration-plugins.md).
|
The documentation that you write for your plugin will be generated and published in the [Logstash Reference](/reference/index.md) and the [Logstash Versioned Plugin Reference](logstash-docs://reference/integration-plugins.md).
|
||||||
|
|
||||||
::::{admonition} Plugin listing in {{ls}} Reference
|
::::{admonition} Plugin listing in {{ls}} Reference
|
||||||
:class: note
|
:class: note
|
||||||
|
@ -26,7 +26,7 @@ Documentation belongs in a single file called *docs/index.asciidoc*. It belongs
|
||||||
|
|
||||||
## Heading IDs [heading-ids]
|
## Heading IDs [heading-ids]
|
||||||
|
|
||||||
Format heading anchors with variables that can support generated IDs. This approach creates unique IDs when the [Logstash Versioned Plugin Reference](logstash-docs://docs/reference/integration-plugins.md) is built. Unique heading IDs are required to avoid duplication over multiple versions of a plugin.
|
Format heading anchors with variables that can support generated IDs. This approach creates unique IDs when the [Logstash Versioned Plugin Reference](logstash-docs://reference/integration-plugins.md) is built. Unique heading IDs are required to avoid duplication over multiple versions of a plugin.
|
||||||
|
|
||||||
**Example**
|
**Example**
|
||||||
|
|
||||||
|
@ -39,7 +39,7 @@ Instead, use variables to define it:
|
||||||
==== Configuration models
|
==== Configuration models
|
||||||
```
|
```
|
||||||
|
|
||||||
If you hardcode an ID, the [Logstash Versioned Plugin Reference](logstash-docs://docs/reference/integration-plugins.md) builds correctly the first time. The second time the doc build runs, the ID is flagged as a duplicate, and the build fails.
|
If you hardcode an ID, the [Logstash Versioned Plugin Reference](logstash-docs://reference/integration-plugins.md) builds correctly the first time. The second time the doc build runs, the ID is flagged as a duplicate, and the build fails.
|
||||||
|
|
||||||
|
|
||||||
## Link formats [link-format]
|
## Link formats [link-format]
|
||||||
|
@ -136,7 +136,7 @@ match => {
|
||||||
|
|
||||||
## Where’s my doc? [_wheres_my_doc]
|
## Where’s my doc? [_wheres_my_doc]
|
||||||
|
|
||||||
Plugin documentation goes through several steps before it gets published in the [Logstash Versioned Plugin Reference](logstash-docs://docs/reference/integration-plugins.md) and the [Logstash Reference](/reference/index.md).
|
Plugin documentation goes through several steps before it gets published in the [Logstash Versioned Plugin Reference](logstash-docs://reference/integration-plugins.md) and the [Logstash Reference](/reference/index.md).
|
||||||
|
|
||||||
Here’s an overview of the workflow:
|
Here’s an overview of the workflow:
|
||||||
|
|
||||||
|
@ -145,7 +145,7 @@ Here’s an overview of the workflow:
|
||||||
* Wait for the continuous integration build to complete successfully.
|
* Wait for the continuous integration build to complete successfully.
|
||||||
* Publish the plugin to [https://rubygems.org](https://rubygems.org).
|
* Publish the plugin to [https://rubygems.org](https://rubygems.org).
|
||||||
* A script detects the new or changed version, and picks up the `index.asciidoc` file for inclusion in the doc build.
|
* A script detects the new or changed version, and picks up the `index.asciidoc` file for inclusion in the doc build.
|
||||||
* The documentation for your new plugin is published in the [Logstash Versioned Plugin Reference](logstash-docs://docs/reference/integration-plugins.md).
|
* The documentation for your new plugin is published in the [Logstash Versioned Plugin Reference](logstash-docs://reference/integration-plugins.md).
|
||||||
|
|
||||||
We’re not done yet.
|
We’re not done yet.
|
||||||
|
|
||||||
|
|
|
@ -22,7 +22,7 @@ In a typical use case, Filebeat runs on a separate machine from the machine runn
|
||||||
|
|
||||||
The default Logstash installation includes the [`Beats input`](/reference/plugins-inputs-beats.md) plugin. The Beats input plugin enables Logstash to receive events from the Elastic Beats framework, which means that any Beat written to work with the Beats framework, such as Packetbeat and Metricbeat, can also send event data to Logstash.
|
The default Logstash installation includes the [`Beats input`](/reference/plugins-inputs-beats.md) plugin. The Beats input plugin enables Logstash to receive events from the Elastic Beats framework, which means that any Beat written to work with the Beats framework, such as Packetbeat and Metricbeat, can also send event data to Logstash.
|
||||||
|
|
||||||
To install Filebeat on your data source machine, download the appropriate package from the Filebeat [product page](https://www.elastic.co/downloads/beats/filebeat). You can also refer to [Filebeat quick start](beats://docs/reference/filebeat/filebeat-installation-configuration.md) for additional installation instructions.
|
To install Filebeat on your data source machine, download the appropriate package from the Filebeat [product page](https://www.elastic.co/downloads/beats/filebeat). You can also refer to [Filebeat quick start](beats://reference/filebeat/filebeat-installation-configuration.md) for additional installation instructions.
|
||||||
|
|
||||||
After installing Filebeat, you need to configure it. Open the `filebeat.yml` file located in your Filebeat installation directory, and replace the contents with the following lines. Make sure `paths` points to the example Apache log file, `logstash-tutorial.log`, that you downloaded earlier:
|
After installing Filebeat, you need to configure it. Open the `filebeat.yml` file located in your Filebeat installation directory, and replace the contents with the following lines. Make sure `paths` points to the example Apache log file, `logstash-tutorial.log`, that you downloaded earlier:
|
||||||
|
|
||||||
|
@ -49,7 +49,7 @@ sudo ./filebeat -e -c filebeat.yml -d "publish"
|
||||||
```
|
```
|
||||||
|
|
||||||
::::{note}
|
::::{note}
|
||||||
If you run Filebeat as root, you need to change ownership of the configuration file (see [Config File Ownership and Permissions](beats://docs/reference/libbeat/config-file-permissions.md) in the *Beats Platform Reference*).
|
If you run Filebeat as root, you need to change ownership of the configuration file (see [Config File Ownership and Permissions](beats://reference/libbeat/config-file-permissions.md) in the *Beats Platform Reference*).
|
||||||
::::
|
::::
|
||||||
|
|
||||||
|
|
||||||
|
@ -605,7 +605,7 @@ If you are using Kibana to visualize your data, you can also explore the Filebea
|
||||||
:alt: Discovering Filebeat data in Kibana
|
:alt: Discovering Filebeat data in Kibana
|
||||||
:::
|
:::
|
||||||
|
|
||||||
See the [Filebeat quick start docs](beats://docs/reference/filebeat/filebeat-installation-configuration.md) for info about loading the Kibana index pattern for Filebeat.
|
See the [Filebeat quick start docs](beats://reference/filebeat/filebeat-installation-configuration.md) for info about loading the Kibana index pattern for Filebeat.
|
||||||
|
|
||||||
You’ve successfully created a pipeline that uses Filebeat to take Apache web logs as input, parses those logs to create specific, named fields from the logs, and writes the parsed data to an Elasticsearch cluster. Next, you learn how to create a pipeline that uses multiple input and output plugins.
|
You’ve successfully created a pipeline that uses Filebeat to take Apache web logs as input, parses those logs to create specific, named fields from the logs, and writes the parsed data to an Elasticsearch cluster. Next, you learn how to create a pipeline that uses multiple input and output plugins.
|
||||||
|
|
||||||
|
|
|
@ -42,7 +42,7 @@ monitoring.cluster_uuid: PRODUCTION_ES_CLUSTER_UUID
|
||||||
::::{dropdown} Create a monitoring user (standalone agent only)
|
::::{dropdown} Create a monitoring user (standalone agent only)
|
||||||
:name: create-user-db
|
:name: create-user-db
|
||||||
|
|
||||||
Create a user on the production cluster that has the `remote_monitoring_collector` [built-in role](elasticsearch://docs/reference/elasticsearch/roles.md).
|
Create a user on the production cluster that has the `remote_monitoring_collector` [built-in role](elasticsearch://reference/elasticsearch/roles.md).
|
||||||
|
|
||||||
::::
|
::::
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ The goal of this document is to highlight the most common architecture patterns
|
||||||
|
|
||||||
## Getting Started [deploying-getting-started]
|
## Getting Started [deploying-getting-started]
|
||||||
|
|
||||||
For first time users, if you simply want to tail a log file to grasp the power of the Elastic Stack, we recommend trying [Filebeat Modules](beats://docs/reference/filebeat/filebeat-modules-overview.md). Filebeat Modules enable you to quickly collect, parse, and index popular log types and view pre-built Kibana dashboards within minutes. [Metricbeat Modules](beats://docs/reference/metricbeat/metricbeat-modules.md) provide a similar experience, but with metrics data. In this context, Beats will ship data directly to Elasticsearch where [Ingest Nodes](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md) will process and index your data.
|
For first time users, if you simply want to tail a log file to grasp the power of the Elastic Stack, we recommend trying [Filebeat Modules](beats://reference/filebeat/filebeat-modules-overview.md). Filebeat Modules enable you to quickly collect, parse, and index popular log types and view pre-built Kibana dashboards within minutes. [Metricbeat Modules](beats://reference/metricbeat/metricbeat-modules.md) provide a similar experience, but with metrics data. In this context, Beats will ship data directly to Elasticsearch where [Ingest Nodes](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md) will process and index your data.
|
||||||
|
|
||||||
:::{image} ../images/deploy1.png
|
:::{image} ../images/deploy1.png
|
||||||
:alt: deploy1
|
:alt: deploy1
|
||||||
|
@ -56,7 +56,7 @@ Enabling persistent queues is strongly recommended, and these architecture chara
|
||||||
|
|
||||||
Logstash is horizontally scalable and can form groups of nodes running the same pipeline. Logstash’s adaptive buffering capabilities will facilitate smooth streaming even through variable throughput loads. If the Logstash layer becomes an ingestion bottleneck, simply add more nodes to scale out. Here are a few general recommendations:
|
Logstash is horizontally scalable and can form groups of nodes running the same pipeline. Logstash’s adaptive buffering capabilities will facilitate smooth streaming even through variable throughput loads. If the Logstash layer becomes an ingestion bottleneck, simply add more nodes to scale out. Here are a few general recommendations:
|
||||||
|
|
||||||
* Beats should [load balance](beats://docs/reference/filebeat/elasticsearch-output.md#_loadbalance) across a group of Logstash nodes.
|
* Beats should [load balance](beats://reference/filebeat/elasticsearch-output.md#_loadbalance) across a group of Logstash nodes.
|
||||||
* A minimum of two Logstash nodes are recommended for high availability.
|
* A minimum of two Logstash nodes are recommended for high availability.
|
||||||
* It’s common to deploy just one Beats input per Logstash node, but multiple Beats inputs can also be deployed per Logstash node to expose independent endpoints for different data sources.
|
* It’s common to deploy just one Beats input per Logstash node, but multiple Beats inputs can also be deployed per Logstash node to expose independent endpoints for different data sources.
|
||||||
|
|
||||||
|
@ -82,7 +82,7 @@ Logstash will commonly extract fields with [grok](/reference/plugins-filters-gro
|
||||||
|
|
||||||
Enterprise-grade security is available across the entire delivery chain.
|
Enterprise-grade security is available across the entire delivery chain.
|
||||||
|
|
||||||
* Wire encryption is recommended for both the transport from [Beats to Logstash](beats://docs/reference/filebeat/configuring-ssl-logstash.md) and from [Logstash to Elasticsearch](/reference/secure-connection.md).
|
* Wire encryption is recommended for both the transport from [Beats to Logstash](beats://reference/filebeat/configuring-ssl-logstash.md) and from [Logstash to Elasticsearch](/reference/secure-connection.md).
|
||||||
* There’s a wealth of security options when communicating with Elasticsearch including basic authentication, TLS, PKI, LDAP, AD, and other custom realms. To enable Elasticsearch security, see [Secure a cluster](docs-content://deploy-manage/security.md).
|
* There’s a wealth of security options when communicating with Elasticsearch including basic authentication, TLS, PKI, LDAP, AD, and other custom realms. To enable Elasticsearch security, see [Secure a cluster](docs-content://deploy-manage/security.md).
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@ mapped_pages:
|
||||||
|
|
||||||
# ECS in Logstash [ecs-ls]
|
# ECS in Logstash [ecs-ls]
|
||||||
|
|
||||||
The [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)) is an open source specification, developed with support from the Elastic user community. ECS defines a common set of fields to be used for storing event data, such as logs and metrics, in {{es}}. With ECS, users can normalize event data to better analyze, visualize, and correlate the data represented in their events.
|
The [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)) is an open source specification, developed with support from the Elastic user community. ECS defines a common set of fields to be used for storing event data, such as logs and metrics, in {{es}}. With ECS, users can normalize event data to better analyze, visualize, and correlate the data represented in their events.
|
||||||
|
|
||||||
## ECS compatibility [ecs-compatibility]
|
## ECS compatibility [ecs-compatibility]
|
||||||
|
|
||||||
|
|
|
@ -67,7 +67,7 @@ It is important that you secure the communication between Logstash instances. Us
|
||||||
1. Create a certificate authority (CA) in order to sign the certificates that you plan to use between Logstash instances. Creating a correct SSL/TLS infrastructure is outside the scope of this document.
|
1. Create a certificate authority (CA) in order to sign the certificates that you plan to use between Logstash instances. Creating a correct SSL/TLS infrastructure is outside the scope of this document.
|
||||||
|
|
||||||
::::{tip}
|
::::{tip}
|
||||||
We recommend you use the [elasticsearch-certutil](elasticsearch://docs/reference/elasticsearch/command-line-tools/certutil.md) tool to generate your certificates.
|
We recommend you use the [elasticsearch-certutil](elasticsearch://reference/elasticsearch/command-line-tools/certutil.md) tool to generate your certificates.
|
||||||
::::
|
::::
|
||||||
|
|
||||||
2. Configure the downstream (receiving) Logstash to use SSL. Add these settings to the HTTP Input configuration:
|
2. Configure the downstream (receiving) Logstash to use SSL. Add these settings to the HTTP Input configuration:
|
||||||
|
|
|
@ -62,7 +62,7 @@ It is important that you secure the communication between Logstash instances. Us
|
||||||
1. Create a certificate authority (CA) in order to sign the certificates that you plan to use between Logstash instances. Creating a correct SSL/TLS infrastructure is outside the scope of this document.
|
1. Create a certificate authority (CA) in order to sign the certificates that you plan to use between Logstash instances. Creating a correct SSL/TLS infrastructure is outside the scope of this document.
|
||||||
|
|
||||||
::::{tip}
|
::::{tip}
|
||||||
We recommend you use the [elasticsearch-certutil](elasticsearch://docs/reference/elasticsearch/command-line-tools/certutil.md) tool to generate your certificates.
|
We recommend you use the [elasticsearch-certutil](elasticsearch://reference/elasticsearch/command-line-tools/certutil.md) tool to generate your certificates.
|
||||||
::::
|
::::
|
||||||
|
|
||||||
2. Configure the downstream (receiving) Logstash to use SSL. Add these settings to the Logstash input configuration:
|
2. Configure the downstream (receiving) Logstash to use SSL. Add these settings to the Logstash input configuration:
|
||||||
|
|
|
@ -50,7 +50,7 @@ monitoring.cluster_uuid: PRODUCTION_ES_CLUSTER_UUID
|
||||||
::::{dropdown} Create a monitoring user (standalone agent only)
|
::::{dropdown} Create a monitoring user (standalone agent only)
|
||||||
:name: create-user-ea
|
:name: create-user-ea
|
||||||
|
|
||||||
Create a user on the production cluster that has the `remote_monitoring_collector` [built-in role](elasticsearch://docs/reference/elasticsearch/roles.md).
|
Create a user on the production cluster that has the `remote_monitoring_collector` [built-in role](elasticsearch://reference/elasticsearch/roles.md).
|
||||||
|
|
||||||
::::
|
::::
|
||||||
|
|
||||||
|
|
|
@ -44,7 +44,7 @@ Refer to [{{es}} cluster stats page](https://www.elastic.co/docs/api/doc/elastic
|
||||||
|
|
||||||
## Install and configure {{metricbeat}} [configure-metricbeat]
|
## Install and configure {{metricbeat}} [configure-metricbeat]
|
||||||
|
|
||||||
1. [Install {{metricbeat}}](beats://docs/reference/metricbeat/metricbeat-installation-configuration.md) on the same server as {{ls}}.
|
1. [Install {{metricbeat}}](beats://reference/metricbeat/metricbeat-installation-configuration.md) on the same server as {{ls}}.
|
||||||
2. Enable the `logstash-xpack` module in {{metricbeat}}.<br>
|
2. Enable the `logstash-xpack` module in {{metricbeat}}.<br>
|
||||||
|
|
||||||
To enable the default configuration in the {{metricbeat}} `modules.d` directory, run:
|
To enable the default configuration in the {{metricbeat}} `modules.d` directory, run:
|
||||||
|
@ -67,7 +67,7 @@ Refer to [{{es}} cluster stats page](https://www.elastic.co/docs/api/doc/elastic
|
||||||
PS > .\metricbeat.exe modules enable logstash-xpack
|
PS > .\metricbeat.exe modules enable logstash-xpack
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information, see [Specify which modules to run](beats://docs/reference/metricbeat/configuration-metricbeat.md) and [beat module](beats://docs/reference/metricbeat/metricbeat-module-beat.md).
|
For more information, see [Specify which modules to run](beats://reference/metricbeat/configuration-metricbeat.md) and [beat module](beats://reference/metricbeat/metricbeat-module-beat.md).
|
||||||
|
|
||||||
3. Configure the `logstash-xpack` module in {{metricbeat}}.<br>
|
3. Configure the `logstash-xpack` module in {{metricbeat}}.<br>
|
||||||
|
|
||||||
|
@ -97,12 +97,12 @@ Refer to [{{es}} cluster stats page](https://www.elastic.co/docs/api/doc/elastic
|
||||||
|
|
||||||
**Elastic security.** The Elastic {{security-features}} are enabled by default. You must provide a user ID and password so that {{metricbeat}} can collect metrics successfully:
|
**Elastic security.** The Elastic {{security-features}} are enabled by default. You must provide a user ID and password so that {{metricbeat}} can collect metrics successfully:
|
||||||
|
|
||||||
1. Create a user on the production cluster that has the `remote_monitoring_collector` [built-in role](elasticsearch://docs/reference/elasticsearch/roles.md).
|
1. Create a user on the production cluster that has the `remote_monitoring_collector` [built-in role](elasticsearch://reference/elasticsearch/roles.md).
|
||||||
2. Add the `username` and `password` settings to the module configuration file (`logstash-xpack.yml`).
|
2. Add the `username` and `password` settings to the module configuration file (`logstash-xpack.yml`).
|
||||||
|
|
||||||
4. Optional: Disable the system module in the {{metricbeat}}.
|
4. Optional: Disable the system module in the {{metricbeat}}.
|
||||||
|
|
||||||
By default, the [system module](beats://docs/reference/metricbeat/metricbeat-module-system.md) is enabled. The information it collects, however, is not shown on the **Stack Monitoring** page in {{kib}}. Unless you want to use that information for other purposes, run the following command:
|
By default, the [system module](beats://reference/metricbeat/metricbeat-module-system.md) is enabled. The information it collects, however, is not shown on the **Stack Monitoring** page in {{kib}}. Unless you want to use that information for other purposes, run the following command:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
metricbeat modules disable system
|
metricbeat modules disable system
|
||||||
|
@ -140,7 +140,7 @@ Refer to [{{es}} cluster stats page](https://www.elastic.co/docs/api/doc/elastic
|
||||||
|
|
||||||
**Elastic security.** The Elastic {{security-features}} are enabled by default. You must provide a user ID and password so that {{metricbeat}} can send metrics successfully:
|
**Elastic security.** The Elastic {{security-features}} are enabled by default. You must provide a user ID and password so that {{metricbeat}} can send metrics successfully:
|
||||||
|
|
||||||
1. Create a user on the monitoring cluster that has the `remote_monitoring_agent` [built-in role](elasticsearch://docs/reference/elasticsearch/roles.md). Alternatively, use the `remote_monitoring_user` [built-in user](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md).
|
1. Create a user on the monitoring cluster that has the `remote_monitoring_agent` [built-in role](elasticsearch://reference/elasticsearch/roles.md). Alternatively, use the `remote_monitoring_user` [built-in user](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/built-in-users.md).
|
||||||
|
|
||||||
::::{tip}
|
::::{tip}
|
||||||
If you’re using index lifecycle management, the remote monitoring user requires additional privileges to create and read indices. For more information, see `<<feature-roles>>`.
|
If you’re using index lifecycle management, the remote monitoring user requires additional privileges to create and read indices. For more information, see `<<feature-roles>>`.
|
||||||
|
@ -148,9 +148,9 @@ Refer to [{{es}} cluster stats page](https://www.elastic.co/docs/api/doc/elastic
|
||||||
|
|
||||||
2. Add the `username` and `password` settings to the {{es}} output information in the {{metricbeat}} configuration file.
|
2. Add the `username` and `password` settings to the {{es}} output information in the {{metricbeat}} configuration file.
|
||||||
|
|
||||||
For more information about these configuration options, see [Configure the {{es}} output](beats://docs/reference/metricbeat/elasticsearch-output.md).
|
For more information about these configuration options, see [Configure the {{es}} output](beats://reference/metricbeat/elasticsearch-output.md).
|
||||||
|
|
||||||
6. [Start {{metricbeat}}](beats://docs/reference/metricbeat/metricbeat-starting.md) to begin collecting monitoring data.
|
6. [Start {{metricbeat}}](beats://reference/metricbeat/metricbeat-starting.md) to begin collecting monitoring data.
|
||||||
7. [View the monitoring data in {{kib}}](docs-content://deploy-manage/monitor/stack-monitoring/kibana-monitoring-data.md).
|
7. [View the monitoring data in {{kib}}](docs-content://deploy-manage/monitor/stack-monitoring/kibana-monitoring-data.md).
|
||||||
|
|
||||||
Your monitoring setup is complete.
|
Your monitoring setup is complete.
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-10-16
|
* Released on: 2023-10-16
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-avro/blob/v3.4.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-avro/blob/v3.4.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-avro-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-avro-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_172]
|
## Getting help [_getting_help_172]
|
||||||
|
|
||||||
|
@ -90,7 +90,7 @@ output {
|
||||||
* `v1`,`v8`: Elastic Common Schema compliant behavior (`[event][original]` is also added)
|
* `v1`,`v8`: Elastic Common Schema compliant behavior (`[event][original]` is also added)
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `encoding` [plugins-codecs-avro-encoding]
|
### `encoding` [plugins-codecs-avro-encoding]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-10-22
|
* Released on: 2024-10-22
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-cef/blob/v6.2.8/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-cef/blob/v6.2.8/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-cef-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-cef-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_173]
|
## Getting help [_getting_help_173]
|
||||||
|
|
||||||
|
@ -425,7 +425,7 @@ If the codec handles data from a variety of sources, the ECS recommendation is t
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `fields` [plugins-codecs-cef-fields]
|
### `fields` [plugins-codecs-cef-fields]
|
||||||
|
|
|
@ -12,7 +12,7 @@ mapped_pages:
|
||||||
* Released on: 2024-07-26
|
* Released on: 2024-07-26
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.8/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.8/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-cloudfront-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-cloudfront-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_174]
|
## Getting help [_getting_help_174]
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ mapped_pages:
|
||||||
* Released on: 2024-07-26
|
* Released on: 2024-07-26
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.8/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.8/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-cloudtrail-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-cloudtrail-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_175]
|
## Getting help [_getting_help_175]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-08-04
|
* Released on: 2021-08-04
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-collectd/blob/v3.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-collectd/blob/v3.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-collectd-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-collectd-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_176]
|
## Getting help [_getting_help_176]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-07-28
|
* Released on: 2021-07-28
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-csv/blob/v1.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-csv/blob/v1.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-csv-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-csv-index.md).
|
||||||
|
|
||||||
## Installation [_installation_68]
|
## Installation [_installation_68]
|
||||||
|
|
||||||
|
@ -122,7 +122,7 @@ Define a set of datatype conversions to be applied to columns. Possible conversi
|
||||||
* Otherwise, the default value is `disabled`
|
* Otherwise, the default value is `disabled`
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `include_headers` [plugins-codecs-csv-include_headers]
|
### `include_headers` [plugins-codecs-csv-include_headers]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-dots/blob/v3.0.6/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-dots/blob/v3.0.6/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-dots-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-dots-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_178]
|
## Getting help [_getting_help_178]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-08-04
|
* Released on: 2021-08-04
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-edn/blob/v3.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-edn/blob/v3.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-edn-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-edn-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_179]
|
## Getting help [_getting_help_179]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-08-04
|
* Released on: 2021-08-04
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-edn_lines/blob/v3.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-edn_lines/blob/v3.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-edn_lines-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-edn_lines-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_180]
|
## Getting help [_getting_help_180]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-08-19
|
* Released on: 2021-08-19
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-es_bulk/blob/v3.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-es_bulk/blob/v3.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-es_bulk-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-es_bulk-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_181]
|
## Getting help [_getting_help_181]
|
||||||
|
|
||||||
|
@ -53,7 +53,7 @@ When ECS compatibility is disabled, the metadata is stored in the `[@metadata]`
|
||||||
* `v1`: uses `[@metadata][codec][es_bulk]` fields
|
* `v1`: uses `[@metadata][codec][es_bulk]` fields
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `target` [plugins-codecs-es_bulk-target]
|
### `target` [plugins-codecs-es_bulk-target]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-06-25
|
* Released on: 2024-06-25
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-fluent/blob/v3.4.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-fluent/blob/v3.4.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-fluent-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-fluent-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_182]
|
## Getting help [_getting_help_182]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-08-12
|
* Released on: 2021-08-12
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-graphite/blob/v3.0.6/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-graphite/blob/v3.0.6/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-graphite-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-graphite-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_183]
|
## Getting help [_getting_help_183]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2019-07-23
|
* Released on: 2019-07-23
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-gzip_lines/blob/v3.0.4/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-gzip_lines/blob/v3.0.4/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-gzip_lines-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-gzip_lines-index.md).
|
||||||
|
|
||||||
## Installation [_installation_69]
|
## Installation [_installation_69]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-10-03
|
* Released on: 2022-10-03
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-json/blob/v3.1.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-json/blob/v3.1.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-json-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-json-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_188]
|
## Getting help [_getting_help_188]
|
||||||
|
|
||||||
|
@ -65,7 +65,7 @@ For nxlog users, you may to set this to "CP1252".
|
||||||
* Otherwise, the default value is `disabled`
|
* Otherwise, the default value is `disabled`
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `target` [plugins-codecs-json-target]
|
### `target` [plugins-codecs-json-target]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-09-06
|
* Released on: 2024-09-06
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-json_lines/blob/v3.2.2/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-json_lines/blob/v3.2.2/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-json_lines-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-json_lines-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_189]
|
## Getting help [_getting_help_189]
|
||||||
|
|
||||||
|
@ -77,7 +77,7 @@ Change the delimiter that separates lines
|
||||||
* Otherwise, the default value is `disabled`
|
* Otherwise, the default value is `disabled`
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `target` [plugins-codecs-json_lines-target]
|
### `target` [plugins-codecs-json_lines-target]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-07-15
|
* Released on: 2021-07-15
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-line/blob/v3.1.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-line/blob/v3.1.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-line-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-line-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_190]
|
## Getting help [_getting_help_190]
|
||||||
|
|
||||||
|
@ -31,7 +31,7 @@ Encoding behavior
|
||||||
|
|
||||||
## Compatibility with the Elastic Common Schema (ECS) [plugins-codecs-line-ecs]
|
## Compatibility with the Elastic Common Schema (ECS) [plugins-codecs-line-ecs]
|
||||||
|
|
||||||
This plugin is compatible with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). No additional configuration is required.
|
This plugin is compatible with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). No additional configuration is required.
|
||||||
|
|
||||||
|
|
||||||
## Line codec configuration options [plugins-codecs-line-options]
|
## Line codec configuration options [plugins-codecs-line-options]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-08-09
|
* Released on: 2021-08-09
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-msgpack/blob/v3.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-msgpack/blob/v3.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-msgpack-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-msgpack-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_191]
|
## Getting help [_getting_help_191]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-04-25
|
* Released on: 2024-04-25
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-multiline/blob/v3.1.2/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-multiline/blob/v3.1.2/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-multiline-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-multiline-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_192]
|
## Getting help [_getting_help_192]
|
||||||
|
|
||||||
|
@ -149,7 +149,7 @@ This only affects "plain" format logs since JSON is `UTF-8` already.
|
||||||
* Otherwise, the default value is `disabled`
|
* Otherwise, the default value is `disabled`
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `max_bytes` [plugins-codecs-multiline-max_bytes]
|
### `max_bytes` [plugins-codecs-multiline-max_bytes]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-12-22
|
* Released on: 2023-12-22
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-netflow/blob/v4.3.2/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-netflow/blob/v4.3.2/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-netflow-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-netflow-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_193]
|
## Getting help [_getting_help_193]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-11-16
|
* Released on: 2022-11-16
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-nmap/blob/v0.0.22/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-nmap/blob/v0.0.22/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-nmap-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-nmap-index.md).
|
||||||
|
|
||||||
## Installation [_installation_70]
|
## Installation [_installation_70]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-07-27
|
* Released on: 2021-07-27
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-plain/blob/v3.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-plain/blob/v3.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-plain-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-plain-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_195]
|
## Getting help [_getting_help_195]
|
||||||
|
|
||||||
|
@ -61,7 +61,7 @@ This only affects "plain" format logs since json is `UTF-8` already.
|
||||||
* Otherwise, the default value is `disabled`
|
* Otherwise, the default value is `disabled`
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `format` [plugins-codecs-plain-format]
|
### `format` [plugins-codecs-plain-format]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-09-20
|
* Released on: 2023-09-20
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-protobuf/blob/v1.3.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-protobuf/blob/v1.3.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-protobuf-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-protobuf-index.md).
|
||||||
|
|
||||||
## Installation [_installation_71]
|
## Installation [_installation_71]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2020-07-08
|
* Released on: 2020-07-08
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-codec-rubydebug/blob/v3.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-codec-rubydebug/blob/v3.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/codec-rubydebug-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/codec-rubydebug-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_197]
|
## Getting help [_getting_help_197]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-10-29
|
* Released on: 2021-10-29
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-age/blob/v1.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-age/blob/v1.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-age-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-age-index.md).
|
||||||
|
|
||||||
## Installation [_installation_54]
|
## Installation [_installation_54]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-10-11
|
* Released on: 2021-10-11
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-aggregate/blob/v2.10.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-aggregate/blob/v2.10.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-aggregate-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-aggregate-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_124]
|
## Getting help [_getting_help_124]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-alter/blob/v3.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-alter/blob/v3.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-alter-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-alter-index.md).
|
||||||
|
|
||||||
## Installation [_installation_55]
|
## Installation [_installation_55]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2020-08-18
|
* Released on: 2020-08-18
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-bytes/blob/v1.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-bytes/blob/v1.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-bytes-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-bytes-index.md).
|
||||||
|
|
||||||
## Installation [_installation_56]
|
## Installation [_installation_56]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2019-09-18
|
* Released on: 2019-09-18
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-cidr/blob/v3.1.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-cidr/blob/v3.1.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-cidr-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-cidr-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_127]
|
## Getting help [_getting_help_127]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-06-21
|
* Released on: 2022-06-21
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-cipher/blob/v4.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-cipher/blob/v4.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-cipher-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-cipher-index.md).
|
||||||
|
|
||||||
## Installation [_installation_57]
|
## Installation [_installation_57]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-11-10
|
* Released on: 2021-11-10
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-clone/blob/v4.2.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-clone/blob/v4.2.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-clone-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-clone-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_129]
|
## Getting help [_getting_help_129]
|
||||||
|
|
||||||
|
@ -72,7 +72,7 @@ Note: setting an empty array will not create any clones. A warning message is lo
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). The value of this setting affects the behavior of the [`clones`](#plugins-filters-clone-clones)
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). The value of this setting affects the behavior of the [`clones`](#plugins-filters-clone-clones)
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-06-08
|
* Released on: 2021-06-08
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-csv/blob/v3.1.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-csv/blob/v3.1.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-csv-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-csv-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_130]
|
## Getting help [_getting_help_130]
|
||||||
|
|
||||||
|
@ -112,7 +112,7 @@ Example:
|
||||||
* `v1`: uses the value in `target` as field name
|
* `v1`: uses the value in `target` as field name
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). See [Event Metadata and the Elastic Common Schema (ECS)](#plugins-filters-csv-ecs_metadata) for detailed information.
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). See [Event Metadata and the Elastic Common Schema (ECS)](#plugins-filters-csv-ecs_metadata) for detailed information.
|
||||||
|
|
||||||
|
|
||||||
### `quote_char` [plugins-filters-csv-quote_char]
|
### `quote_char` [plugins-filters-csv-quote_char]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-06-29
|
* Released on: 2022-06-29
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-date/blob/v3.1.15/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-date/blob/v3.1.15/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-date-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-date-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_131]
|
## Getting help [_getting_help_131]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-05-27
|
* Released on: 2024-05-27
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-de_dot/blob/v1.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-de_dot/blob/v1.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-de_dot-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-de_dot-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_132]
|
## Getting help [_getting_help_132]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-02-14
|
* Released on: 2022-02-14
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-dissect/blob/v1.2.5/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-dissect/blob/v1.2.5/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-dissect-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-dissect-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_133]
|
## Getting help [_getting_help_133]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-01-26
|
* Released on: 2023-01-26
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-dns/blob/v3.2.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-dns/blob/v3.2.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-dns-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-dns-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_134]
|
## Getting help [_getting_help_134]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-drop/blob/v3.0.5/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-drop/blob/v3.0.5/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-drop-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-drop-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_135]
|
## Getting help [_getting_help_135]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2018-07-31
|
* Released on: 2018-07-31
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-elapsed/blob/v4.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-elapsed/blob/v4.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-elapsed-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-elapsed-index.md).
|
||||||
|
|
||||||
## Installation [_installation_58]
|
## Installation [_installation_58]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2025-01-08
|
* Released on: 2025-01-08
|
||||||
* [Changelog](https://github.com/elastic/logstash-filter-elastic_integration/blob/v8.17.0/CHANGELOG.md)
|
* [Changelog](https://github.com/elastic/logstash-filter-elastic_integration/blob/v8.17.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-elastic_integration-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-elastic_integration-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_137]
|
## Getting help [_getting_help_137]
|
||||||
|
|
||||||
|
@ -29,7 +29,7 @@ Use of this plugin requires an active Elastic Enterprise [subscription](https://
|
||||||
Use this filter to process Elastic integrations powered by {{es}} Ingest Node in {{ls}}.
|
Use this filter to process Elastic integrations powered by {{es}} Ingest Node in {{ls}}.
|
||||||
|
|
||||||
::::{admonition} Extending Elastic integrations with {ls}
|
::::{admonition} Extending Elastic integrations with {ls}
|
||||||
This plugin can help you take advantage of the extensive, built-in capabilities of [Elastic {{integrations}}](integration-docs://docs/reference/index.md)—such as managing data collection, transformation, and visualization—and then use {{ls}} for additional data processing and output options. For more info about extending Elastic integrations with {{ls}}, check out [Using {{ls}} with Elastic Integrations](/reference/using-logstash-with-elastic-integrations.md).
|
This plugin can help you take advantage of the extensive, built-in capabilities of [Elastic {{integrations}}](integration-docs://reference/index.md)—such as managing data collection, transformation, and visualization—and then use {{ls}} for additional data processing and output options. For more info about extending Elastic integrations with {{ls}}, check out [Using {{ls}} with Elastic Integrations](/reference/using-logstash-with-elastic-integrations.md).
|
||||||
|
|
||||||
::::
|
::::
|
||||||
|
|
||||||
|
@ -185,7 +185,7 @@ This filter can run {{es}} Ingest Node pipelines that are *wholly* comprised of
|
||||||
| `uppercase` | *none* |
|
| `uppercase` | *none* |
|
||||||
| `uri_parts` | *none* |
|
| `uri_parts` | *none* |
|
||||||
| `urldecode` | *none* |
|
| `urldecode` | *none* |
|
||||||
| `user_agent` | side-loading a custom regex file is not supported; the processor will use the default user agent definitions as specified in [Elasticsearch processor definition](elasticsearch://docs/reference/ingestion-tools/enrich-processor/user-agent-processor.md) |
|
| `user_agent` | side-loading a custom regex file is not supported; the processor will use the default user agent definitions as specified in [Elasticsearch processor definition](elasticsearch://reference/ingestion-tools/enrich-processor/user-agent-processor.md) |
|
||||||
| Redact | `redact` | *none* |
|
| Redact | `redact` | *none* |
|
||||||
| GeoIp | `geoip` | requires MaxMind GeoIP2 databases, which may be provided by Logstash’s Geoip Database Management *OR* configured using [`geoip_database_directory`](#plugins-filters-elastic_integration-geoip_database_directory) |
|
| GeoIp | `geoip` | requires MaxMind GeoIP2 databases, which may be provided by Logstash’s Geoip Database Management *OR* configured using [`geoip_database_directory`](#plugins-filters-elastic_integration-geoip_database_directory) |
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2025-01-10
|
* Released on: 2025-01-10
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v4.0.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v4.0.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-elasticsearch-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-elasticsearch-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_138]
|
## Getting help [_getting_help_138]
|
||||||
|
|
||||||
|
@ -290,7 +290,7 @@ Set the address of a forward HTTP proxy. An empty string is treated as if proxy
|
||||||
* Value type is [string](/reference/configuration-file-structure.md#string)
|
* Value type is [string](/reference/configuration-file-structure.md#string)
|
||||||
* There is no default value for this setting.
|
* There is no default value for this setting.
|
||||||
|
|
||||||
Elasticsearch query string. More information is available in the [Elasticsearch query string documentation](elasticsearch://docs/reference/query-languages/query-dsl-query-string-query.md#query-string-syntax). Use either `query` or `query_template`.
|
Elasticsearch query string. More information is available in the [Elasticsearch query string documentation](elasticsearch://reference/query-languages/query-dsl-query-string-query.md#query-string-syntax). Use either `query` or `query_template`.
|
||||||
|
|
||||||
|
|
||||||
### `query_template` [plugins-filters-elasticsearch-query_template]
|
### `query_template` [plugins-filters-elasticsearch-query_template]
|
||||||
|
@ -298,7 +298,7 @@ Elasticsearch query string. More information is available in the [Elasticsearch
|
||||||
* Value type is [string](/reference/configuration-file-structure.md#string)
|
* Value type is [string](/reference/configuration-file-structure.md#string)
|
||||||
* There is no default value for this setting.
|
* There is no default value for this setting.
|
||||||
|
|
||||||
File path to elasticsearch query in DSL format. More information is available in the [Elasticsearch query documentation](elasticsearch://docs/reference/query-languages/querydsl.md). Use either `query` or `query_template`.
|
File path to elasticsearch query in DSL format. More information is available in the [Elasticsearch query documentation](elasticsearch://reference/query-languages/querydsl.md). Use either `query` or `query_template`.
|
||||||
|
|
||||||
|
|
||||||
### `result_size` [plugins-filters-elasticsearch-result_size]
|
### `result_size` [plugins-filters-elasticsearch-result_size]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-environment/blob/v3.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-environment/blob/v3.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-environment-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-environment-index.md).
|
||||||
|
|
||||||
## Installation [_installation_59]
|
## Installation [_installation_59]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-extractnumbers/blob/v3.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-extractnumbers/blob/v3.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-extractnumbers-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-extractnumbers-index.md).
|
||||||
|
|
||||||
## Installation [_installation_60]
|
## Installation [_installation_60]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-03-19
|
* Released on: 2024-03-19
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-fingerprint/blob/v3.4.4/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-fingerprint/blob/v3.4.4/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-fingerprint-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-fingerprint-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_141]
|
## Getting help [_getting_help_141]
|
||||||
|
|
||||||
|
@ -135,7 +135,7 @@ When set to `true` and `method` isn’t `UUID` or `PUNCTUATION`, the plugin conc
|
||||||
* `v1`: uses `[event][hash]` fields that are compatible with Elastic Common Schema
|
* `v1`: uses `[event][hash]` fields that are compatible with Elastic Common Schema
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). See [Event Metadata and the Elastic Common Schema (ECS)](#plugins-filters-fingerprint-ecs_metadata) for detailed information.
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). See [Event Metadata and the Elastic Common Schema (ECS)](#plugins-filters-fingerprint-ecs_metadata) for detailed information.
|
||||||
|
|
||||||
|
|
||||||
### `key` [plugins-filters-fingerprint-key]
|
### `key` [plugins-filters-fingerprint-key]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-10-11
|
* Released on: 2024-10-11
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-geoip/blob/v7.3.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-geoip/blob/v7.3.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-geoip-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-geoip-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_142]
|
## Getting help [_getting_help_142]
|
||||||
|
|
||||||
|
@ -210,7 +210,7 @@ When this plugin is run with [`ecs_compatibility`](#plugins-filters-geoip-ecs_co
|
||||||
|
|
||||||
When using a City database, the enrichment is aborted if no latitude/longitude pair is available.
|
When using a City database, the enrichment is aborted if no latitude/longitude pair is available.
|
||||||
|
|
||||||
The `location` field combines the latitude and longitude into a structure called [GeoJSON](https://datatracker.ietf.org/doc/html/rfc7946). When you are using a default [`target`](#plugins-filters-geoip-target), the templates provided by the [elasticsearch output](/reference/plugins-outputs-elasticsearch.md) map the field to an [Elasticsearch Geo_point datatype](elasticsearch://docs/reference/elasticsearch/mapping-reference/geo-point.md).
|
The `location` field combines the latitude and longitude into a structure called [GeoJSON](https://datatracker.ietf.org/doc/html/rfc7946). When you are using a default [`target`](#plugins-filters-geoip-target), the templates provided by the [elasticsearch output](/reference/plugins-outputs-elasticsearch.md) map the field to an [Elasticsearch Geo_point datatype](elasticsearch://reference/elasticsearch/mapping-reference/geo-point.md).
|
||||||
|
|
||||||
As this field is a `geo_point` *and* it is still valid GeoJSON, you get the awesomeness of Elasticsearch’s geospatial query, facet and filter functions and the flexibility of having GeoJSON for all other applications (like Kibana’s map visualization).
|
As this field is a `geo_point` *and* it is still valid GeoJSON, you get the awesomeness of Elasticsearch’s geospatial query, facet and filter functions and the flexibility of having GeoJSON for all other applications (like Kibana’s map visualization).
|
||||||
|
|
||||||
|
@ -299,7 +299,7 @@ For a complete list of available fields and how they map to an event’s structu
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). The value of this setting affects the *default* value of [`target`](#plugins-filters-geoip-target).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). The value of this setting affects the *default* value of [`target`](#plugins-filters-geoip-target).
|
||||||
|
|
||||||
|
|
||||||
### `source` [plugins-filters-geoip-source]
|
### `source` [plugins-filters-geoip-source]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-10-28
|
* Released on: 2022-10-28
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-grok/blob/v4.4.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-grok/blob/v4.4.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-grok-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-grok-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_143]
|
## Getting help [_getting_help_143]
|
||||||
|
|
||||||
|
@ -158,7 +158,7 @@ Another option is to define patterns *inline* in the filter using `pattern_defin
|
||||||
|
|
||||||
## Migrating to Elastic Common Schema (ECS) [plugins-filters-grok-ecs]
|
## Migrating to Elastic Common Schema (ECS) [plugins-filters-grok-ecs]
|
||||||
|
|
||||||
To ease migration to the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)), the filter plugin offers a new set of ECS-compliant patterns in addition to the existing patterns. The new ECS pattern definitions capture event field names that are compliant with the schema.
|
To ease migration to the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)), the filter plugin offers a new set of ECS-compliant patterns in addition to the existing patterns. The new ECS pattern definitions capture event field names that are compliant with the schema.
|
||||||
|
|
||||||
The ECS pattern set has all of the pattern definitions from the legacy set, and is a drop-in replacement. Use the [`ecs_compatibility`](#plugins-filters-grok-ecs_compatibility) setting to switch modes.
|
The ECS pattern set has all of the pattern definitions from the legacy set, and is a drop-in replacement. Use the [`ecs_compatibility`](#plugins-filters-grok-ecs_compatibility) setting to switch modes.
|
||||||
|
|
||||||
|
@ -211,7 +211,7 @@ Break on first match. The first successful match by grok will result in the filt
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). The value of this setting affects extracted event field names when a composite pattern (such as `HTTPD_COMMONLOG`) is matched.
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). The value of this setting affects extracted event field names when a composite pattern (such as `HTTPD_COMMONLOG`) is matched.
|
||||||
|
|
||||||
|
|
||||||
### `keep_empty_captures` [plugins-filters-grok-keep_empty_captures]
|
### `keep_empty_captures` [plugins-filters-grok-keep_empty_captures]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-12-18
|
* Released on: 2024-12-18
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-http/blob/v2.0.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-http/blob/v2.0.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-http-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-http-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_144]
|
## Getting help [_getting_help_144]
|
||||||
|
|
||||||
|
@ -126,7 +126,7 @@ If set to `"json"` and the [`body`](#plugins-filters-http-body) is a type of [ar
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). The value of this setting affects the *default* value of [`target_body`](#plugins-filters-http-target_body) and [`target_headers`](#plugins-filters-http-target_headers).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). The value of this setting affects the *default* value of [`target_body`](#plugins-filters-http-target_body) and [`target_headers`](#plugins-filters-http-target_headers).
|
||||||
|
|
||||||
|
|
||||||
### `headers` [plugins-filters-http-headers]
|
### `headers` [plugins-filters-http-headers]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-i18n/blob/v3.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-i18n/blob/v3.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-i18n-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-i18n-index.md).
|
||||||
|
|
||||||
## Installation [_installation_61]
|
## Installation [_installation_61]
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ mapped_pages:
|
||||||
* Released on: 2024-12-23
|
* Released on: 2024-12-23
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-jdbc_static-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-jdbc_static-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_147]
|
## Getting help [_getting_help_147]
|
||||||
|
|
||||||
|
@ -240,7 +240,7 @@ For loader performance reasons, the loading mechanism uses a CSV style file with
|
||||||
|
|
||||||
## Compatibility with the Elastic Common Schema (ECS) [plugins-filters-jdbc_static-ecs]
|
## Compatibility with the Elastic Common Schema (ECS) [plugins-filters-jdbc_static-ecs]
|
||||||
|
|
||||||
This plugin is compatible with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). It behaves the same regardless of ECS compatibility, except giving a warning when ECS is enabled and `target` isn’t set.
|
This plugin is compatible with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). It behaves the same regardless of ECS compatibility, except giving a warning when ECS is enabled and `target` isn’t set.
|
||||||
|
|
||||||
::::{tip}
|
::::{tip}
|
||||||
Set the `target` option to avoid potential schema conflicts.
|
Set the `target` option to avoid potential schema conflicts.
|
||||||
|
|
|
@ -12,7 +12,7 @@ mapped_pages:
|
||||||
* Released on: 2024-12-23
|
* Released on: 2024-12-23
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-jdbc_streaming-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-jdbc_streaming-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_148]
|
## Getting help [_getting_help_148]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-12-18
|
* Released on: 2023-12-18
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-json/blob/v3.2.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-json/blob/v3.2.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-json-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-json-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_149]
|
## Getting help [_getting_help_149]
|
||||||
|
|
||||||
|
@ -64,7 +64,7 @@ Also see [Common options](#plugins-filters-json-common-options) for a list of op
|
||||||
* `v1`: Elastic Common Schema compliant behavior (warns when `target` isn’t set)
|
* `v1`: Elastic Common Schema compliant behavior (warns when `target` isn’t set)
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). See [Event Metadata and the Elastic Common Schema (ECS)](#plugins-filters-json-ecs_metadata) for detailed information.
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). See [Event Metadata and the Elastic Common Schema (ECS)](#plugins-filters-json-ecs_metadata) for detailed information.
|
||||||
|
|
||||||
|
|
||||||
### `skip_on_invalid_json` [plugins-filters-json-skip_on_invalid_json]
|
### `skip_on_invalid_json` [plugins-filters-json-skip_on_invalid_json]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-json_encode/blob/v3.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-json_encode/blob/v3.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-json_encode-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-json_encode-index.md).
|
||||||
|
|
||||||
## Installation [_installation_62]
|
## Installation [_installation_62]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-03-04
|
* Released on: 2022-03-04
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-kv/blob/v4.7.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-kv/blob/v4.7.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-kv-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-kv-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_151]
|
## Getting help [_getting_help_151]
|
||||||
|
|
||||||
|
@ -143,7 +143,7 @@ A hash specifying the default keys and their values which should be added to the
|
||||||
* `v1`: Elastic Common Schema compliant behavior (warns when `target` isn’t set)
|
* `v1`: Elastic Common Schema compliant behavior (warns when `target` isn’t set)
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). See [Event Metadata and the Elastic Common Schema (ECS)](#plugins-filters-kv-ecs_metadata) for detailed information.
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). See [Event Metadata and the Elastic Common Schema (ECS)](#plugins-filters-kv-ecs_metadata) for detailed information.
|
||||||
|
|
||||||
|
|
||||||
### `exclude_keys` [plugins-filters-kv-exclude_keys]
|
### `exclude_keys` [plugins-filters-kv-exclude_keys]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-01-18
|
* Released on: 2023-01-18
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-memcached/blob/v1.2.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-memcached/blob/v1.2.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-memcached-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-memcached-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_152]
|
## Getting help [_getting_help_152]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-metricize/blob/v3.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-metricize/blob/v3.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-metricize-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-metricize-index.md).
|
||||||
|
|
||||||
## Installation [_installation_63]
|
## Installation [_installation_63]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-01-20
|
* Released on: 2021-01-20
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-metrics/blob/v4.0.7/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-metrics/blob/v4.0.7/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-metrics-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-metrics-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_154]
|
## Getting help [_getting_help_154]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-11-22
|
* Released on: 2023-11-22
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-mutate/blob/v3.5.8/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-mutate/blob/v3.5.8/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-mutate-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-mutate-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_155]
|
## Getting help [_getting_help_155]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2019-09-12
|
* Released on: 2019-09-12
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-prune/blob/v3.0.4/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-prune/blob/v3.0.4/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-prune-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-prune-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_156]
|
## Getting help [_getting_help_156]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-range/blob/v3.0.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-range/blob/v3.0.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-range-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-range-index.md).
|
||||||
|
|
||||||
## Installation [_installation_64]
|
## Installation [_installation_64]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-01-24
|
* Released on: 2022-01-24
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-ruby/blob/v3.1.8/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-ruby/blob/v3.1.8/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-ruby-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-ruby-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_158]
|
## Getting help [_getting_help_158]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2020-09-04
|
* Released on: 2020-09-04
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-sleep/blob/v3.0.7/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-sleep/blob/v3.0.7/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-sleep-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-sleep-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_159]
|
## Getting help [_getting_help_159]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2020-01-21
|
* Released on: 2020-01-21
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-split/blob/v3.1.8/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-split/blob/v3.1.8/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-split-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-split-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_160]
|
## Getting help [_getting_help_160]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-01-17
|
* Released on: 2024-01-17
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-syslog_pri/blob/v3.2.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-syslog_pri/blob/v3.2.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-syslog_pri-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-syslog_pri-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_161]
|
## Getting help [_getting_help_161]
|
||||||
|
|
||||||
|
@ -55,7 +55,7 @@ Also see [Common options](#plugins-filters-syslog_pri-common-options) for a list
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). The value of this setting affects the *default* value of [`syslog_pri_field_name`](#plugins-filters-syslog_pri-syslog_pri_field_name).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). The value of this setting affects the *default* value of [`syslog_pri_field_name`](#plugins-filters-syslog_pri-syslog_pri_field_name).
|
||||||
|
|
||||||
|
|
||||||
### `facility_labels` [plugins-filters-syslog_pri-facility_labels]
|
### `facility_labels` [plugins-filters-syslog_pri-facility_labels]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-throttle/blob/v4.0.4/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-throttle/blob/v4.0.4/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-throttle-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-throttle-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_163]
|
## Getting help [_getting_help_163]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-10-19
|
* Released on: 2023-10-19
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-tld/blob/v3.1.3/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-tld/blob/v3.1.3/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-tld-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-tld-index.md).
|
||||||
|
|
||||||
## Installation [_installation_66]
|
## Installation [_installation_66]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-06-14
|
* Released on: 2023-06-14
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-translate/blob/v3.4.2/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-translate/blob/v3.4.2/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-translate-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-translate-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_165]
|
## Getting help [_getting_help_165]
|
||||||
|
|
||||||
|
@ -168,7 +168,7 @@ The currently supported formats are YAML, JSON, and CSV. Format selection is bas
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). The value of this setting affects the *default* value of [`target`](#plugins-filters-translate-target).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). The value of this setting affects the *default* value of [`target`](#plugins-filters-translate-target).
|
||||||
|
|
||||||
|
|
||||||
### `exact` [plugins-filters-translate-exact]
|
### `exact` [plugins-filters-translate-exact]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-05-10
|
* Released on: 2023-05-10
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-truncate/blob/v1.0.6/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-truncate/blob/v1.0.6/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-truncate-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-truncate-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_166]
|
## Getting help [_getting_help_166]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-urldecode/blob/v3.0.6/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-urldecode/blob/v3.0.6/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-urldecode-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-urldecode-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_167]
|
## Getting help [_getting_help_167]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-09-19
|
* Released on: 2023-09-19
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-useragent/blob/v3.3.5/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-useragent/blob/v3.3.5/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-useragent-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-useragent-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_168]
|
## Getting help [_getting_help_168]
|
||||||
|
|
||||||
|
@ -127,7 +127,7 @@ Also see [Common options](#plugins-filters-useragent-common-options) for a list
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). The value of this setting affects the *default* value of [`target`](#plugins-filters-useragent-target).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). The value of this setting affects the *default* value of [`target`](#plugins-filters-useragent-target).
|
||||||
|
|
||||||
|
|
||||||
### `lru_cache_size` [plugins-filters-useragent-lru_cache_size]
|
### `lru_cache_size` [plugins-filters-useragent-lru_cache_size]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2017-11-07
|
* Released on: 2017-11-07
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-uuid/blob/v3.0.5/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-uuid/blob/v3.0.5/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-uuid-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-uuid-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_169]
|
## Getting help [_getting_help_169]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-10-29
|
* Released on: 2024-10-29
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-filter-xml/blob/v4.2.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-filter-xml/blob/v4.2.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/filter-xml-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/filter-xml-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_171]
|
## Getting help [_getting_help_171]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2025-01-03
|
* Released on: 2025-01-03
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.5.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.5.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-azure_event_hubs-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-azure_event_hubs-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_8]
|
## Getting help [_getting_help_8]
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ The `input-elastic_agent` plugin is the next generation of the `input-beats` plu
|
||||||
* Released on: 2024-12-02
|
* Released on: 2024-12-02
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-beats/blob/v7.0.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-beats/blob/v7.0.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-beats-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-beats-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_9]
|
## Getting help [_getting_help_9]
|
||||||
|
|
||||||
|
@ -66,7 +66,7 @@ Be sure that heap and direct memory combined does not exceed the total memory av
|
||||||
|
|
||||||
### Multi-line events [plugins-inputs-beats-multiline]
|
### Multi-line events [plugins-inputs-beats-multiline]
|
||||||
|
|
||||||
If you are shipping events that span multiple lines, you need to use the [configuration options available in Filebeat](beats://docs/reference/filebeat/multiline-examples.md) to handle multiline events before sending the event data to Logstash. You cannot use the [Multiline codec plugin](/reference/plugins-codecs-multiline.md) to handle multiline events. Doing so will result in the failure to start Logstash.
|
If you are shipping events that span multiple lines, you need to use the [configuration options available in Filebeat](beats://reference/filebeat/multiline-examples.md) to handle multiline events before sending the event data to Logstash. You cannot use the [Multiline codec plugin](/reference/plugins-codecs-multiline.md) to handle multiline events. Doing so will result in the failure to start Logstash.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,7 @@ mapped_pages:
|
||||||
* Released on: 2024-07-26
|
* Released on: 2024-07-26
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.8/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.8/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-cloudwatch-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-cloudwatch-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_10]
|
## Getting help [_getting_help_10]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2019-04-15
|
* Released on: 2019-04-15
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-couchdb_changes/blob/v3.1.6/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-couchdb_changes/blob/v3.1.6/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-couchdb_changes-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-couchdb_changes-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_11]
|
## Getting help [_getting_help_11]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-09-04
|
* Released on: 2024-09-04
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-dead_letter_queue/blob/v2.0.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-dead_letter_queue/blob/v2.0.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-dead_letter_queue-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-dead_letter_queue-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_12]
|
## Getting help [_getting_help_12]
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,7 @@ The `input-elastic_agent` plugin is the next generation of the `input-beats` plu
|
||||||
* Released on: 2024-12-02
|
* Released on: 2024-12-02
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-beats/blob/v7.0.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-beats/blob/v7.0.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-elastic_agent-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-elastic_agent-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_13]
|
## Getting help [_getting_help_13]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-12-23
|
* Released on: 2024-12-23
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-elastic_serverless_forwarder/blob/v2.0.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-elastic_serverless_forwarder/blob/v2.0.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-elastic_serverless_forwarder-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-elastic_serverless_forwarder-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_14]
|
## Getting help [_getting_help_14]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-12-18
|
* Released on: 2024-12-18
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-elasticsearch/blob/v5.0.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-elasticsearch/blob/v5.0.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-elasticsearch-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-elasticsearch-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_15]
|
## Getting help [_getting_help_15]
|
||||||
|
|
||||||
|
@ -253,7 +253,7 @@ Example
|
||||||
* Value type is [array](/reference/configuration-file-structure.md#array)
|
* Value type is [array](/reference/configuration-file-structure.md#array)
|
||||||
* Default value is `["_index", "_type", "_id"]`
|
* Default value is `["_index", "_type", "_id"]`
|
||||||
|
|
||||||
If document metadata storage is requested by enabling the `docinfo` option, this option lists the metadata fields to save in the current event. See [Meta-Fields](elasticsearch://docs/reference/elasticsearch/mapping-reference/document-metadata-fields.md) in the Elasticsearch documentation for more information.
|
If document metadata storage is requested by enabling the `docinfo` option, this option lists the metadata fields to save in the current event. See [Meta-Fields](elasticsearch://reference/elasticsearch/mapping-reference/document-metadata-fields.md) in the Elasticsearch documentation for more information.
|
||||||
|
|
||||||
|
|
||||||
### `docinfo_target` [plugins-inputs-elasticsearch-docinfo_target]
|
### `docinfo_target` [plugins-inputs-elasticsearch-docinfo_target]
|
||||||
|
@ -282,7 +282,7 @@ If document metadata storage is requested by enabling the `docinfo` option, this
|
||||||
* Otherwise, the default value is `disabled`
|
* Otherwise, the default value is `disabled`
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `hosts` [plugins-inputs-elasticsearch-hosts]
|
### `hosts` [plugins-inputs-elasticsearch-hosts]
|
||||||
|
@ -298,7 +298,7 @@ List of one or more Elasticsearch hosts to use for querying. Each host can be ei
|
||||||
* Value type is [string](/reference/configuration-file-structure.md#string)
|
* Value type is [string](/reference/configuration-file-structure.md#string)
|
||||||
* Default value is `"logstash-*"`
|
* Default value is `"logstash-*"`
|
||||||
|
|
||||||
The index or alias to search. Check out [Multi Indices documentation](elasticsearch://docs/reference/elasticsearch/rest-apis/api-conventions.md#api-multi-index) in the Elasticsearch documentation for info on referencing multiple indices.
|
The index or alias to search. Check out [Multi Indices documentation](elasticsearch://reference/elasticsearch/rest-apis/api-conventions.md#api-multi-index) in the Elasticsearch documentation for info on referencing multiple indices.
|
||||||
|
|
||||||
|
|
||||||
### `password` [plugins-inputs-elasticsearch-password]
|
### `password` [plugins-inputs-elasticsearch-password]
|
||||||
|
@ -322,9 +322,9 @@ Set the address of a forward HTTP proxy. An empty string is treated as if proxy
|
||||||
* Value type is [string](/reference/configuration-file-structure.md#string)
|
* Value type is [string](/reference/configuration-file-structure.md#string)
|
||||||
* Default value is `'{ "sort": [ "_doc" ] }'`
|
* Default value is `'{ "sort": [ "_doc" ] }'`
|
||||||
|
|
||||||
The query to be executed. Read the [Elasticsearch query DSL documentation](elasticsearch://docs/reference/query-languages/querydsl.md) for more information.
|
The query to be executed. Read the [Elasticsearch query DSL documentation](elasticsearch://reference/query-languages/querydsl.md) for more information.
|
||||||
|
|
||||||
When [`search_api`](#plugins-inputs-elasticsearch-search_api) resolves to `search_after` and the query does not specify `sort`, the default sort `'{ "sort": { "_shard_doc": "asc" } }'` will be added to the query. Please refer to the [Elasticsearch search_after](elasticsearch://docs/reference/elasticsearch/rest-apis/paginate-search-results.md#search-after) parameter to know more.
|
When [`search_api`](#plugins-inputs-elasticsearch-search_api) resolves to `search_after` and the query does not specify `sort`, the default sort `'{ "sort": { "_shard_doc": "asc" } }'` will be added to the query. Please refer to the [Elasticsearch search_after](elasticsearch://reference/elasticsearch/rest-apis/paginate-search-results.md#search-after) parameter to know more.
|
||||||
|
|
||||||
|
|
||||||
### `response_type` [plugins-inputs-elasticsearch-response_type]
|
### `response_type` [plugins-inputs-elasticsearch-response_type]
|
||||||
|
@ -383,7 +383,7 @@ With `auto` the plugin uses the `search_after` parameter for Elasticsearch versi
|
||||||
|
|
||||||
`search_after` uses [point in time](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time) and sort value to search. The query requires at least one `sort` field, as described in the [`query`](#plugins-inputs-elasticsearch-query) parameter.
|
`search_after` uses [point in time](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-open-point-in-time) and sort value to search. The query requires at least one `sort` field, as described in the [`query`](#plugins-inputs-elasticsearch-query) parameter.
|
||||||
|
|
||||||
`scroll` uses [scroll](elasticsearch://docs/reference/elasticsearch/rest-apis/paginate-search-results.md#scroll-search-results) API to search, which is no longer recommended.
|
`scroll` uses [scroll](elasticsearch://reference/elasticsearch/rest-apis/paginate-search-results.md#scroll-search-results) API to search, which is no longer recommended.
|
||||||
|
|
||||||
|
|
||||||
### `size` [plugins-inputs-elasticsearch-size]
|
### `size` [plugins-inputs-elasticsearch-size]
|
||||||
|
@ -400,7 +400,7 @@ This allows you to set the maximum number of hits returned per scroll.
|
||||||
* There is no default value.
|
* There is no default value.
|
||||||
* Sensible values range from 2 to about 8.
|
* Sensible values range from 2 to about 8.
|
||||||
|
|
||||||
In some cases, it is possible to improve overall throughput by consuming multiple distinct slices of a query simultaneously using [sliced scrolls](elasticsearch://docs/reference/elasticsearch/rest-apis/paginate-search-results.md#slice-scroll), especially if the pipeline is spending significant time waiting on Elasticsearch to provide results.
|
In some cases, it is possible to improve overall throughput by consuming multiple distinct slices of a query simultaneously using [sliced scrolls](elasticsearch://reference/elasticsearch/rest-apis/paginate-search-results.md#slice-scroll), especially if the pipeline is spending significant time waiting on Elasticsearch to provide results.
|
||||||
|
|
||||||
If set, the `slices` parameter tells the plugin how many slices to divide the work into, and will produce events from the slices in parallel until all of them are done scrolling.
|
If set, the `slices` parameter tells the plugin how many slices to divide the work into, and will produce events from the slices in parallel until all of them are done scrolling.
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-06-15
|
* Released on: 2022-06-15
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-exec/blob/v3.6.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-exec/blob/v3.6.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-exec-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-exec-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_16]
|
## Getting help [_getting_help_16]
|
||||||
|
|
||||||
|
@ -50,7 +50,7 @@ This will execute `echo` command every 30 seconds.
|
||||||
|
|
||||||
## Compatibility with the Elastic Common Schema (ECS) [plugins-inputs-exec-ecs]
|
## Compatibility with the Elastic Common Schema (ECS) [plugins-inputs-exec-ecs]
|
||||||
|
|
||||||
This plugin adds metadata about the event’s source, and can be configured to do so in an [ECS-compatible](ecs://docs/reference/index.md) way with [`ecs_compatibility`](#plugins-inputs-exec-ecs_compatibility). This metadata is added after the event has been decoded by the appropriate codec, and will not overwrite existing values.
|
This plugin adds metadata about the event’s source, and can be configured to do so in an [ECS-compatible](ecs://reference/index.md) way with [`ecs_compatibility`](#plugins-inputs-exec-ecs_compatibility). This metadata is added after the event has been decoded by the appropriate codec, and will not overwrite existing values.
|
||||||
|
|
||||||
| ECS Disabled | ECS v1 , v8 | Description |
|
| ECS Disabled | ECS v1 , v8 | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
|
@ -94,7 +94,7 @@ Command to run. For example, `uptime`
|
||||||
* `v1`, `v8`: uses fields that are compatible with ECS, such as `[host][name]`
|
* `v1`, `v8`: uses fields that are compatible with ECS, such as `[host][name]`
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). See [Compatibility with the Elastic Common Schema (ECS)](#plugins-inputs-exec-ecs) for detailed information.
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). See [Compatibility with the Elastic Common Schema (ECS)](#plugins-inputs-exec-ecs) for detailed information.
|
||||||
|
|
||||||
**Sample output: ECS enabled**
|
**Sample output: ECS enabled**
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-12-13
|
* Released on: 2023-12-13
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-file/blob/v4.4.6/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-file/blob/v4.4.6/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-file-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-file-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_17]
|
## Getting help [_getting_help_17]
|
||||||
|
|
||||||
|
@ -49,7 +49,7 @@ In the past attempts to simulate a Read mode while still assuming infinite strea
|
||||||
|
|
||||||
## Compatibility with the Elastic Common Schema (ECS) [plugins-inputs-file-ecs]
|
## Compatibility with the Elastic Common Schema (ECS) [plugins-inputs-file-ecs]
|
||||||
|
|
||||||
This plugin adds metadata about event’s source, and can be configured to do so in an [ECS-compatible](ecs://docs/reference/index.md) way with [`ecs_compatibility`](#plugins-inputs-file-ecs_compatibility). This metadata is added after the event has been decoded by the appropriate codec, and will never overwrite existing values.
|
This plugin adds metadata about event’s source, and can be configured to do so in an [ECS-compatible](ecs://reference/index.md) way with [`ecs_compatibility`](#plugins-inputs-file-ecs_compatibility). This metadata is added after the event has been decoded by the appropriate codec, and will never overwrite existing values.
|
||||||
|
|
||||||
| ECS Disabled | ECS `v1`, `v8` | Description |
|
| ECS Disabled | ECS `v1`, `v8` | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
|
@ -177,7 +177,7 @@ How often we expand the filename patterns in the `path` option to discover new f
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
|
||||||
|
|
||||||
|
|
||||||
### `exclude` [plugins-inputs-file-exclude]
|
### `exclude` [plugins-inputs-file-exclude]
|
||||||
|
@ -306,7 +306,7 @@ You may also configure multiple paths. See an example on the [Logstash configura
|
||||||
* The default value for this setting is "2 weeks".
|
* The default value for this setting is "2 weeks".
|
||||||
* If a number is specified then it is interpreted as **days** and can be decimal e.g. 0.5 is 12 hours.
|
* If a number is specified then it is interpreted as **days** and can be decimal e.g. 0.5 is 12 hours.
|
||||||
|
|
||||||
The sincedb record now has a last active timestamp associated with it. If no changes are detected in a tracked file in the last N days its sincedb tracking record expires and will not be persisted. This option helps protect against the inode recycling problem. Filebeat has an [FAQ about inode recycling](beats://docs/reference/filebeat/inode-reuse-issue.md).
|
The sincedb record now has a last active timestamp associated with it. If no changes are detected in a tracked file in the last N days its sincedb tracking record expires and will not be persisted. This option helps protect against the inode recycling problem. Filebeat has an [FAQ about inode recycling](beats://reference/filebeat/inode-reuse-issue.md).
|
||||||
|
|
||||||
|
|
||||||
### `sincedb_path` [plugins-inputs-file-sincedb_path]
|
### `sincedb_path` [plugins-inputs-file-sincedb_path]
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2018-04-06
|
* Released on: 2018-04-06
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-ganglia/blob/v3.1.4/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-ganglia/blob/v3.1.4/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-ganglia-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-ganglia-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_18]
|
## Getting help [_getting_help_18]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2022-08-22
|
* Released on: 2022-08-22
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-gelf/blob/v3.3.2/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-gelf/blob/v3.3.2/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-gelf-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-gelf-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_19]
|
## Getting help [_getting_help_19]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-11-04
|
* Released on: 2021-11-04
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-generator/blob/v3.1.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-generator/blob/v3.1.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-generator-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-generator-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_20]
|
## Getting help [_getting_help_20]
|
||||||
|
|
||||||
|
@ -29,7 +29,7 @@ An event is generated first
|
||||||
|
|
||||||
## Compatibility with the Elastic Common Schema (ECS) [plugins-inputs-generator-ecs]
|
## Compatibility with the Elastic Common Schema (ECS) [plugins-inputs-generator-ecs]
|
||||||
|
|
||||||
This plugin uses different field names depending on whether [ECS-compatibility](ecs://docs/reference/index.md) in enabled (see also [`ecs_compatibility`](#plugins-inputs-generator-ecs_compatibility)).
|
This plugin uses different field names depending on whether [ECS-compatibility](ecs://reference/index.md) in enabled (see also [`ecs_compatibility`](#plugins-inputs-generator-ecs_compatibility)).
|
||||||
|
|
||||||
| ECS Disabled | ECS v1, v8 | Description |
|
| ECS Disabled | ECS v1, v8 | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
|
@ -72,7 +72,7 @@ The default, `0`, means generate an unlimited number of events.
|
||||||
* `v1`, `v8`: uses fields that are compatible with ECS, such as `[host][name]`
|
* `v1`, `v8`: uses fields that are compatible with ECS, such as `[host][name]`
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). See [Compatibility with the Elastic Common Schema (ECS)](#plugins-inputs-generator-ecs) for detailed information.
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). See [Compatibility with the Elastic Common Schema (ECS)](#plugins-inputs-generator-ecs) for detailed information.
|
||||||
|
|
||||||
**Sample output: ECS enabled**
|
**Sample output: ECS enabled**
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-05-30
|
* Released on: 2023-05-30
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-github/blob/v3.0.11/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-github/blob/v3.0.11/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-github-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-github-index.md).
|
||||||
|
|
||||||
## Installation [_installation]
|
## Installation [_installation]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2023-08-22
|
* Released on: 2023-08-22
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-google_cloud_storage/blob/v0.15.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-google_cloud_storage/blob/v0.15.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-google_cloud_storage-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-google_cloud_storage-index.md).
|
||||||
|
|
||||||
## Installation [_installation_2]
|
## Installation [_installation_2]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2024-10-15
|
* Released on: 2024-10-15
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-google_pubsub/blob/v1.4.0/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-google_pubsub/blob/v1.4.0/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-google_pubsub-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-google_pubsub-index.md).
|
||||||
|
|
||||||
## Installation [_installation_3]
|
## Installation [_installation_3]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2018-04-06
|
* Released on: 2018-04-06
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-graphite/blob/v3.0.6/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-graphite/blob/v3.0.6/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-graphite-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-graphite-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_24]
|
## Getting help [_getting_help_24]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ mapped_pages:
|
||||||
* Released on: 2021-08-04
|
* Released on: 2021-08-04
|
||||||
* [Changelog](https://github.com/logstash-plugins/logstash-input-heartbeat/blob/v3.1.1/CHANGELOG.md)
|
* [Changelog](https://github.com/logstash-plugins/logstash-input-heartbeat/blob/v3.1.1/CHANGELOG.md)
|
||||||
|
|
||||||
For other versions, see the [Versioned plugin docs](logstash-docs://docs/reference/input-heartbeat-index.md).
|
For other versions, see the [Versioned plugin docs](logstash-docs://reference/input-heartbeat-index.md).
|
||||||
|
|
||||||
## Getting help [_getting_help_25]
|
## Getting help [_getting_help_25]
|
||||||
|
|
||||||
|
@ -78,7 +78,7 @@ How many times to iterate. This is typically used only for testing purposes.
|
||||||
* Otherwise, the default value is `disabled`.
|
* Otherwise, the default value is `disabled`.
|
||||||
|
|
||||||
|
|
||||||
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)). Refer to [Elastic Common Schema (ECS)](#plugins-inputs-heartbeat-ecs) in this topic for detailed information.
|
Controls this plugin’s compatibility with the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)). Refer to [Elastic Common Schema (ECS)](#plugins-inputs-heartbeat-ecs) in this topic for detailed information.
|
||||||
|
|
||||||
|
|
||||||
### `interval` [plugins-inputs-heartbeat-interval]
|
### `interval` [plugins-inputs-heartbeat-interval]
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue