Mainflux.mainflux/writers/influxdb
Dušan Borovčanin b694f08ea2
Inteface implementation files match interface name (#329)
Signed-off-by: Dušan Borovčanin <dusan.borovcanin@mainflux.com>
2018-06-18 10:51:30 +02:00
..
README.md MF-237 - Add support for storing messages in MongoDB (#307) 2018-06-01 15:50:23 +02:00
api.go MF-235 - Add support for storing messages in Cassandra (#321) 2018-06-08 14:25:55 +02:00
doc.go MF-236 - Add support for storing messages in InfluxDB (#283) 2018-05-21 16:28:52 +02:00
messages.go Inteface implementation files match interface name (#329) 2018-06-18 10:51:30 +02:00
messages_test.go Inteface implementation files match interface name (#329) 2018-06-18 10:51:30 +02:00
setup_test.go MF-236 - Add support for storing messages in InfluxDB (#283) 2018-05-21 16:28:52 +02:00

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_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_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_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/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 all Mainflux core services, as well as mentioned optional ones, execute following command:

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

Please note that order matters here. You need to start core services before additional ones, i. e. core services compose file needs to be the first param of the command. Since all services need to be in the same network and writer services are dependent of core ones, you need to start all of them using single command.

Usage

Starting service will start consuming normalized messages in SenML format.