Throttle Action

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

The Throttle action allows you to ensure that a specific sink does not get overloaded.

Configuration Options

The following table summarizes the configuration options available for the throttle-action Kamelet:

Property	Name	Description	Type	Default	Example
messages	Messages Number	Required The number of messages to send in the time period set.	integer		10
timePeriod	Time Period	Sets the time period during which the maximum request count is valid for, in milliseconds.	string	1000

Property

Name

Description

Type

Default

Example

messages

Messages Number

Required The number of messages to send in the time period set.

integer

timePeriod

Time Period

Sets the time period during which the maximum request count is valid for, in milliseconds.

string

1000

Dependencies

At runtime, the throttle-action Kamelet relies upon the presence of the following dependencies:

camel:core
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:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the throttle-action.

Knative action

You can use the throttle-action Kamelet as an intermediate step in a Knative binding.

throttle-action-binding.yaml

apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
  name: throttle-action-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: kafka-source
      properties:
        bootstrapServers: localhost:9092
        topic: mytopic
        user: kafka
        password: kafka123!
  steps:
    - ref:
        kind: Kamelet
        apiVersion: camel.apache.org/v1
        name: throttle-action
      properties:
        messages: "10"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

Save the throttle-action-binding.yaml file to your local drive, and then edit it as needed for your configuration.
Run the action by using the following command:
```
kubectl apply -f throttle-action-binding.yaml
```

Procedure for using the Kamel CLI

Configure and run the action by using the following command:

kamel bind channel:mychannel -p "step-0.messages=10" throttle-action

This command creates the KameletBinding in the current namespace on the cluster.

Kafka action

You can use the throttle-action Kamelet as an intermediate step in a Kafka binding.