Skip to content
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

[DOC] Data Prepper OpenSearch sink document_id_field deprecation in favor of new document_id parameter #4771

Open
1 of 4 tasks
graytaylor0 opened this issue Aug 14, 2023 · 4 comments
Assignees
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started data-prepper

Comments

@graytaylor0
Copy link
Member

graytaylor0 commented Aug 14, 2023

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

The Data Prepper OpenSearch sink document_id_field has been deprecated in favor of document_id, which supports formatting the document_id with one or more Event keys or Data Prepper expressions

Issue: opensearch-project/data-prepper#3074

Pull Request deprecating document_id_field and adding document_id: opensearch-project/data-prepper#3153

@hdhalter
Copy link
Contributor

Looks like this is still an issue. @graytaylor0 - Is the only doc update needed to the document_id_field in this table? https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/sinks/opensearch/#configuration-options. Thanks!

@hdhalter
Copy link
Contributor

@dlvenable - Hi David, is the only update required to update the field name in this table? https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/sinks/opensearch/#configuration-options. Thanks!

@dlvenable
Copy link
Member

@hdhalter , We have two changes.

  1. Add a new document_id property to the table you linked to above. It can also reference the Expression syntax page because it uses expressions.
  2. Add a note to the existing document_id_field that it is deprecated in favor of document_id.

@hdhalter
Copy link
Contributor

hdhalter commented Jan 2, 2024

@hdhalter , We have two changes.

1. Add a new `document_id` property to the table you linked to above. It can also reference the [Expression syntax page](https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/) because it uses expressions.

2. Add a note to the existing `document_id_field` that it is deprecated in favor of `document_id`.

Thanks! In what version was the field deprecated?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started data-prepper
Projects
None yet
Development

No branches or pull requests

4 participants