Documented compression option for data prepper otel-logs-source sink #10196
+12
−12
Conversation
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
Signed-off-by: Zeeshan Alam <Zeeshan.Alam+fidelity@fmr.com>
alamzeeshan
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable,
epugh and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
kolchfa-aws
added
data-prepper
backport 3.1
Tech review
kolchfa-aws
reviewed
Jul 8, 2025
There was a problem hiding this comment.
Thank you, @alamzeeshan! Could you change the capitalization of the data types? It Should be "Integer" and "String" instead of "int" and "string". Thanks!
| @@ -22,13 +22,14 @@ You can configure the `otel_logs_source` source with the following options. | |||
| | :--- | :--- | :--- | | |||
| | port | int | Represents the port that the `otel_logs_source` source is running on. Default value is `21892`. | | |||
| | path | string | Represents the path for sending unframed HTTP requests. You can use this option to support an unframed gRPC request with an HTTP idiomatic path to a configurable path. The path should start with `/`, and its length should be at least 1. The `/opentelemetry.proto.collector.logs.v1.LogsService/Export` endpoint is disabled for both gRPC and HTTP requests if the path is configured. The path can contain a `${pipelineName}` placeholder, which is replaced with the pipeline name. If the value is empty and `unframed_requests` is `true`, then the source provides the path `/opentelemetry.proto.collector.logs.v1.LogsService/Export`. | | |||
| | max_request_length | No | ByteCount | The maximum number of bytes allowed in the payload of a single gRPC or HTTP request. Default value is `10mb`. | |||
| | max_request_length | No | The maximum number of bytes allowed in the payload of a single gRPC or HTTP request. Default value is `10mb`. | | |||
There was a problem hiding this comment.
Suggested change
| | max_request_length | No | The maximum number of bytes allowed in the payload of a single gRPC or HTTP request. Default value is `10mb`. | | |
| | max_request_length | String | The maximum number of bytes allowed in the payload of a single gRPC or HTTP request. Default value is `10mb`. | |
| | request_timeout | int | Represents the request timeout duration in milliseconds. Default value is `10000`. | | ||
| | health_check_service | Boolean | Enables the gRPC health check service under `grpc.health.v1/Health/Check`. Default value is `false`. | | ||
| | proto_reflection_service | Boolean | Enables a reflection service for Protobuf services (see [ProtoReflectionService](https://grpc.github.io/grpc-java/javadoc/io/grpc/protobuf/services/ProtoReflectionService.html) and [gRPC reflection](https://github.com/grpc/grpc-java/blob/master/documentation/server-reflection-tutorial.md)). Default value is `false`. | | ||
| | unframed_requests | Boolean | Enables requests that are not framed using the gRPC wire protocol. Default value is `false`. | | ||
| | thread_count | int | The number of threads to keep in the `ScheduledThreadPool`. Default value is `500`. | | ||
| | max_connection_count | int | The maximum number of open connections allowed. Default value is `500`. | | ||
| | compression | string | The compression type applied on the client request payload. Can be `none` or `gzip`. Use `gzip` to apply GZip de-compression on the incoming request. Defaults to `none` which means no compression. | |
There was a problem hiding this comment.
Suggested change
| | compression | string | The compression type applied on the client request payload. Can be `none` or `gzip`. Use `gzip` to apply GZip de-compression on the incoming request. Defaults to `none` which means no compression. | | |
| | compression | string | The compression type applied to the client request payload. Valid values are `none` or `gzip`. Use `gzip` to apply GZip decompression to the incoming request. Default is `none` (no compression). | |
kolchfa-aws
added
Doc review
Signed-off-by: Zeeshan Alam <Zeeshan.Alam+fidelity@fmr.com>
kolchfa-aws
approved these changes
Jul 9, 2025
kolchfa-aws
added
Editorial review
|
@kolchfa-aws Please resolve conflicts. |
|
@alamzeeshan @kayhern Please resolve merge conflicts so we can merge the PR |
Signed-off-by: Zeeshan Alam <zeeshan.alam@fmr.com>
Resolved. |
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jul 10, 2025
…10196) * Documented compression option for data prepper otel-logs-source sink Signed-off-by: Zeeshan Alam <Zeeshan.Alam+fidelity@fmr.com> * Made changes as per code review comments Signed-off-by: Zeeshan Alam <Zeeshan.Alam+fidelity@fmr.com> --------- Signed-off-by: Zeeshan Alam <Zeeshan.Alam+fidelity@fmr.com> Signed-off-by: Zeeshan Alam <zeeshan.alam@fmr.com> Co-authored-by: Zeeshan Alam <Zeeshan.Alam+fidelity@fmr.com> (cherry picked from commit 26bf9dc) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws
pushed a commit
that referenced
this pull request
Jul 10, 2025
…10196) (#10203) * Documented compression option for data prepper otel-logs-source sink * Made changes as per code review comments --------- (cherry picked from commit 26bf9dc) Signed-off-by: Zeeshan Alam <Zeeshan.Alam+fidelity@fmr.com> Signed-off-by: Zeeshan Alam <zeeshan.alam@fmr.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Zeeshan Alam <Zeeshan.Alam+fidelity@fmr.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
compressionoption for data prepperotel-logs-sourcesourcemax_request_lengthoptionIssues Resolved
Closes #9614
Version
all.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.