Skip to content

Commit

Permalink
updated docs for main (#1655)
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored May 14, 2024
1 parent 874a3b0 commit 4a72353
Showing 1 changed file with 20 additions and 21 deletions.
41 changes: 20 additions & 21 deletions docs/plugins/filters/elastic_integration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v0.1.8
:release_date: 2024-03-07
:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v0.1.8/CHANGELOG.md
:version: v0.1.9
:release_date: 2024-05-14
:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v0.1.9/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -28,12 +28,19 @@ Use of this plugin requires an active Elastic Enterprise https://www.elastic.co/

==== Description

Using this filter you can process Elastic integrations powered by {es} Ingest Node in Logstash.
Use this filter to process Elastic integrations powered by {es} Ingest Node in {ls}.

Once configured to point to an {es} cluster, this filter will detect which ingest pipeline (if any) should be executed for each event,
.Extending Elastic integrations with {ls}
****
This plugin can help you take advantage of the extensive, built-in capabilities of {integrations-docs}[Elastic {integrations}]—​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 {logstash-ref}/ea-integrations.html[Using {ls} with Elastic Integrations].
****

When you configure this filter to point to an {es} cluster, it detects which ingest pipeline (if any) should be executed for each event,
using an explicitly-defined <<plugins-{type}s-{plugin}-pipeline_name>> or auto-detecting the event's data-stream and its default pipeline.

It will then load that pipeline's definition from {es} and run that pipeline inside Logstash without transmitting the event to {es}.
It then loads that pipeline's definition from {es} and run that pipeline inside Logstash without transmitting the event to {es}.
Events that are successfully handled by their ingest pipeline will have `[@metadata][target_ingest_pipeline]` set to `_none` so that any downstream {es} output in the Logstash pipeline will avoid running the event's default pipeline _again_ in {es}.

NOTE: Some multi-pipeline configurations such as logstash-to-logstash over http(s) do not maintain the state of `[@metadata]` fields.
Expand All @@ -43,12 +50,6 @@ Events that _fail_ ingest pipeline processing will be tagged with `_ingest_pipel

IMPORTANT: This plugin requires minimum Java 17 and Logstash 8.7.0 versions.

.Technology Preview
****
This {elastic-integration-name} filter plugin is part of a _Technology Preview_, which means that both configuration options and implementation details are subject to change in minor releases without being preceded by deprecation warnings.
Before upgrading this plugin or Logstash itself, please pay special attention to the changelogs to avoid being caught by surprise.
****

[id="plugins-{type}s-{plugin}-minimum_configuration"]
==== Minimum Configuration
Expand Down Expand Up @@ -226,20 +227,18 @@ The ingest document's `tags`.
When the ingest document has a value for `tags` that cannot be coerced, it will be available in the event's `_tags` field.
|=======================================================================

Additionally, the following Elasticsearch IngestDocument Metadata fields are made available on the resulting event _if-and-only-if_ they were set during pipeline execution:

:mcc-prefix: [@metadata][_ingest_document]
Additionally, these {es} IngestDocument Metadata fields are made available on the resulting event _if-and-only-if_ they were set during pipeline execution:

[cols="<1,<5",options="header"]
|=======================================================================
| {es} document metadata | {ls} field

| `_id` | `{mcc-prefix}[id]`
| `_index` | `{mcc-prefix}[index]`
| `_routing` | `{mcc-prefix}[routing]`
| `_version` | `{mcc-prefix}[version]`
| `_version_type` | `{mcc-prefix}[version_type]`
| `_ingest.timestamp` | `{mcc-prefix}[timestamp]`
| `_id` | `[@metadata][_ingest_document][id]`
| `_index` | `[@metadata][_ingest_document][index]`
| `_routing` | `[@metadata][_ingest_document][routing]`
| `_version` | `[@metadata][_ingest_document][version]`
| `_version_type` | `[@metadata][_ingest_document][version_type]`
| `_ingest.timestamp` | `[@metadata][_ingest_document][timestamp]`
|=======================================================================


Expand Down

0 comments on commit 4a72353

Please sign in to comment.