-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[DOCS-12318] Add data streams option #33555
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
Open
maycmlee
wants to merge
1
commit into
master
Choose a base branch
from
may/opensearch-data-stream
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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 hidden or 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
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -16,7 +16,20 @@ Set up the OpenSearch destination and its environment variables when you [set up | |
|
|
||
| ### Set up the destination | ||
|
|
||
| 1. Optionally, enter the name of the OpenSearch index. See [template syntax][3] if you want to route logs to different indexes based on specific fields in your logs. | ||
| 1. In the **Mode** dropdown menu, select **Bulk** or **Data streams**. | ||
| - **Bulk** mode | ||
| - Uses OpenSearch's [Bulk API][4] to send batched events directly into a standard index. | ||
| - Choose this mode when you want direct control over index naming and lifecycle management. Data is appended to the index you specify, and you are responsible for handling rollovers, deletions, and mappings. | ||
| - To configure **Bulk** mode: | ||
| - In the **Index** field, optionally enter the name of the OpenSearch index. You can use [template syntax][3] to dynamically route logs to different indexes based on specific fields in your logs, for example `logs-{{service}}`. | ||
| - **Data streams** mode | ||
| - Uses [OpenSearch Data Streams][5] for log storage. Data streams automatically manage backing indexes and rollovers, making them ideal for timeseries log data. | ||
| - Choose this mode when you want OpenSearch to manage the index lifecycle for you. Data streams ensures smooth rollovers, Index Lifecycle Management (ILM) compatibility, and optimized handling of time-based data. | ||
| - To configure **Data streams** mode, optionally define the data stream name (default is `logs-generic-default`) by entering the following information: | ||
| - In the **Type** field, enter the category of data being ingested, for example `logs`. | ||
| - In the **Dataset** field, specify the format or data source that describes the structure, for example `apache`. | ||
| - In the **Namespace** field, enter the grouping for organizing your data streams, for example `production`. | ||
| - In the UI, there is a preview of the data stream name you configured. With the above example inputs, the data stream name that the Worker writes to is `logs-apache-production`. | ||
| 1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access. | ||
| - If left disabled, the maximum size for buffering is 500 events. | ||
| - If enabled: | ||
|
|
@@ -39,4 +52,6 @@ A batch of events is flushed when one of these parameters is met. See [event bat | |
|
|
||
| [1]: https://app.datadoghq.com/observability-pipelines | ||
| [2]: /observability_pipelines/destinations/#event-batching | ||
| [3]: /observability_pipelines/destinations/#template-syntax | ||
| [3]: /observability_pipelines/destinations/#template-syntax | ||
| [4]: https://docs.opensearch.org/latest/api-reference/document-apis/bulk/ | ||
|
Contributor
Author
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. @mikhacim can you also confirm that this is the correct link for OpenSearch bulk API? |
||
| [5]: https://docs.opensearch.org/latest/im-plugin/data-streams/ | ||
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.
@mikhacim can you confirm that this is the correct link for Amazon OpenSearch bulk API?