Micrometer

Collect various metrics directly from Camel routes using the Micrometer library.

What’s inside

Micrometer component, URI syntax: micrometer:metricsType:metricsName

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-micrometer-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 17 options, which are listed below.

Name Description Default Type

Name	Description	Default	Type
camel.component.micrometer.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	Boolean
camel.component.micrometer.enabled	Whether to enable auto configuration of the micrometer component. This is enabled by default.		Boolean
camel.component.micrometer.lazy-start-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	Boolean
camel.component.micrometer.metrics-registry	To use a custom configured MetricRegistry. The option is a io.micrometer.core.instrument.MeterRegistry type.		MeterRegistry
camel.metrics.base-endpoint-uri-exchange-event-notifier	Whether to use static or dynamic values for Endpoint Name tags in captured metrics. By default, static values are used. When using dynamic tags, then a dynamic to (toD) can compute many different endpoint URIs that, can lead to many tags as the URI is dynamic, so use this with care if setting this option to false.	true	Boolean
camel.metrics.enable-exchange-event-notifier	Set whether to enable the MicrometerExchangeEventNotifier for capturing metrics on exchange processing times.	true	Boolean
camel.metrics.enable-instrumented-thread-pool-factory	Set whether to gather performance information about Camel Thread Pools by injecting an InstrumentedThreadPoolFactory.	false	Boolean
camel.metrics.enable-message-history	Set whether to enable the MicrometerMessageHistoryFactory for capturing metrics on individual route node processing times. Depending on the number of configured route nodes, there is the potential to create a large volume of metrics. Therefore, this option is disabled by default.	false	Boolean
camel.metrics.enable-route-event-notifier	Set whether to enable the MicrometerRouteEventNotifier for capturing metrics on the total number of routes and total number of routes running.	true	Boolean
camel.metrics.enable-route-policy	Set whether to enable the MicrometerRoutePolicyFactory for capturing metrics on route processing times.	true	Boolean
camel.metrics.log-metrics-on-shutdown	Log metrics when application is shutting down. (default, `false`).	false	Boolean
camel.metrics.log-metrics-on-shutdown-filters	List of metrics (comma separated) to log when application is shutting down. You can use character to log any metrics containing the wildcard, for example `camel.exchanges.` (default to all metrics available).		String
camel.metrics.naming-strategy	Controls the name style to use for metrics. Default = uses micrometer naming convention. Legacy = uses the classic naming style (camelCase)	default	String
camel.metrics.route-policy-exclude-pattern	Pattern to exclude routes (by id) to capture. Multiple route ids can be separated by comma.		String
camel.metrics.route-policy-level	Sets the level of information to capture. Possible values are all,route,context. all = both context and routes. route = routes only. context = camel context only.	all	String
camel.metrics.uri-tag-dynamic	Whether to use static or dynamic values for HTTP uri tags in captured metrics. When using dynamic tags, then a REST service with base URL: /users/{id} will capture metrics with uri tag with the actual dynamic value such as: /users/123. However, this can lead to many tags as the URI is dynamic, so use this with care.	false	Boolean
camel.metrics.uri-tag-enabled	Whether HTTP uri tags should be enabled or not in captured metrics. If disabled then the uri tag, is likely not able to be resolved and will be marked as UNKNOWN.	true	Boolean

camel.component.micrometer.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

Boolean

camel.component.micrometer.enabled

Whether to enable auto configuration of the micrometer component. This is enabled by default.

Boolean

camel.component.micrometer.lazy-start-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

Boolean

camel.component.micrometer.metrics-registry

To use a custom configured MetricRegistry. The option is a io.micrometer.core.instrument.MeterRegistry type.

MeterRegistry

camel.metrics.base-endpoint-uri-exchange-event-notifier

Whether to use static or dynamic values for Endpoint Name tags in captured metrics. By default, static values are used. When using dynamic tags, then a dynamic to (toD) can compute many different endpoint URIs that, can lead to many tags as the URI is dynamic, so use this with care if setting this option to false.

true

Boolean

camel.metrics.enable-exchange-event-notifier

Set whether to enable the MicrometerExchangeEventNotifier for capturing metrics on exchange processing times.

true

Boolean

camel.metrics.enable-instrumented-thread-pool-factory

Set whether to gather performance information about Camel Thread Pools by injecting an InstrumentedThreadPoolFactory.

false

Boolean

camel.metrics.enable-message-history

Set whether to enable the MicrometerMessageHistoryFactory for capturing metrics on individual route node processing times. Depending on the number of configured route nodes, there is the potential to create a large volume of metrics. Therefore, this option is disabled by default.

false

Boolean

camel.metrics.enable-route-event-notifier

Set whether to enable the MicrometerRouteEventNotifier for capturing metrics on the total number of routes and total number of routes running.

true

Boolean

camel.metrics.enable-route-policy

Set whether to enable the MicrometerRoutePolicyFactory for capturing metrics on route processing times.

true

Boolean

camel.metrics.log-metrics-on-shutdown

Log metrics when application is shutting down. (default, false).

false

Boolean

camel.metrics.log-metrics-on-shutdown-filters

List of metrics (comma separated) to log when application is shutting down. You can use character to log any metrics containing the wildcard, for example camel.exchanges. (default to all metrics available).

String

camel.metrics.naming-strategy

Controls the name style to use for metrics. Default = uses micrometer naming convention. Legacy = uses the classic naming style (camelCase)

default

String

camel.metrics.route-policy-exclude-pattern

Pattern to exclude routes (by id) to capture. Multiple route ids can be separated by comma.

String

camel.metrics.route-policy-level

Sets the level of information to capture. Possible values are all,route,context. all = both context and routes. route = routes only. context = camel context only.

all

String

camel.metrics.uri-tag-dynamic

Whether to use static or dynamic values for HTTP uri tags in captured metrics. When using dynamic tags, then a REST service with base URL: /users/{id} will capture metrics with uri tag with the actual dynamic value such as: /users/123. However, this can lead to many tags as the URI is dynamic, so use this with care.

false

Boolean

camel.metrics.uri-tag-enabled

Whether HTTP uri tags should be enabled or not in captured metrics. If disabled then the uri tag, is likely not able to be resolved and will be marked as UNKNOWN.

true

Boolean