Skip to content

Conversation

taisho6339
Copy link
Contributor

@taisho6339 taisho6339 commented Aug 17, 2025

Summary

While vector supports OpenSearch in code, it isn't described enough. Also, there are no tests and documentation. With this PR, I added unit tests and the explanation in the doc.
As a follow-up PR, an integration test for OpenSearch should be added.

Issue: #16761

Vector configuration

How did you test this PR?

  • make test
  • make test-docs

Change Type

  • Bug fix
  • New feature
  • Non-functional (chore, refactoring, docs)
  • Performance

Is this a breaking change?

  • Yes
  • No

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the no-changelog label to this PR.

References

Notes

  • Please read our Vector contributor resources.
  • Do not hesitate to use @vectordotdev/vector to reach out to us regarding this PR.
  • Some CI checks run only after we manually approve them.
    • We recommend adding a pre-push hook, please see this template.
    • Alternatively, we recommend running the following locally before pushing to the remote branch:
      • cargo fmt --all
      • cargo clippy --workspace --all-targets -- -D warnings
      • cargo nextest run --workspace (alternatively, you can run cargo test --all)
  • After a review is requested, please avoid force pushes to help us review incrementally.
    • Feel free to push as many commits as you want. They will be squashed into one before merging.
    • For example, you can run git merge origin master and git push.
  • If this PR introduces changes Vector dependencies (modifies Cargo.lock), please
    run cargo vdev build licenses to regenerate the license inventory and commit the changes (if any). More details here.

@github-actions github-actions bot added domain: sinks Anything related to the Vector's sinks domain: ci Anything related to Vector's CI environment domain: external docs Anything related to Vector's external, public documentation labels Aug 17, 2025
@taisho6339 taisho6339 changed the title chore(sink): Add documentation and tests about OpenSearch chore(elasticsearch sink): Add documentation and tests about OpenSearch Aug 17, 2025
@taisho6339 taisho6339 force-pushed the taisho6339/opensearch-support branch from 512ac9c to fd5ab1e Compare August 20, 2025 23:39
@taisho6339 taisho6339 force-pushed the taisho6339/opensearch-support branch from fd5ab1e to c20107d Compare August 21, 2025 06:28
@github-actions github-actions bot removed the domain: ci Anything related to Vector's CI environment label Aug 21, 2025
@taisho6339 taisho6339 marked this pull request as ready for review August 21, 2025 08:40
@taisho6339 taisho6339 requested review from a team as code owners August 21, 2025 08:40
@drichards-87 drichards-87 self-assigned this Aug 21, 2025
Copy link
Contributor

@drichards-87 drichards-87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for submitting the PR. It looks good from a Docs perspective. I'll leave the technical review to the Vector team.

@drichards-87 drichards-87 removed their assignment Aug 21, 2025
Copy link
Member

@pront pront left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Aug 21, 2025
@pront pront enabled auto-merge August 21, 2025 19:34
* Remove trailing spaces
auto-merge was automatically disabled August 21, 2025 22:08

Head branch was pushed to by a user without write access

@taisho6339
Copy link
Contributor Author

@drichards-87 @pront Thanks for your review! Apologies for missing cargo vdev fmt. Could you approve the workflows and do quick check again?

@pront pront enabled auto-merge August 22, 2025 14:10
@pront pront added this pull request to the merge queue Aug 22, 2025
Merged via the queue into vectordotdev:master with commit b884ee7 Aug 22, 2025
54 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain: external docs Anything related to Vector's external, public documentation domain: sinks Anything related to the Vector's sinks no-changelog Changes in this PR do not need user-facing explanations in the release changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants