// kafka-connector options: START
[[camel-metrics-kafka-connector-sink]]
= camel-metrics-kafka-connector sink configuration

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

[source,xml]
----
<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

[source,java]
----
connector.class=org.apache.camel.kafkaconnector.metrics.CamelMetricsSinkConnector
----


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



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.metricsType* | Type of metrics One of: [gauge] [counter] [histogram] [meter] [timer] | null | HIGH
| *camel.sink.path.metricsName* | Name of metrics | null | HIGH
| *camel.sink.endpoint.action* | Action when using timer type One of: [start] [stop] | null | MEDIUM
| *camel.sink.endpoint.decrement* | Decrement value when using counter type | null | MEDIUM
| *camel.sink.endpoint.increment* | Increment value when using counter type | null | 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 | null | MEDIUM
| *camel.sink.endpoint.subject* | Subject value when using gauge type | null | MEDIUM
| *camel.sink.endpoint.value* | Value value when using histogram type | null | MEDIUM
| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | 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.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.metrics.metricRegistry* | To use a custom configured MetricRegistry. | null | MEDIUM
|===
// kafka-connector options: END
