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.

Sign up for GitHub

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

Jump to bottom

SelfManagedKafkaEventSourceProps: default maxBatchingWindow incorrect #21974

Closed
yualexan opened this issue Sep 8, 2022 · 1 comment · Fixed by #21981
Closed

SelfManagedKafkaEventSourceProps: default maxBatchingWindow incorrect #21974

yualexan opened this issue Sep 8, 2022 · 1 comment · Fixed by #21981
Labels
@aws-cdk/aws-lambda-event-sources documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2

Comments

@yualexan
Copy link

yualexan commented Sep 8, 2022

Describe the issue

The given default value for maxBatchingWindow for the SelfManagedKafkaEventSourceProps resource is incorrect. It incorrectly states that the default is 0 seconds, when according to the Lambda documentation, it should be 500 ms:

For Amazon MSK, self-managed Apache Kafka, and Amazon MQ event sources: The default batching window is 500 ms.

According to a CDK doc writer, it appears that SelfManagedKafkaEventSource inherits that default from a base class, StreamEventSource, which is why the default is set to 0 seconds. While it's true that for some Lambda event sources (SQS, Kinesis, DDB streams) the default batching window is 0 seconds, for others (MSK, Kafka, MQ) it's 500 ms. In this case, SelfManagedKafkaEventSource should not be inheriting from the same class as the SQS, Kinesis, and DDB streams event sources.

Please correct this in the CDK documentation!

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda_event_sources.SelfManagedKafkaEventSourceProps.html#maxbatchingwindow
@yualexan yualexan added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Sep 8, 2022
@kaizencc kaizencc mentioned this issue Sep 9, 2022
Merged
4 tasks
@kaizencc kaizencc added p2 effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels Sep 9, 2022
@kaizencc kaizencc removed their assignment Sep 9, 2022
@mergify mergify bot closed this as completed in #21981 Sep 9, 2022
mergify bot pushed a commit that referenced this issue Sep 9, 2022
@kaizencc
docs(lambda-event-sources): document different defaults for maxBatchi…
38f8d89 
…ngWindow (#21981)

Fixes #21974


----

### All Submissions:

* [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

github-actions bot commented Sep 9, 2022

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Kruspe pushed a commit to DavidSchwarz2/aws-cdk that referenced this issue Sep 13, 2022
@kaizencc @Kruspe
docs(lambda-event-sources): document different defaults for maxBatchi…
fd7e411 
…ngWindow (aws#21981)

Fixes aws#21974


----

### All Submissions:

* [ ] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md)

### Adding new Unconventional Dependencies:

* [ ] This PR adds new unconventional dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-new-unconventional-dependencies)

### New Features

* [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)?
	* [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)?

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-lambda-event-sources documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(lambda-event-sources): document different defaults for maxBatchingWindow aws/aws-cdk
2 participants
@kaizencc @yualexan