path option in otel and http sources is not documented

opensearch-project / data-prepper

Data Prepper is a component of the OpenSearch project that accepts, filters, transforms, enriches, and routes data at scale.

https://opensearch.org/docs/latest/clients/data-prepper/index/

Apache License 2.0

251 stars 184 forks source link

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

Open rdicroce opened 1 month ago

rdicroce commented 1 month ago

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 commented 1 month ago

@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

rdicroce commented 1 month ago

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.