add(kinesis): Include new Scala engine and performance section #1786
Conversation
|
🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-1786.surge.sh 🎊 |
| @@ -173,11 +173,27 @@ You can fetch the CloudWatch logs for your Lambda function reading records from | |||
|
|
|||
| | Variable | Description | | |||
| | -------- | ----------- | | |||
| | `KINESIS_MOCK_PROVIDER_ENGINE` | String value of `node` (default) or `scala` that determines the underlying build of Kinesis Mock. [^scala-future] | | |||
There was a problem hiding this comment.
suggestion: Can we add the configuration to the global LocalStack configuration page: https://docs.localstack.cloud/references/configuration/#kinesis
| @@ -173,11 +173,27 @@ You can fetch the CloudWatch logs for your Lambda function reading records from | |||
|
|
|||
| | Variable | Description | | |||
| | -------- | ----------- | | |||
| | `KINESIS_MOCK_PROVIDER_ENGINE` | String value of `node` (default) or `scala` that determines the underlying build of Kinesis Mock. [^scala-future] | | |||
| | `KINESIS_MOCK_MAXIMUM_HEAP_SIZE` | JVM memory format string (default: `512m`) that sets the maximum memory size for the Kinesis Mock Scala server, corresponds to the JVM `-Xmx` flag. [^scala] | | |||
There was a problem hiding this comment.
praise: great clarity explaining what happens under the hood 👍
There was a problem hiding this comment.
FYI – I have removed this section and added a redirect to the config docs. Right now, all config vars for individual services are documented there but this can change in future.
| - Reduce `KINESIS_LATENCY` artificial response delays from the default `500` milliseconds (or disable entirely with `0`). | ||
|
|
||
| [^scala]: This feature is only available in the more performant Scala Kinesis Mock build that can be toggled by setting `KINESIS_MOCK_PROVIDER_ENGINE=scala`. | ||
| [^scala-future]: Future versions of LocalStack will likely default to using the `scala` engine over the less-performant `node` version currently in use. |
There was a problem hiding this comment.
question: Are we aware of any limitations worth mentioning? If not, it might be worth mentioning that we are unaware of any limitations and encourage users to raise a GH issue if they encounter any challenges.
There was a problem hiding this comment.
Other than the potential for higher memory overhead (since we pre-allocate 256m by default to the JVM) I'm not sure I can think of any
There was a problem hiding this comment.
Ok, then let's be transparent and add that explicitly 👍
Motivation
Document the newly introduced Kinesis Mock Scala engine in addition to a small section on performance tuning of the Kinesis service.
Changes