// spring-boot-auto-configure options: START
:page-partial:
:doctitle: Camel Spring Boot Starter for ganglia

== Spring Boot Auto-Configuration

When using ganglia with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

[source,xml]
----
<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-ganglia-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>
----


The component supports 16 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *camel.component.ganglia.configuration* | To use the shared configuration. The option is a org.apache.camel.component.ganglia.GangliaConfiguration type. |  | GangliaConfiguration
| *camel.component.ganglia.dmax* | Minumum time in seconds before Ganglia will purge the metric value if it expires. Set to 0 and the value will remain in Ganglia indefinitely until a gmond agent restart. | 0 | Integer
| *camel.component.ganglia.enabled* | Whether to enable auto configuration of the ganglia component. This is enabled by default. |  | Boolean
| *camel.component.ganglia.group-name* | The group that the metric belongs to. | java | String
| *camel.component.ganglia.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.ganglia.metric-name* | The name to use for the metric. | metric | String
| *camel.component.ganglia.mode* | Send the UDP metric packets using MULTICAST or UNICAST |  | GMetric$UDPAddressingMode
| *camel.component.ganglia.prefix* | Prefix the metric name with this string and an underscore. |  | String
| *camel.component.ganglia.slope* | The slope |  | GMetricSlope
| *camel.component.ganglia.spoof-hostname* | Spoofing information IP:hostname |  | String
| *camel.component.ganglia.tmax* | Maximum time in seconds that the value can be considered current. After this, Ganglia considers the value to have expired. | 60 | Integer
| *camel.component.ganglia.ttl* | If using multicast, set the TTL of the packets | 5 | Integer
| *camel.component.ganglia.type* | The type of value |  | GMetricType
| *camel.component.ganglia.units* | Any unit of measurement that qualifies the metric, e.g. widgets, litres, bytes. Do not include a prefix such as k (kilo) or m (milli), other tools may scale the units later. The value should be unscaled. |  | String
| *camel.component.ganglia.wire-format31x* | Use the wire format of Ganglia 3.1.0 and later versions. Set this to false to use Ganglia 3.0.x or earlier. | true | Boolean
| *camel.component.ganglia.basic-property-binding* | *Deprecated* Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean
|===
// spring-boot-auto-configure options: END
