• Stars
    star
    412
  • Rank 101,606 (Top 3 %)
  • Language
    Java
  • License
    MIT License
  • Created over 5 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

InfluxDB 2 JVM Based Clients

influxdb-client-java

CircleCI codecov License Maven Central Maven Site GitHub issues GitHub pull requests Slack Status

This repository contains the reference JVM clients for the InfluxDB 2.x. Currently, Java, Reactive, Kotlin and Scala clients are implemented.

Note: Use this client library with InfluxDB 2.x and InfluxDB 1.8+ (see details). For connecting to InfluxDB 1.7 or earlier instances, use the influxdb-java client library.

Documentation

This section contains links to the client library documentation.

Features

  • InfluxDB 2.x client
    • Querying data using the Flux language
    • Querying data using the InfluxQL
    • Writing data using
    • InfluxDB 2.x Management API client for managing
      • sources, buckets
      • tasks
      • authorizations
      • health check
      • ...
  • Supports querying using the Flux language over the InfluxDB 1.7+ REST API (/api/v2/query endpoint)

Clients

The Java, Reactive, OSGi, Kotlin and Scala clients are implemented for the InfluxDB 2.x:

Client Description Documentation Compatibility
java The reference Java client that allows query, write and InfluxDB 2.x management. javadoc, readme 2.x
reactive The reference RxJava client for the InfluxDB 2.x that allows query and write in a reactive way. javadoc, readme 2.x
kotlin The reference Kotlin client that allows query and write for the InfluxDB 2.x by Kotlin Channel and Flow coroutines. KDoc, readme 2.x
scala The reference Scala client that allows query and write for the InfluxDB 2.x by Akka Streams. Scaladoc, readme 2.x
osgi The reference OSGi (R6) client embedding Java and reactive clients and providing standard features (declarative services, configuration, event processing) for the InfluxDB 2.x. javadoc, readme 2.x
karaf The Apache Karaf feature definition for the InfluxDB 2.x. readme 2.x

There is also possibility to use the Flux language over the InfluxDB 1.7+ provided by:

Client Description Documentation Compatibility
flux The reference Java client that allows you to perform Flux queries against InfluxDB 1.7+. javadoc, readme 1.7+

The last useful part is flux-dsl that helps construct Flux query by Query builder pattern:

Flux flux = Flux
    .from("telegraf")
    .window(15L, ChronoUnit.MINUTES, 20L, ChronoUnit.SECONDS)
    .sum();
Module Description Documentation Compatibility
flux-dsl A Java query builder for the Flux language javadoc, readme 1.7+, 2.x

How To Use

This clients are hosted in Maven central Repository.

If you want to use it with the Maven, you have to add only the dependency on the artifact.

Writes and Queries in InfluxDB 2.x

The following example demonstrates how to write data to InfluxDB 2.x and read them back using the Flux language.

Installation

Download the latest version:

Maven dependency:
<dependency>
    <groupId>com.influxdb</groupId>
    <artifactId>influxdb-client-java</artifactId>
    <version>6.9.0</version>
</dependency>
Or when using Gradle:
dependencies {
    implementation "com.influxdb:influxdb-client-java:6.9.0"
}
package example;

import java.time.Instant;
import java.util.List;

import com.influxdb.annotations.Column;
import com.influxdb.annotations.Measurement;
import com.influxdb.client.InfluxDBClient;
import com.influxdb.client.InfluxDBClientFactory;
import com.influxdb.client.QueryApi;
import com.influxdb.client.WriteApiBlocking;
import com.influxdb.client.domain.WritePrecision;
import com.influxdb.client.write.Point;
import com.influxdb.query.FluxRecord;
import com.influxdb.query.FluxTable;

public class InfluxDB2Example {

    private static char[] token = "my-token".toCharArray();
    private static String org = "my-org";
    private static String bucket = "my-bucket";

    public static void main(final String[] args) {

        InfluxDBClient influxDBClient = InfluxDBClientFactory.create("http://localhost:8086", token, org, bucket);

        //
        // Write data
        //
        WriteApiBlocking writeApi = influxDBClient.getWriteApiBlocking();

        //
        // Write by Data Point
        //
        Point point = Point.measurement("temperature")
                .addTag("location", "west")
                .addField("value", 55D)
                .time(Instant.now().toEpochMilli(), WritePrecision.MS);

        writeApi.writePoint(point);

        //
        // Write by LineProtocol
        //
        writeApi.writeRecord(WritePrecision.NS, "temperature,location=north value=60.0");

        //
        // Write by POJO
        //
        Temperature temperature = new Temperature();
        temperature.location = "south";
        temperature.value = 62D;
        temperature.time = Instant.now();

        writeApi.writeMeasurement( WritePrecision.NS, temperature);

        //
        // Query data
        //
        String flux = "from(bucket:\"my-bucket\") |> range(start: 0)";

        QueryApi queryApi = influxDBClient.getQueryApi();

        List<FluxTable> tables = queryApi.query(flux);
        for (FluxTable fluxTable : tables) {
            List<FluxRecord> records = fluxTable.getRecords();
            for (FluxRecord fluxRecord : records) {
                System.out.println(fluxRecord.getTime() + ": " + fluxRecord.getValueByKey("_value"));
            }
        }

        influxDBClient.close();
    }

    @Measurement(name = "temperature")
    private static class Temperature {

        @Column(tag = true)
        String location;

        @Column
        Double value;

        @Column(timestamp = true)
        Instant time;
    }
}

Use Management API to create a new Bucket in InfluxDB 2.x

The following example demonstrates how to use a InfluxDB 2.x Management API. For further information see client documentation.

Installation

Download the latest version:

Maven dependency:
<dependency>
    <groupId>com.influxdb</groupId>
    <artifactId>influxdb-client-java</artifactId>
    <version>6.9.0</version>
</dependency>
Or when using Gradle:
dependencies {
    implementation "com.influxdb:influxdb-client-java:6.9.0"
}
package example;

import java.util.Arrays;

import com.influxdb.client.InfluxDBClient;
import com.influxdb.client.InfluxDBClientFactory;
import com.influxdb.client.domain.Authorization;
import com.influxdb.client.domain.Bucket;
import com.influxdb.client.domain.Permission;
import com.influxdb.client.domain.PermissionResource;
import com.influxdb.client.domain.BucketRetentionRules;

public class InfluxDB2ManagementExample {

    private static char[] token = "my-token".toCharArray();

    public static void main(final String[] args) {

        InfluxDBClient influxDBClient = InfluxDBClientFactory.create("http://localhost:8086", token);

        //
        // Create bucket "iot_bucket" with data retention set to 3,600 seconds
        //
        BucketRetentionRules retention = new BucketRetentionRules();
        retention.setEverySeconds(3600);

        Bucket bucket = influxDBClient.getBucketsApi().createBucket("iot-bucket", retention, "12bdc4164c2e8141");

        //
        // Create access token to "iot_bucket"
        //
        PermissionResource resource = new PermissionResource();
        resource.setId(bucket.getId());
        resource.setOrgID("12bdc4164c2e8141");
        resource.setType(PermissionResource.TYPE_BUCKETS);

        // Read permission
        Permission read = new Permission();
        read.setResource(resource);
        read.setAction(Permission.ActionEnum.READ);

        // Write permission
        Permission write = new Permission();
        write.setResource(resource);
        write.setAction(Permission.ActionEnum.WRITE);

        Authorization authorization = influxDBClient.getAuthorizationsApi()
                .createAuthorization("12bdc4164c2e8141", Arrays.asList(read, write));

        //
        // Created token that can be use for writes to "iot_bucket"
        //
        String token = authorization.getToken();
        System.out.println("Token: " + token);

        influxDBClient.close();
    }
}

InfluxDB 1.8 API compatibility

InfluxDB 1.8.0 introduced forward compatibility APIs for InfluxDB 2.x. This allow you to easily move from InfluxDB 1.x to InfluxDB 2.x Cloud or open source.

The following forward compatible APIs are available:

API Endpoint Description
QueryApi.java /api/v2/query Query data in InfluxDB 1.8.0+ using the InfluxDB 2.x API and Flux (endpoint should be enabled by flux-enabled option)
WriteApi.java /api/v2/write Write data to InfluxDB 1.8.0+ using the InfluxDB 2.x API
health() /health Check the health of your InfluxDB instance

For detail info see InfluxDB 1.8 example.

Flux queries in InfluxDB 1.7+

The following example demonstrates querying using the Flux language.

Installation

Download the latest version:

Maven dependency:
<dependency>
    <groupId>com.influxdb</groupId>
    <artifactId>influxdb-client-flux</artifactId>
    <version>6.9.0</version>
</dependency>
Or when using Gradle:
dependencies {
    implementation "com.influxdb:influxdb-client-flux:6.9.0"
}
package example;

import java.util.List;

import com.influxdb.client.flux.FluxClient;
import com.influxdb.client.flux.FluxClientFactory;
import com.influxdb.query.FluxRecord;
import com.influxdb.query.FluxTable;

public class FluxExample {

    public static void main(String[] args) {

        FluxClient fluxClient = FluxClientFactory.create("http://localhost:8086/");

        //
        // Flux
        //
        String flux = "from(bucket: \"telegraf\")\n" +
                " |> range(start: -1d)" +
                " |> filter(fn: (r) => (r[\"_measurement\"] == \"cpu\" and r[\"_field\"] == \"usage_system\"))" +
                " |> sample(n: 5, pos: 1)";

        //
        // Synchronous query
        //
        List<FluxTable> tables = fluxClient.query(flux);

        for (FluxTable fluxTable : tables) {
            List<FluxRecord> records = fluxTable.getRecords();
            for (FluxRecord fluxRecord : records) {
                System.out.println(fluxRecord.getTime() + ": " + fluxRecord.getValueByKey("_value"));
            }
        }

        //
        // Asynchronous query
        //
        fluxClient.query(flux, (cancellable, record) -> {

            // process the flux query result record
            System.out.println(record.getTime() + ": " + record.getValue());

        }, error -> {

            // error handling while processing result
            System.out.println("Error occurred: "+ error.getMessage());

        }, () -> {

            // on complete
            System.out.println("Query completed");
        });

        fluxClient.close();
    }
}

Build Requirements

  • Java 1.8+ (tested with jdk8)
  • Maven 3.0+ (tested with maven 3.5.0)
  • Docker daemon running
  • The latest InfluxDB 2.x and InfluxDB 1.X docker instances, which can be started using the ./scripts/influxdb-restart.sh script

Once these are in place you can build influxdb-client-java with all tests with:

$ mvn clean install

If you don't have Docker running locally, you can skip tests with the -DskipTests flag set to true:

$ mvn clean install -DskipTests=true

If you have Docker running, but it is not available over localhost (e.g. you are on a Mac and using docker-machine) you can set optional environment variables to point to the correct IP addresses and ports:

  • INFLUXDB_IP
  • INFLUXDB_PORT_API
  • INFLUXDB_2_IP
  • INFLUXDB_2_PORT_API
$ export INFLUXDB_IP=192.168.99.100
$ mvn test

Contributing

If you would like to contribute code you can do through GitHub by forking the repository and sending a pull request into the master branch.

License

The InfluxDB 2.x JVM Based Clients are released under the MIT License.

More Repositories

1

influxdb

Scalable datastore for metrics, events, and real-time analytics
Rust
27,320
star
2

telegraf

Agent for collecting, processing, aggregating, and writing metrics, logs, and other arbitrary data.
Go
13,798
star
3

kapacitor

Open source framework for processing, monitoring, and alerting on time series data
Go
2,279
star
4

influxdb_iox

Pronounced (influxdb eye-ox), short for iron oxide. This is the new core of InfluxDB written in Rust on top of Apache Arrow.
Rust
1,803
star
5

influxdb-python

Python client for InfluxDB
Python
1,678
star
6

chronograf

Open source monitoring and visualization UI for the TICK stack
TypeScript
1,480
star
7

influxdb-java

Java client for InfluxDB
Java
1,156
star
8

influxdb-relay

Service to replicate InfluxDB data for high availability
Python
830
star
9

flux

Flux is a lightweight scripting language for querying databases (like InfluxDB) and working with data. It's part of InfluxDB 1.7 and 2.0, but can be run independently of those.
FLUX
753
star
10

influxdb-client-python

InfluxDB 2.0 python client
Python
664
star
11

influxdb-client-go

InfluxDB 2 Go Client
Go
572
star
12

sandbox

A sandbox for the full TICK stack
Shell
475
star
13

go-syslog

Blazing fast syslog parser
Go
468
star
14

influxdb-php

influxdb-php: A PHP Client for InfluxDB, a time series database
PHP
430
star
15

influxdb-client-csharp

InfluxDB 2.x C# Client
C#
337
star
16

community-templates

InfluxDB Community Templates: Quickly collect & analyze time series data from a range of sources: Kubernetes, MySQL, Postgres, AWS, Nginx, Jenkins, and more.
Python
332
star
17

influxdb-client-js

InfluxDB 2.0 JavaScript client
TypeScript
316
star
18

influxdata-docker

Official docker images for the influxdata stack
Shell
314
star
19

influxdb-comparisons

Code for comparison write ups of InfluxDB and other solutions
Go
306
star
20

rskafka

A minimal Rust client for Apache Kafka
Rust
282
star
21

docs.influxdata.com-ARCHIVE

ARCHIVE - 1.x docs for InfluxData
Less
253
star
22

helm-charts

Official Helm Chart Repository for InfluxData Applications
Mustache
212
star
23

influxdb-rails

Ruby on Rails bindings to automatically write metrics into InfluxDB
Ruby
205
star
24

influxdb-csharp

A .NET library for efficiently sending points to InfluxDB 1.x
C#
198
star
25

influxdb1-client

The old clientv2 for InfluxDB 1.x
Go
187
star
26

giraffe

A foundation for visualizations in the InfluxDB UI
TypeScript
178
star
27

influxql

Package influxql implements a parser for the InfluxDB query language.
Go
163
star
28

influxdb-client-php

InfluxDB (v2+) Client Library for PHP
PHP
140
star
29

tdigest

An implementation of Ted Dunning's t-digest in Go.
Go
126
star
30

influx-stress

New tool for generating artificial load on InfluxDB
Go
118
star
31

tick-charts

A repository for Helm Charts for the full TICK Stack
Smarty
90
star
32

ui

UI for InfluxDB
TypeScript
86
star
33

telegraf-operator

telegraf-operator helps monitor application on Kubernetes with Telegraf
Go
79
star
34

pbjson

Auto-generate serde implementations for prost types
Rust
79
star
35

inch

An InfluxDB benchmarking tool.
Go
78
star
36

influxdata-operator

A k8s operator for InfluxDB
Go
76
star
37

docs-v2

InfluxData Documentation that covers InfluxDB Cloud, InfluxDB OSS 2.x, InfluxDB OSS 1.x, InfluxDB Enterprise, Telegraf, Chronograf, Kapacitor, and Flux.
SCSS
66
star
38

wirey

Manage local wireguard interfaces in a distributed system
Go
62
star
39

influxdb-go

61
star
40

influx-cli

CLI for managing resources in InfluxDB v2
Go
58
star
41

terraform-aws-influx

Reusable infrastructure modules for running TICK stack on AWS
HCL
50
star
42

grade

Track Go benchmark performance over time by storing results in InfluxDB
Go
43
star
43

influxdb-r

R library for InfluxDB
R
43
star
44

influxdb-observability

Go
43
star
45

clockface

UI Kit for building Chronograf
TypeScript
43
star
46

nginx-influxdb-module

C
40
star
47

influxdb2-sample-data

Sample data for InfluxDB 2.0
JavaScript
40
star
48

influxdb-client-ruby

InfluxDB 2.0 Ruby Client
Ruby
40
star
49

tensorflow-influxdb

Jupyter Notebook
34
star
50

nifi-influxdb-bundle

InfluxDB Processors For Apache NiFi
Java
33
star
51

line-protocol

Go
33
star
52

whisper-migrator

A tool for migrating data from Graphite Whisper files to InfluxDB TSM files (version 0.10.0).
Go
33
star
53

iot-center-flutter

InlfuxDB 2.0 dart client flutter demo
Dart
31
star
54

kube-influxdb

Configuration to monitor Kubernetes with the TICK stack
Shell
30
star
55

k8s-kapacitor-autoscale

Demonstration of using Kapacitor to autoscale a k8s deployment
Go
30
star
56

terraform-aws-influxdb

Deploys InfluxDB Enterprise to AWS
HCL
29
star
57

catslack

Shell -> Slack the easy way
Go
28
star
58

influxdb-operator

The Kubernetes operator for InfluxDB and the TICK stack.
Go
27
star
59

flux-lsp

Implementation of Language Server Protocol for the flux language
Rust
26
star
60

influxdb-client-swift

InfluxDB (v2+) Client Library for Swift
Swift
26
star
61

flightsql-dbapi

DB API 2 interface for Flight SQL with SQLAlchemy extras.
Python
26
star
62

influxdb-c

C
25
star
63

influxdb-client-dart

InfluxDB (v2+) Client Library for Dart and Flutter
Dart
24
star
64

ansible-chrony

A role to manage chrony on Linux systems
Ruby
24
star
65

kapacitor-course

24
star
66

vsflux

Flux language extension for VSCode
TypeScript
24
star
67

grafana-flightsql-datasource

Grafana plugin for Flight SQL APIs.
TypeScript
24
star
68

influxdb-scala

Scala client for InfluxDB
Scala
22
star
69

cron

A fast, zero-allocation cron parser in ragel and golang
Go
21
star
70

influxdb-plugin-fluent

A buffered output plugin for Fluentd and InfluxDB 2
Ruby
21
star
71

terraform-google-influx

Reusable infrastructure modules for running TICK stack on GCP
Shell
20
star
72

influxdb3_core

InfluxData's core functionality for InfluxDB Edge and IOx
Rust
18
star
73

openapi

An OpenAPI specification for influx (cloud/oss) apis.
Shell
17
star
74

influxdb-university

InfluxDB University
Python
16
star
75

influxdb-client-r

InfluxDB (v2+) Client R Package
R
14
star
76

cd-gitops-reference-architecture

Details of the CD/GitOps architecture in use at InfluxData
Shell
13
star
77

kafka-connect-influxdb

InfluxDB 2 Connector for Kafka
Scala
13
star
78

oats

An OpenAPI to TypeScript generator.
TypeScript
12
star
79

awesome

SCSS
12
star
80

windows-packager

Create a windows installer
Shell
12
star
81

iot-api-ui

Common React UI for iot-api-<js, python, etc.> example apps designed for InfluxDB client library tutorials.
TypeScript
12
star
82

promql

Go
11
star
83

yarpc

Yet Another RPC for Go
Go
11
star
84

iot-api-python

Python
11
star
85

influxdb-gds-connector

Google Data Studio Connector for InfluxDB.
JavaScript
11
star
86

object_store_rs

Rust
10
star
87

ansible-influxdb-enterprise

Ansible role for deploying InfluxDB Enterprise.
10
star
88

influxdb-sample-data

Sample time series data used to test InfluxDB
9
star
89

ingen

ingen is a tool for directly generating TSM data
Go
8
star
90

ansible-kapacitor

Official Kapacitor Ansible Role for Linux
Jinja
7
star
91

wlog

Simple log level based Go logger.
Go
7
star
92

iot-api-js

An example IoT app built with NextJS (NodeJS + React) and the InfluxDB API client library for Javascript.
JavaScript
7
star
93

influxdb-iox-client-go

InfluxDB/IOx Client for Go
Go
7
star
94

k8s-jsonnet-libs

Jsonnet Libs repo - mostly generated with jsonnet-libs/k8s project
Jsonnet
7
star
95

google-deployment-manager-influxdb-enterprise

GCP Deployment Manager templates for InfluxDB Enterprise.
HTML
6
star
96

jaeger-influxdb

Go
6
star
97

influxdb-action

A GitHub action for setting up and configuring InfluxDB and the InfluxDB Cloud CLI
Shell
6
star
98

influxdb-fsharp

A F# client library for InfluxDB, a time series database http://influxdb.com
F#
6
star
99

qprof

A tool for profiling the performance of InfluxQL queries
Go
6
star
100

influxdb-nodejs

InfluxDB client library for NodeJS
5
star