camel-metrics-kafka-connector sink configuration

Connector Description: Collect various metrics directly from Camel routes using the DropWizard metrics library.

When using camel-metrics-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-metrics-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.metrics.CamelMetricsSinkConnector

The camel-metrics sink connector supports 12 options, which are listed below.

Name Description Default Priority

camel.sink.path.metricsType

Required Type of metrics One of: [gauge] [counter] [histogram] [meter] [timer].

Enum values:

  • gauge

  • counter

  • histogram

  • meter

  • timer

HIGH

camel.sink.path.metricsName

Required Name of metrics.

HIGH

camel.sink.endpoint.action

Action when using timer type One of: [start] [stop].

Enum values:

  • start

  • stop

MEDIUM

camel.sink.endpoint.decrement

Decrement value when using counter type.

MEDIUM

camel.sink.endpoint.increment

Increment value when using counter type.

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.mark

Mark when using meter type.

MEDIUM

camel.sink.endpoint.subject

Subject value when using gauge type.

MEDIUM

camel.sink.endpoint.value

Value value when using histogram type.

MEDIUM

camel.component.metrics.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.metrics.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

camel.component.metrics.metricRegistry

To use a custom configured MetricRegistry.

MEDIUM

The camel-metrics sink connector has no converters out of the box.

The camel-metrics sink connector has no transforms out of the box.

The camel-metrics sink connector has no aggregation strategies out of the box.

Back to top