-
Notifications
You must be signed in to change notification settings - Fork 478
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Data Prepper 2.10.0 release blog #3381
Merged
kolchfa-aws
merged 7 commits into
opensearch-project:main
from
dlvenable:data-prepper-2.10-release-blog
Oct 16, 2024
Merged
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
135262a
Data Prepper 2.10.0 release blog.
dlvenable 98fe5b7
Apply suggestions from code review
dlvenable c74a88d
Additional changes from the PR review.
dlvenable 7e6ea76
Added sb2k16 as the co-author. This is the short_name from the PR #3386.
dlvenable 8a33eba
Adds the Thank You text to the Data Prepper 2.10 blog post.
dlvenable 8a2f11e
Code review suggestions
dlvenable d201fd2
Code review suggestions
dlvenable File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,129 @@ | ||||||
--- | ||||||
layout: post | ||||||
title: Announcing Data Prepper 2.10.0 | ||||||
authors: | ||||||
- sb2k16 | ||||||
- dvenable | ||||||
date: 2024-10-15 12:30:00 -0600 | ||||||
categories: | ||||||
- releases | ||||||
excerpt: Data Prepper 2.10.0 offers an OpenSearch _bulk API and reads from Amazon Kinesis. | ||||||
meta_keywords: Data Prepper, OpenSearch bulk API, Kinesis data streams, Kafka, SASL/SCRAM authentication, streaming data ingestion | ||||||
meta_description: Data Prepper 2.10.0 adds OpenSearch API and Kinesis Data Streams sources for seamless ingestion, plus Kafka SASL/SCRAM support and OpenTelemetry log parsing. | ||||||
--- | ||||||
|
||||||
## Introduction | ||||||
|
||||||
Data Prepper 2.10 is now available! | ||||||
Two major features include a source that sends data to Data Prepper using an API mimicking the OpenSearch `_bulk` API and the ability to read from Amazon Kinesis Data Streams. | ||||||
|
||||||
|
||||||
## OpenSearch API source | ||||||
|
||||||
Many existing OpenSearch clients that perform ingestion directly to OpenSearch can now send that data to Data Prepper first. | ||||||
With this, you can use Data Prepper's buffering and rich processor set before sending data to OpenSearch without having to change clients that are using the OpenSearch `_bulk` API. | ||||||
A new Data Prepper source named `opensearch_api` has been added that accepts [OpenSearch Document API bulk operation](https://opensearch.org/docs/latest/api-reference/document-apis/bulk/) requests from clients using REST and ingests data into OpenSearch. | ||||||
The behavior of this source is also quite similar to the existing `http` source. | ||||||
It supports industry-standard encryption in the form of TLS/HTTPS and HTTP basic authentication. | ||||||
It also parses incoming requests and creates Data Prepper events and associated event metadata, making it compatible with the `opensearch` sink. | ||||||
The request body is compatible with the OpenSearch Document API bulk operation and supports all actions: index, create, delete, and update. | ||||||
|
||||||
natebower marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
The following two HTTP methods are now supported: | ||||||
|
||||||
``` | ||||||
POST _bulk | ||||||
POST <index>/_bulk | ||||||
``` | ||||||
|
||||||
The second API specifies the index in the path, so you don't need to include it in the request body. | ||||||
|
||||||
Additionally, the following OpenSearch Document API bulk operation query parameters are supported: | ||||||
|
||||||
* `pipeline` | ||||||
* `routing` | ||||||
|
||||||
The following example demonstrates how to use the source: | ||||||
|
||||||
``` | ||||||
version: "2" | ||||||
opensearch-api-pipeline: | ||||||
source: | ||||||
opensearch_api: | ||||||
sink: | ||||||
- opensearch: | ||||||
hosts: ["https://opensearch:9200"] | ||||||
insecure: true | ||||||
username: "admin" | ||||||
password: "admin" | ||||||
index: "${getMetadata(\"opensearch_index\")}" | ||||||
action: "${getMetadata(\"opensearch_action\")}" | ||||||
document_id: "${getMetadata(\"opensearch_id\")}" | ||||||
routing: "${getMetadata(\"opensearch_routing\")}" | ||||||
pipeline: "${getMetadata(\"opensearch_pipeline\")}" | ||||||
``` | ||||||
|
||||||
Consider the following example request: | ||||||
|
||||||
``` | ||||||
POST _bulk | ||||||
{ "index": { "_index": "movies", "_id": "tt1979320" } } | ||||||
{ "title": "Rush", "year": 2013 } | ||||||
``` | ||||||
|
||||||
This request will be ingested into OpenSearch, and a new document will be created under the index `movies` with the document ID `tt1979320` with a document source of `{ "title": "Rush", "year": 2013 }`. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
natebower marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
The Data Prepper maintainers are interested in further expanding this source to support other indexing APIs, allowing it to stand in for an OpenSearch cluster in ingestion workloads. | ||||||
To learn more or provide feedback, see [Provide an OpenSearch API source #4180](https://github.com/opensearch-project/data-prepper/issues/4180). | ||||||
|
||||||
|
||||||
## Kinesis source | ||||||
|
||||||
[Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/introduction.html) is a high-speed streaming data service. | ||||||
Data Prepper has also introduced a new source named `kinesis` that can be used to ingest stream record data from multiple Kinesis data streams into OpenSearch clusters. | ||||||
You can configure it to read stream records from either the oldest untrimmed record or from the most recent record. | ||||||
Moreover, if you enable end-to-end acknowledgements, Kinesis data streams will be checkpointed to prevent duplicate processing of records. | ||||||
|
||||||
The following is an example pipeline: | ||||||
|
||||||
``` | ||||||
version: "2" | ||||||
kinesis-pipeline: | ||||||
source: | ||||||
kinesis: | ||||||
codec: | ||||||
newline: | ||||||
streams: | ||||||
- stream_name: "MyStream1" | ||||||
initial_position: LATEST | ||||||
checkpoint_interval: "PT5M" | ||||||
- stream_name: "MyStream2" | ||||||
# Enable this if ingestion should start from the start of the stream. | ||||||
initial_position: EARLIEST | ||||||
consumer_strategy: "polling" | ||||||
polling: | ||||||
max_polling_records: 100 | ||||||
idle_time_between_reads: "250ms" | ||||||
``` | ||||||
|
||||||
|
||||||
|
||||||
## Other features and improvements | ||||||
|
||||||
Data Prepper 2.10 has introduced a number of other improvements: | ||||||
|
||||||
* The `kafka` source now supports authentication with an Apache Kafka cluster using SASL/SCRAM in addition to the SASL/PLAIN authentication provided in previous versions. | ||||||
* Data Prepper can now parse OpenTelemetry logs from sources such as Amazon Simple Storage Service (Amazon S3). The new `otel_logs` codec parses data from OpenTelemetry Protocol (OTLP) JSON-formatted files. Now you can write OpenTelemetry logs from [AWS S3 Exporter for OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/awss3exporter/README.md) and read these using Data Prepper. | ||||||
* Additionally, the maintainers have worked to improve performance through the addition of an internal cache for event keys. Data Prepper administrators can configure this cache as necessary. | ||||||
|
||||||
natebower marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
## Next steps | ||||||
|
||||||
* To download Data Prepper, visit the [OpenSearch downloads](https://opensearch.org/downloads.html) page. | ||||||
* For instructions on how to get started with Data Prepper, see [Getting started with Data Prepper](https://opensearch.org/docs/latest/data-prepper/getting-started/). | ||||||
* To learn more about the work in progress for Data Prepper 2.11 and other releases, see the [Data Prepper Project Roadmap](https://github.com/orgs/opensearch-project/projects/221). | ||||||
|
||||||
## Thanks to our contributors! | ||||||
|
||||||
The following community members contributed to this release. Thank you! | ||||||
|
||||||
TODO |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.