[ESM] Add table for feature-specific coverage #1594
Conversation
|
🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-1594.surge.sh 🎊 |
gregfurman
force-pushed
the
add/esm/coverage-table
branch
from
866b40b to
77f24c9
Compare
gregfurman
requested review from
joe4dev,
dominikschubert and
dfangl
as code owners
| - `TumblingWindowInSeconds`. | ||
| - [Self-Managed Apache Kafka](https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html) | ||
|
|
||
| ### Coverage |
There was a problem hiding this comment.
From @joe4dev:
@HarshCasper How do we best present such a feature model to the user?
We are trying to improve the transparency regarding the supported behavioral features of Lambda Event Source Mapping beyond the simple list of supported sources we currently have in the Lambda docs here. Should we just add the table below to the Lambda docs (similar than the API coverage docs, but for behavior)
There was a problem hiding this comment.
Amazing work @gregfurman bringing clarity into the ESM djungle 💯
Looking forward to further feedback from @HarshCasper et. al to refine and potentially generalize to other services and areas.
Hint: It's better to link the preview rather than hardcoding a potentially outdated table into the PR description https://localstack-docs-preview-pr-1594.surge.sh/user-guide/aws/lambda/#lambda-event-source-mappings
| @@ -165,20 +165,51 @@ The product of 10 and 10 is 100% | |||
| [Lambda event source mappings](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html) allows you to connect Lambda functions to other AWS services. | |||
| The following event sources are supported in LocalStack: | |||
|
|
|||
| - [Simple Queue Service (SQS)](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html) | |||
| - [DynamoDB](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html) | |||
| - [Kinesis](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html) | |||
| - [Managed Streaming for Apache Kafka (MSK)](https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) | |||
There was a problem hiding this comment.
Do you think we should add Self-Managed Kafka and the Pro image star ⭐ or is the table sufficient? It might be easier to see a quick list at first glance at the cost of some redundancy 🤷♂️
|
|
||
| ### Coverage | ||
|
|
||
| The coverage table below shows feature-level coverage for all supported event sources for the latest version of LocalStack. |
There was a problem hiding this comment.
Helpful clarification 👍
Can we add a link to the API coverage and a sentence clarifying the difference between API coverage and behavior/feature coverage?
There was a problem hiding this comment.
Added a sentance for this!
| |--------------------------------|-------------------------------------------------|:--------:|:----:|:---------:|:----------:|:----------:|:------------:| | ||
| | **Parameter** | **Description** | **Standard** | **FIFO** | **Kinesis** | **DynamoDB** | **Amazon MSK** | **Self-Managed** | | ||
| | BatchSize | Batching events by count. | 🟡 [^1] | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | | ||
| | ➖ | Batch when ≥ 6 MB limit. | 🟠 | 🟠 | 🟠 | 🟠 | 🟢 | 🟢 | |
There was a problem hiding this comment.
Replaced with *Not Configurable*
| | MaximumRetryAttempts | Discard after N retries. | ➖ | ➖ | 🟢 | 🟢 | ➖ | ➖ | | ||
| | MaximumRecordAgeInSeconds | Discard records older than time `t`. | ➖ | ➖ | 🟢 | 🟢 | ➖ | ➖ | | ||
| | Enabled | Enabling/Disabling. | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | | ||
| | FilterCriteria | Filter criteria object. | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | |
There was a problem hiding this comment.
Would it make sense to distinguish between Filter engine, filter validations, and event parity (as discussed in Notion)? The current description "Filter criteria object." sounds quite API like
There was a problem hiding this comment.
For posterity: we added a footnote showing certain Metadata fields are unsupported as well as a link to the filter criteria docs on AWS.
| | ParallelizationFactor | Parallel batch processing by shard. | ➖ | ➖ | 🟠 | 🟠 | ➖ | ➖ | | ||
| | DestinationConfig.OnFailure | SQS Failure Destination. | ➖ | ➖ | 🟢 | 🟢 | 🟢 | 🟢 | | ||
| | | SNS Failure Destination. | ➖ | ➖ | 🟢 | 🟢 | 🟢 | 🟢 | | ||
| | | S3 Failure Destination. | ➖ | ➖ | 🟠 | 🟠 | 🟠 | 🟠 | |
Changes
Adds a new coverage table for the Lambda event-source mapping section of the docs.
The new table will (approximately) look like:
Legend