Sample

Table of Contents

Usage
Properties

Extract a sample of the exchanges passing through a route

Usage

The Sample 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 Sample pattern can appear anywhere in the body of a route.

Properties

Table 145, “Sample Properties” describes the properties you can specify using the properties editor.

Table 145. Sample Properties

NameDescription

Description

Specifies 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.

Id

Specifies a unique identifier for the endpoint.

The tooling automatically generates an id for a node when it is created, but you can remove that id or replace it with your own. The Camel debugger requires all nodes with a breakpoint set to have a unique id.

You can use the id to refer to endpoints in your Camel XML file.

Message Frequency

Specifies the number of messages that can pass during the sampling period.

Sample Period

Specifies the amount of time during which a single message can pass.

Units

Specifies the unit of measure for the sampling period.