| // kafka-connector options: START |
| [[camel-microprofile-metrics-kafka-connector-sink]] |
| = camel-microprofile-metrics-kafka-connector sink configuration |
| |
| Connector Description: Expose metrics from Camel routes. |
| |
| When using camel-microprofile-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-microprofile-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.microprofilemetrics.CamelMicroprofilemetricsSinkConnector |
| ---- |
| |
| |
| The camel-microprofile-metrics sink connector supports 17 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,1,1",options="header"] |
| |=== |
| | Name | Description | Default | Required | Priority |
| | *camel.sink.path.metricType* | Metric type One of: [concurrent gauge] [counter] [gauge] [meter] [histogram] [timer] [simple timer] [invalid] | null | true | HIGH |
| | *camel.sink.path.metricName* | Metric name | null | true | HIGH |
| | *camel.sink.endpoint.action* | Action to use when using the timer type | null | false | MEDIUM |
| | *camel.sink.endpoint.counterIncrement* | Increment value when using the counter type | null | false | MEDIUM |
| | *camel.sink.endpoint.description* | Metric description | null | false | MEDIUM |
| | *camel.sink.endpoint.displayName* | Metric display name | null | false | MEDIUM |
| | *camel.sink.endpoint.gaugeDecrement* | Decrement metric value when using concurrent gauge type | null | false | MEDIUM |
| | *camel.sink.endpoint.gaugeIncrement* | Increment metric value when using the concurrent gauge type | null | false | MEDIUM |
| | *camel.sink.endpoint.gaugeValue* | Decrement metric value when using concurrent gauge type | null | false | 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 | false | MEDIUM |
| | *camel.sink.endpoint.mark* | Mark value to set when using the meter type | null | false | MEDIUM |
| | *camel.sink.endpoint.metricUnit* | Metric unit. See org.eclipse.microprofile.metrics.MetricUnits | null | false | MEDIUM |
| | *camel.sink.endpoint.tags* | Comma delimited list of tags associated with the metric in the format tagName=tagValue | null | false | MEDIUM |
| | *camel.sink.endpoint.value* | Value to set when using the histogram type | null | false | MEDIUM |
| | *camel.component.microprofile-metrics.lazyStart Producer* | 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 | false | MEDIUM |
| | *camel.component.microprofile-metrics.autowired Enabled* | 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 | false | MEDIUM |
| | *camel.component.microprofile-metrics.metric Registry* | Use a custom MetricRegistry. | null | false | MEDIUM |
| |=== |
| |
| |
| |
| The camel-microprofile-metrics sink connector has no converters out of the box. |
| |
| |
| |
| |
| |
| The camel-microprofile-metrics sink connector has no transforms out of the box. |
| |
| |
| |
| |
| |
| The camel-microprofile-metrics sink connector has no aggregation strategies out of the box. |
| |
| |
| |
| |
| // kafka-connector options: END |
