Name

Sampling — Extract a sample of the exchanges passing through a route

Usage

The Sampling pattern allows you to extract a sample of the exchanges as they pass through a route. They are configured with a sampling period during which only a single exchange is allowed to pass through. All other exchanges will be stopped.

The Sampling pattern can appear anywhere in the body of a route.

Properties

Table 101 describes the properties you can specify using the properties editor.

Table 101. Sampling Properties

NameDescription
Inherit Error HandlerSpecifies whether the node should use the error handler configured for the route. The default is Disabled.
Sample PeriodSpecifies the amount of time during which a single message can pass.
UnitsSpecifies the unit of measure for the sampling period.
Message FrequencySpecifies the number of messages that can pass during the sampling period.
IdSpecifies a unique identifier for the endpoint. The Id can be used to refer to the endpoint in the Camel XML file.
DescriptionSpecifies a text description for the node. This description is included in the generated XML file, but it is informational only. It is not used by Apache Camel.