docs/modules/ROOT/pages/reference/extensions/micrometer.adoc

// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
= Micrometer
:linkattrs:
:cq-artifact-id: camel-quarkus-micrometer
:cq-native-supported: true
:cq-status: Stable
:cq-status-deprecation: Stable
:cq-description: Collect various metrics directly from Camel routes using the Micrometer library.
:cq-deprecated: false
:cq-jvm-since: 1.5.0
:cq-native-since: 1.5.0

[.badges]
[.badge-key]##JVM since##[.badge-supported]##1.5.0## [.badge-key]##Native since##[.badge-supported]##1.5.0##

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

== What's inside

* xref:{cq-camel-components}::micrometer-component.adoc[Micrometer component], URI syntax: `micrometer:metricsType:metricsName`

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

== Maven coordinates

https://code.quarkus.io/?extension-search=camel-quarkus-micrometer[Create a new project with this extension on code.quarkus.io, window="_blank"]

Or add the coordinates to your existing project:

[source,xml]
----
<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-micrometer</artifactId>
</dependency>
----

Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.

== Usage

This extension leverages https://quarkus.io/guides/micrometer[Quarkus Micrometer]. Quarkus supports a variety of Micrometer metric registry implementations.

Your application should declare one of the following dependencies, depending on the monitoring solution you want to work with.

[cols="50,.^50]
|===
|Monitoring System | Dependency

| Azure

| `io.micrometer:micrometer-registry-azure-monitor`

| Datadog

| `io.micrometer:micrometer-registry-datadog`

| JMX (JVM mode only)

| `io.micrometer:micrometer-registry-jmx`

| Prometheus

| `io.micrometer:micrometer-registry-prometheus`

| SignalFx

| `io.micrometer:micrometer-registry-signalfx`

| Stackdriver

| `io.micrometer:micrometer-registry-stackdriver`

| StatsD

| `io.micrometer:micrometer-registry-statsd`

|===


== Additional Camel Quarkus configuration

[width="100%",cols="80,5,15",options="header"]
|===
| Configuration property | Type | Default


|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-route-policy]]`link:#quarkus.camel.metrics.enable-route-policy[quarkus.camel.metrics.enable-route-policy]`

Set whether to enable the MicrometerRoutePolicyFactory for capturing metrics on route processing times.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-message-history]]`link:#quarkus.camel.metrics.enable-message-history[quarkus.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.
| `boolean`
| `false`

|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-exchange-event-notifier]]`link:#quarkus.camel.metrics.enable-exchange-event-notifier[quarkus.camel.metrics.enable-exchange-event-notifier]`

Set whether to enable the MicrometerExchangeEventNotifier for capturing metrics on exchange processing times.
| `boolean`
| `true`

|icon:lock[title=Fixed at build time] [[quarkus.camel.metrics.enable-route-event-notifier]]`link:#quarkus.camel.metrics.enable-route-event-notifier[quarkus.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.
| `boolean`
| `true`
|===

[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime.