InfluxDB

Since Camel 2.18

Only producer is supported

This component allows you to interact with InfluxDB v1 https://influxdata.com/time-series-platform/influxdb/ a time series database.

The native body type for this component is Point (the native influxdb class), but it can also accept Map<String, Object> as message body, and it will get converted to Point.class, please note that the map must contain an element with InfluxDbConstants.MEASUREMENT_NAME as key.

Additionally, of course you may register your own Converters to your data type to Point, or use the (un)marshalling tools provided by camel.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-influxdb</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

influxdb://beanName?[options]

The producer allows sending messages to a influxdb configured in the registry, using the native java driver.

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The InfluxDB component supports 3 options, which are listed below.

Name Description Default Type

influxDB (producer)

Autowired The shared Influx DB to use for all endpoints.

InfluxDB

lazyStartProducer (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

autowiredEnabled (advanced)

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

Endpoint Options

The InfluxDB endpoint is configured using URI syntax:

influxdb:connectionBean

with the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

connectionBean (producer)

Required Connection to the influx database, of class InfluxDB.class.

String

Query Parameters (8 parameters)

Name Description Default Type

autoCreateDatabase (producer)

Define if we want to auto create the database if it’s not present.

false

boolean

batch (producer)

Define if this operation is a batch operation or not.

false

boolean

checkDatabaseExistence (producer)

Define if we want to check the database existence while starting the endpoint.

false

boolean

databaseName (producer)

The name of the database where the time series will be stored.

String

operation (producer)

Define if this operation is an insert or a query.

insert

String

query (producer)

Define the query in case of operation query.

String

retentionPolicy (producer)

The string that defines the retention policy to the data created by the endpoint.

default

String

lazyStartProducer (producer (advanced))

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

Message Headers

The InfluxDB component supports 3 message header(s), which is/are listed below:

Name Description Default Type

camelInfluxDB.RetentionPolicy (producer)

Constant: RETENTION_POLICY_HEADER

The string that defines the retention policy to the data created by the endpoint.

String

camelInfluxDB.databaseName (producer)

Constant: DBNAME_HEADER

The name of the database where the time series will be stored.

String

camelInfluxDB.query (producer)

Constant: INFLUXDB_QUERY

Define the query in case of operation query.

String

Example

Below is an example route that stores a point into the db (taking the db name from the URI) specific key:

from("direct:start")
        .setHeader(InfluxDbConstants.DBNAME_HEADER, constant("myTimeSeriesDB"))
        .to("influxdb://connectionBean);
from("direct:start")
        .to("influxdb://connectionBean?databaseName=myTimeSeriesDB");

Spring Boot Auto-Configuration

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

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-influxdb-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 4 options, which are listed below.

Name Description Default Type

camel.component.influxdb.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.influxdb.enabled

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

Boolean

camel.component.influxdb.influx-d-b

The shared Influx DB to use for all endpoints. The option is a org.influxdb.InfluxDB type.

InfluxDB

camel.component.influxdb.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
Back to top