Mainflux.mainflux/readers/mongodb

MongoDB reader

MongoDB reader 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.

Variable	Description	Default
MF_MONGO_READER_LOG_LEVEL	Service log level	info
MF_MONGO_READER_HTTP_HOST	Service HTTP host	localhost
MF_MONGO_READER_HTTP_PORT	Service HTTP port	9007
MF_MONGO_READER_HTTP_SERVER_CERT	Service HTTP server cert	""
MF_MONGO_READER_HTTP_SERVER_KEY	Service HTTP server key	""
MF_MONGO_NAME	MongoDB database name	messages
MF_MONGO_HOST	MongoDB database host	localhost
MF_MONGO_PORT	MongoDB database port	27017
MF_THINGS_AUTH_GRPC_URL	Things service Auth gRPC URL	localhost:7000
MF_THINGS_AUTH_GRPC_TIMEOUT	Things service Auth gRPC request timeout in seconds	1s
MF_THINGS_AUTH_GRPC_CLIENT_TLS	Flag that indicates if TLS should be turned on	false
MF_THINGS_AUTH_GRPC_CA_CERTS	Path to trusted CAs in PEM format	""
MF_AUTH_GRPC_URL	Users service gRPC URL	localhost:7001
MF_AUTH_GRPC_TIMEOUT	Users service gRPC request timeout in seconds	1s
MF_AUTH_GRPC_CLIENT_TLS	Flag that indicates if TLS should be turned on	false
MF_AUTH_GRPC_CA_CERT	Path to trusted CAs in PEM format	""
MF_JAEGER_URL	Jaeger server URL	http://jaeger:14268/api/traces
MF_SEND_TELEMETRY	Send telemetry to mainflux call home server	true
MF_MONGO_READER_INSTANCE_ID	Service instance ID	""

Deployment

The service itself is distributed as Docker container. Check the mongodb-reader 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/mainflux/mainflux

cd mainflux

# compile the mongodb reader
make mongodb-reader

# copy binary to bin
make install

# Set the environment variables and run the service
MF_MONGO_READER_LOG_LEVEL=[Service log level] \
MF_MONGO_READER_HTTP_HOST=[Service HTTP host] \
MF_MONGO_READER_HTTP_PORT=[Service HTTP port] \
MF_MONGO_READER_HTTP_SERVER_CERT=[Path to server pem certificate file] \
MF_MONGO_READER_HTTP_SERVER_KEY=[Path to server pem key file] \
MF_MONGO_NAME=[MongoDB database name] \
MF_MONGO_HOST=[MongoDB database host] \
MF_MONGO_PORT=[MongoDB database port] \
MF_THINGS_AUTH_GRPC_URL=[Things service Auth gRPC URL] \
MF_THINGS_AUTH_GRPC_TIMEOUT=[Things service Auth gRPC request timeout in seconds] \
MF_THINGS_AUTH_GRPC_CLIENT_TLS=[Flag that indicates if TLS should be turned on] \
MF_THINGS_AUTH_GRPC_CA_CERTS=[Path to trusted CAs in PEM format] \
MF_AUTH_GRPC_URL=[Users service gRPC URL] \
MF_AUTH_GRPC_TIMEOUT=[Users service gRPC request timeout in seconds] \
MF_AUTH_GRPC_CLIENT_TLS=[Flag that indicates if TLS should be turned on] \
MF_AUTH_GRPC_CA_CERT=[Path to trusted CAs in PEM format] \
MF_JAEGER_URL=[Jaeger server URL] \
MF_SEND_TELEMETRY=[Send telemetry to mainflux call home server] \
MF_MONGO_READER_INSTANCE_ID=[Service instance ID] \
$GOBIN/mainflux-mongodb-reader

Using docker-compose

This service can be deployed using docker containers. Docker compose file is available in <project_root>/docker/addons/mongodb-reader/docker-compose.yml. In order to run all Mainflux core services, as well as mentioned optional ones, execute following command:

docker-compose -f docker/docker-compose.yml up -d
docker-compose -f docker/addons/mongodb-reader/docker-compose.yml up -d

Usage

Service exposes HTTP API for fetching messages.

Note: MongoDB Reader doesn't support searching substrings from string_value, due to inefficient searching as the current data model is not suitable for this type of queries.