Skip to content

Commit d1eba8c

Browse files
authored
Doc: Remove Tech Preview banner (#142)
* Add pointer to extending integrations conceptual docs * Bump to v0.1.9
1 parent 47269c2 commit d1eba8c

File tree

3 files changed

+21
-19
lines changed

3 files changed

+21
-19
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 0.1.9
2+
- [DOC] Removes Tech Preview label and adds link to extending integrations topic in LSR [#142](https://github.com/elastic/logstash-filter-elastic_integration/pull/142)
3+
14
## 0.1.8
25
- Fixes `EventProcessorBuilder#build` to work with JRuby 9.4.6.0 [#133](https://github.com/elastic/logstash-filter-elastic_integration/pull/133)
36

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.1.8
1+
0.1.9

docs/index.asciidoc

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,19 @@ Use of this plugin requires an active Elastic Enterprise https://www.elastic.co/
2727

2828
==== Description
2929

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

32-
Once configured to point to an {es} cluster, this filter will detect which ingest pipeline (if any) should be executed for each event,
32+
.Extending Elastic integrations with {ls}
33+
****
34+
This plugin can help you take advantage of the extensive, built-in capabilities of {integrations-docs}[Elastic {integrations}]—​such as managing data collection,
35+
transformation, and visualization—​and then use {ls} for additional data processing and output options.
36+
For more info about extending Elastic integrations with {ls}, check out {logstash-ref}/ea-integrations.html[Using {ls} with Elastic Integrations].
37+
****
38+
39+
When you configure this filter to point to an {es} cluster, it detects which ingest pipeline (if any) should be executed for each event,
3340
using an explicitly-defined <<plugins-{type}s-{plugin}-pipeline_name>> or auto-detecting the event's data-stream and its default pipeline.
3441

35-
It will then load that pipeline's definition from {es} and run that pipeline inside Logstash without transmitting the event to {es}.
42+
It then loads that pipeline's definition from {es} and run that pipeline inside Logstash without transmitting the event to {es}.
3643
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}.
3744

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

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

45-
.Technology Preview
46-
****
47-
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.
48-
49-
Before upgrading this plugin or Logstash itself, please pay special attention to the changelogs to avoid being caught by surprise.
50-
****
5152

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

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

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

236-
| `_id` | `{mcc-prefix}[id]`
237-
| `_index` | `{mcc-prefix}[index]`
238-
| `_routing` | `{mcc-prefix}[routing]`
239-
| `_version` | `{mcc-prefix}[version]`
240-
| `_version_type` | `{mcc-prefix}[version_type]`
241-
| `_ingest.timestamp` | `{mcc-prefix}[timestamp]`
235+
| `_id` | `[@metadata][_ingest_document][id]`
236+
| `_index` | `[@metadata][_ingest_document][index]`
237+
| `_routing` | `[@metadata][_ingest_document][routing]`
238+
| `_version` | `[@metadata][_ingest_document][version]`
239+
| `_version_type` | `[@metadata][_ingest_document][version_type]`
240+
| `_ingest.timestamp` | `[@metadata][_ingest_document][timestamp]`
242241
|=======================================================================
243242

244243

0 commit comments

Comments
 (0)