InfluxDB Proxy

This project adds a basic high availability and consistent hash layer to InfluxDB.

NOTE: influx-proxy must be built with Go 1.14+ with Go module support, don't implement udp.

Why

We used InfluxDB Relay before, but it doesn't support some demands. We use grafana for visualizing time series data, so we need add datasource for grafana. We need change the datasource config when influxdb is down. We need transfer data across idc, but Relay doesn't support gzip. It's inconvenient to analyse data with connecting different influxdb. Therefore, we made InfluxDB Proxy. More details please visit https://github.com/shell909090/influx-proxy.

Forked from the above InfluxDB Proxy, after many improvements and optimizations, InfluxDB Proxy v1 has released, which no longer depends on python and redis, and supports more features.

Since the InfluxDB Proxy v1 is limited by the only ONE database and the KEYMAPS configuration, we refactored InfluxDB Proxy v2 with high availability and consistent hash, which supports multiple databases and tools to rebalance, recovery, resync and cleanup.

Features

Support gzip.
Support query.
Support some cluster influxql.
Filter some dangerous influxql.
Transparent for client, like cluster for client.
Cache data to file when write failed, then rewrite.
Support multiple databases to create and store.
Support database sharding with consistent hash.
Support tools to rebalance, recovery, resync and cleanup.
Load config file and no longer depend on python and redis.
Support precision query parameter when writing data.
Support influxdb-java, influxdb shell and grafana.
Support authentication and https.
Support health status query.
Support database whitelist.
Support version display.

Requirements

Golang >= 1.14 with Go module support

Usage

Quickstart

$ git clone https://github.com/chengshiwen/influx-proxy.git
$ cd influx-proxy
$ make
$ ./bin/influx-proxy -config proxy.json

Build Release

$ # build current platform
$ make build
$ # build linux amd64
$ make linux

Tutorial

Chinese

Description

The architecture is fairly simple, one InfluxDB Proxy instance and two consistent hash circles with two InfluxDB instances respectively. The Proxy should point HTTP requests with db and measurement to the two circles and the four InfluxDB servers.

The setup should look like this:

        ┌──────────────────┐
        │ writes & queries │
        └──────────────────┘
                 │
                 ▼
        ┌──────────────────┐
        │                  │
        │  InfluxDB Proxy  │
        │   (only http)    │
        │                  │
        └──────────────────┘
                 │
                 ▼
        ┌──────────────────┐
        │  db,measurement  │
        │ consistent hash  │
        └──────────────────┘
          |              |
        ┌─┼──────────────┘
        │ └────────────────┐
        ▼                  ▼
     Circle 1          Circle 2
  ┌────────────┐    ┌────────────┐
  │            │    │            │
  │ InfluxDB 1 │    │ InfluxDB 3 │
  │ InfluxDB 2 │    │ InfluxDB 4 │
  │            │    │            │
  └────────────┘    └────────────┘

Proxy Configuration

The configurations in proxy.json are the following:

circles: circle list
- name: circle name, required
- backends: backend list belong to the circle, required
  - name: backend name, required
  - url: influxdb addr or other http backend which supports influxdb line protocol, required
  - username: influxdb username, with encryption if auth_secure is enabled, default is empty which means no auth
  - password: influxdb password, with encryption if auth_secure is enabled, default is empty which means no auth
  - auth_secure: secure auth with encryption, default is false
listen_addr: proxy listen addr, default is :7076
db_list: database list permitted to access, default is []
data_dir: data dir to save .dat .rec, default is data
tlog_dir: transfer log dir to rebalance, recovery, resync or cleanup, default is log
hash_key: backend key for consistent hash, including "idx", "exi", "name" or "url", default is idx, once changed rebalance operation is necessary
flush_size: default is 10000, wait 10000 points write
flush_time: default is 1, wait 1 second write whether point count has bigger than flush_size config
check_interval: default is 1, check backend active every 1 second
rewrite_interval: default is 10, rewrite every 10 seconds
conn_pool_size: default is 20, create a connection pool which size is 20
write_timeout: default is 10, write timeout until 10 seconds
idle_timeout: default is 10, keep-alives wait time until 10 seconds
username: proxy username, with encryption if auth_secure is enabled, default is empty which means no auth
password: proxy password, with encryption if auth_secure is enabled, default is empty which means no auth
auth_secure: secure auth with encryption, default is false
write_tracing: enable logging for the write, default is false
query_tracing: enable logging for the query, default is false
https_enabled: enable https, default is false
https_cert: the ssl certificate to use when https is enabled, default is empty
https_key: use a separate private key location, default is empty

Query Commands

Unsupported commands

The following commands are forbid.

ALTER
GRANT
REVOKE
KILL
SELECT INTO
Multiple queries delimited by semicolon ;

Supported commands

Only support match the following commands.

select from
show from
show measurements
show series
show field keys
show tag keys
show tag values
show retention policies
show stats
show databases
create database
drop database
delete from
drop series from
drop measurement
on clause (the db parameter takes precedence when the parameter is set in /query http endpoint)

HTTP Endpoints

Benchmark

There are two tools for benchmarking InfluxDB, which can also be applied to InfluxDB Proxy:

influx-stress is a stress tool for generating artificial load on InfluxDB.
influxdb-comparisons contains code for benchmarking InfluxDB against other databases and time series solutions.

License

MIT.

fcddk/influx-proxy