package
0.23.2
Repository: https://github.com/mainfluxlabs/mainflux.git
Documentation: pkg.go.dev

# README

MongoDB writer

MongoDB writer provides message repository implementation for MongoDB.

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.

VariableDescriptionDefault
MF_BROKER_URLMessage broker instance URLnats://localhost:4222
MF_MONGO_WRITER_LOG_LEVELLog level for MongoDB writererror
MF_MONGO_WRITER_PORTService HTTP port8180
MF_MONGO_WRITER_DBDefault MongoDB database namemessages
MF_MONGO_WRITER_DB_HOSTDefault MongoDB database hostlocalhost
MF_MONGO_WRITER_DB_PORTDefault MongoDB database port27017
MF_MONGO_WRITER_CONFIG_PATHConfig file path with Message broker subjects list, payload type and content-type/config.toml

Deployment

The service itself is distributed as Docker container. Check the mongodb-writer service section in docker-compose to see how service is deployed.

To start the service, execute the following shell script:

# download the latest version of the service
git clone https://github.com/MainfluxLabs/mainflux

cd mainflux

# compile the mongodb writer
make mongodb-writer

# copy binary to bin
make install

# Set the environment variables and run the service
MF_BROKER_URL=[Message broker instance URL] \
MF_MONGO_WRITER_LOG_LEVEL=[MongoDB writer log level] \
MF_MONGO_WRITER_PORT=[Service HTTP port] \
MF_MONGO_WRITER_DB=[MongoDB database name] \
MF_MONGO_WRITER_DB_HOST=[MongoDB database host] \
MF_MONGO_WRITER_DB_PORT=[MongoDB database port] \
MF_MONGO_WRITER_CONFIG_PATH=[Configuration file path with Message broker subjects list] \
$GOBIN/mainfluxlabs-mongodb-writer

Usage

Starting service will start consuming normalized messages in SenML format.

# Functions

New returns new MongoDB writer.