Mainflux.mainflux/writers/influxdb/README.md

InfluxDB writer

InfluxDB writer provides message repository implementation for InfluxDB.

Configuration

The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.

Variable	Description	Default
MF_NATS_URL	NATS instance URL	nats://localhost:4222
MF_INFLUX_WRITER_PORT	Service HTTP port	8180
MF_INFLUX_WRITER_BATCH_SIZE	Size of the writer points batch	5000
MF_INFLUX_WRITER_BATCH_TIMEOUT	Time interval in seconds to flush the batch	1 second
MF_INFLUX_WRITER_DB_NAME	InfluxDB database name	mainflux
MF_INFLUX_WRITER_DB_HOST	InfluxDB host	localhost
MF_INFLUX_WRITER_DB_PORT	Default port of InfluxDB database	8086
MF_INFLUX_WRITER_DB_USER	Default user of InfluxDB database	mainflux
MF_INFLUX_WRITER_DB_PASS	Default password of InfluxDB user	mainflux

Deployment

  version: "2"
  influxdb-writer:
    image: mainflux/influxdb:[version]
    container_name: [instance name]
    expose:
      - [Service HTTP port]
    restart: on-failure
    environment:
      MF_NATS_URL: [NATS instance URL]
      MF_INFLUX_WRITER_PORT: [Service HTTP port]
      MF_INFLUX_WRITER_BATCH_SIZE: [Size of the writer points batch]
      MF_INFLUX_WRITER_BATCH_TIMEOUT: [Time interval in seconds to flush the batch]
      MF_INFLUX_WRITER_DB_NAME: [InfluxDB name]
      MF_INFLUX_WRITER_DB_HOST: [InfluxDB host]
      MF_INFLUX_WRITER_DB_PORT: [InfluxDB port]
      MF_INFLUX_WRITER_DB_USER: [InfluxDB admin user]
      MF_INFLUX_WRITER_DB_PASS: [InfluxDB admin password]
    ports:
      - [host machine port]:[configured HTTP port]

To start the service, execute the following shell script:

# download the latest version of the service
go get github.com/mainflux/mainflux


cd $GOPATH/src/github.com/mainflux/mainflux

# compile the influxdb
make influxdb

# copy binary to bin
make install

# Set the environment variables and run the service
MF_NATS_URL=[NATS instance URL] MF_INFLUX_WRITER_PORT=[Service HTTP port] MF_INFLUX_WRITER_BATCH_SIZE=[Size of the writer points batch] MF_INFLUX_WRITER_BATCH_TIMEOUT=[Time interval in seconds to flush the batch] MF_INFLUX_WRITER_DB_NAME=[InfluxDB database name] MF_INFLUX_WRITER_DB_HOST=[InfluxDB database host] MF_INFLUX_WRITER_DB_PORT=[InfluxDB database port] MF_INFLUX_WRITER_DB_USER=[InfluxDB admin user] MF_INFLUX_WRITER_DB_PASS=[InfluxDB admin password] $GOBIN/mainflux-influxdb

Using docker-compose

This service can be deployed using docker containers. Docker compose file is available in <project_root>/docker/addons/influxdb-writer/docker-compose.yml. Besides database and writer service, it contains Grafana platform which can be used for database exploration and data visualization and analytics. In order to run Mainflux InfluxDB writer, execute the following command:

docker-compose -f docker/addons/influxdb-writer/docker-compose.yml up -d

Please note that you need to start core services before the additional ones.

Usage

Starting service will start consuming normalized messages in SenML format.