Throttle Action
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Lets through at most a set number of messages per period of time, such as 10 per second, and holds back the rest for a later period.
Use it to protect a sink or a service that cannot take more than a certain rate, for example an API that allows 100 calls per minute. To hold every message for a fixed time instead, use delay-action.
Input: any message.
Output: the same message, unchanged. The messages over the limit are not dropped: they wait, and are passed on in a later period.
Configuration Options
The following table summarizes the configuration options available for the throttle-action Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
Message Limit | Required How many messages may pass in each | integer | 10 | ||
Time Period | The length of the period that | string | 1000 | 60000 |
Dependencies
At runtime, the throttle-action Kamelet relies upon the presence of the following dependencies:
-
camel:kamelet
Camel JBang usage
Prerequisites
-
You’ve installed JBang.
-
You have executed the following command:
jbang app install camel@apache/camel Supposing you have a file named route.yaml with this content:
- route:
from:
uri: "kamelet:timer-source"
parameters:
period: 10000
message: 'test'
steps:
- to:
uri: "kamelet:throttle-action"
parameters:
.
.
.
- to:
uri: "kamelet:log-sink" You can now run it directly through the following command
camel run route.yaml