Camel Components

InfluxDB

Since Camel 2.18

Only producer is supported

This component allows you to interact with InfluxDB v1, a time series database.

The native body type for this component is Point (the native influxdb class). However, 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 camelInfluxDB.MeasurementName as key.

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

For InfluxDB v2 check the InfluxDB2 component.

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 an 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

At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level.

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.

You can configure components using:

  • the Component DSL.

  • in a configuration file (application.properties, *.yaml files, etc).

  • directly in the Java code.

Configuring Endpoint Options

You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or 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.

Property placeholders provide a few benefits:

  • They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.

  • They allow externalizing the configuration from the code.

  • They help the code to become more flexible and reusable.

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

Component Options

The InfluxDB component supports the following 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

Name Description Default Type

connectionBean (producer)

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

String

Query 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 the following 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

Message Body

The message body at each side of the InfluxDB component: Consumer is the body of the messages the consumer creates, Consumer reply the bodies a consumer that answers its caller can reply with, Producer input the bodies the producer can send or write, and Producer output the body after the producer.

Side Body Description

Producer input

pojo or map

The org.influxdb.dto.Point to write, or a Map of the field names and their values with the measurement name under the camelInfluxDB.MeasurementName key. Text, bytes or a List of Points fail: line protocol is not parsed. With batch=true the body must be a BatchPoints. The query and ping operations do not read the body: the query comes from the camelInfluxDB.query header or the query option.

  • With batch=true: pojo (org.influxdb.dto.BatchPoints)

  • With operation=query: any

  • With operation=ping: any

Producer output

unchanged

An insert leaves the body unchanged. A query gives the QueryResult of InfluxDB, which carries an error the server reports (such as an unknown database) instead of failing the exchange; ping gives the Pong with the version of the server.

  • With operation=query: pojo (org.influxdb.dto.QueryResult)

  • With operation=ping: pojo (org.influxdb.dto.Pong)

The bodies are the ones with the default options. A side that is not listed is not known, and tooling does not guess it. The carriers are described in the Camel Catalog.

Example

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

  • Java

  • XML

  • YAML

from("direct:start")
        .to("influxdb://connectionBean?databaseName=myTimeSeriesDB");
<route>
  <from uri="direct:start"/>
  <to uri="influxdb://connectionBean?databaseName=myTimeSeriesDB"/>
</route>
- route:
    from:
      uri: direct:start
      steps:
        - to:
            uri: influxdb://connectionBean
            parameters:
              databaseName: myTimeSeriesDB