You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains 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
Add a performance impact warning for the Sleep processor
Consider adding a warning or note about the potential impact of using the Sleep processor on system performance, especially in production environments. This can help users make informed decisions about when and how to use this processor.
-Sleep for a period of time specified as a duration string for each message. This processor will interpolate functions within the [duration](#duration) field, you can find a list of functions [here]({{< ref "/product-stack/tyk-streaming/configuration/common-configuration/interpolation#bloblang-queries" >}}).+Sleep for a period of time specified as a duration string for each message. Note: Using the Sleep processor, especially with long durations, can significantly impact system performance. Use cautiously, particularly in production environments. This processor will interpolate functions within the [duration](#duration) field, you can find a list of functions [here]({{< ref "/product-stack/tyk-streaming/configuration/common-configuration/interpolation#bloblang-queries" >}}).
Suggestion importance[1-10]: 9
Why: Adding a warning about the potential impact on system performance is important for users to make informed decisions, especially in production environments, making this a valuable addition.
9
Clarity
Clarify the units used in the duration field description
To improve clarity, consider rephrasing the description of the duration field to specify what units can be used (e.g., seconds, minutes). This will help users understand how to configure the duration properly without needing to refer to external documentation.
-The duration of time to sleep for each execution.+The duration of time to sleep for each execution, specified in units like seconds (s) or minutes (m).
Suggestion importance[1-10]: 8
Why: Specifying the units for the duration field improves clarity and helps users configure the field correctly without needing to refer to external documentation.
8
Explicitly mention the use of interpolation functions in the duration field to clear up potential ambiguities
To avoid potential confusion, explicitly mention that the interpolation functions are used within the duration field in the main description paragraph. This makes it clear where these functions apply without having to infer from context.
-Sleep for a period of time specified as a duration string for each message. This processor will interpolate functions within the [duration](#duration) field, you can find a list of functions [here]({{< ref "/product-stack/tyk-streaming/configuration/common-configuration/interpolation#bloblang-queries" >}}).+Sleep for a period of time specified as a duration string for each message. Specifically, this processor will interpolate functions within the `duration` field, allowing dynamic sleep times. See a list of applicable functions [here]({{< ref "/product-stack/tyk-streaming/configuration/common-configuration/interpolation#bloblang-queries" >}}).
Suggestion importance[1-10]: 6
Why: While the existing description already mentions interpolation functions, making it more explicit can help avoid confusion, though it is a minor improvement.
6
Enhancement
Add a default value for the duration field to improve initial user configuration
It's recommended to provide a default value for the duration field in the Sleep processor configuration to enhance user experience and provide a clearer starting point for configuration. If a sensible default isn't feasible, consider adding a recommended value in the documentation.
-duration: "" # No default (required)+duration: "30s" # Default value (modifiable)
Suggestion importance[1-10]: 7
Why: Providing a default value for the duration field can enhance user experience by giving them a starting point, but it may not be crucial if the field is required and users are expected to provide their own values.
#5014)
* [DX-1407] Tyk Streams: Sleep Processor (#5008)
* add sleep processor
* add link to duration field
---------
Co-authored-by: Simon Pears <simon@tyk.io>
(cherry picked from commit bee4ca3)
* delete release notes 5.4 it should not be in PR
---------
Co-authored-by: dcs3spp <dcs3spp@users.noreply.github.com>
Co-authored-by: Simon Pears <simon@tyk.io>
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.
User description
For internal users - Please add a Jira DX PR ticket to the subject!
DX-1407
Preview Link
preview
Description
Add sleep processor
Screenshots (if appropriate)
Checklist
master.PR Type
Documentation
Description
Changes walkthrough 📝
version-5.4.md
Update deprecation section in release notestyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.4.md
release.
sleep.md
Add documentation for Sleep processortyk-docs/content/product-stack/tyk-streaming/configuration/processors/sleep.md
menu.yaml
Add Sleep processor to menutyk-docs/data/menu.yaml