Skip to content

path option in otel and http sources is not documented #4732

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
rdicroce opened this issue Jul 12, 2024 · 5 comments · Fixed by opensearch-project/documentation-website#9593
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@rdicroce
Copy link

The path option was added long ago to the http and otel sources (#2277 and #2297), but it is not documented on the OpenSearch website. See e.g. https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/sources/http/. This option should be documented so people know it exists. The only reason I found it was because I stumbled into #3670 while trying to figure out how to get the OTel collector's otlphttp exporter to work.

@dlvenable dlvenable added documentation Improvements or additions to documentation and removed untriaged labels Jul 16, 2024
@dlvenable
Copy link
Member

@rdicroce , Thank you for catching this! Would you be interested in contributing the change to the documentation-website project with the documentation?

https://github.com/opensearch-project/documentation-website/tree/main/_data-prepper

@dlvenable dlvenable added the good first issue Good for newcomers label Jul 16, 2024
@rdicroce
Copy link
Author

I can do that but I don't know what the default values are. That was my original problem that led me to discover the path option.

@alamzeeshan
Copy link

@dlvenable I can update the documentation-website. Can you please assign this issue to me. I will open a PR shortly.

@dlvenable
Copy link
Member

Thank you @alamzeeshan !

@alamzeeshan
Copy link

Hi @dlvenable , This issue can be closed as the docs were updated as part of opensearch-project/documentation-website#9593

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
3 participants