blackorder/jasmin-mongo-logger repository overview

⁠Jasmin Mongo Logger

Log Jasmin SMS Gateway⁠'s MT/MO to MongoDB Cluster (can be a one-node cluster).

⁠Table of Contents

1. Installation Instructions⁠
   
   • PYPI⁠
     
   • From Source⁠
     
2. Setup MongoDB CLuster⁠
   
3. Usage Instructions⁠
   
   • Data Structure⁠
     
   • Start the Service⁠
     

⁠Installation Instructions

⁠PYPI:

pip3 install -U jasmin-mongo-logger

⁠From Source:

git clone https://github.com/BlackOrder/jasmin_mongo_logger.git
cd jasmin_mongo_logger
pip3 install .

⁠Docker:

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

Be sure to change the AMQP_BROKER_HOST and MONGO_CONNECTION_STRING in the docker-compose.yml file to your desired values. and also finish the setup of the MongoDB cluster⁠ before running the docker-compose file.

⁠Setup MongoDB CLuster

To setup a MongoDB cluster with Docker, You can use this open source Docker Custom MongoDB Image⁠

⁠Usage Instructions:

Jasmin Mongo Logger Logs all MT/MO from jasmin to MongoDB Cluster. All settings are read from OS ENV when run from console. if you want to import it in you code, you can supply the settings on initialization.

⁠Data Structure

You have to supply a database and a collection name. The package will dump all data into the collection.

⁠Start the service

There is multiple ways to setup the package from CLI.

1. By exporting ENV variables you can export the fallowing variables before execution

AMQP_BROKER_HOST                    =              127.0.0.1
AMQP_BROKER_PORT                    =                5672
MONGO_CONNECTION_STRING             =       **REQUIRED:NoDefault**
MONGO_LOGGER_DATABASE               =       **REQUIRED:NoDefault**
MONGO_LOGGER_COLLECTION             =       **REQUIRED:NoDefault**
JASMIN_MONGO_LOGGER_LOG_PATH        =          /var/log/jasmin/
JASMIN_MONGO_LOGGER_LOG_LEVEL       =               INFO

Then execute:

jasminmongologd

1. You can pass arguments to the package on execution. execute jasminmongologd -h to see all possible arguments. Then execute:

jasminmongologd --connection-string $MONGO_CONNECTION_STRING --database $MONGO_LOGGER_DATABASE --collection $MONGO_LOGGER_COLLECTION

1. Mix the previous two methods. you can set the ENV variables and pass some arguments. for example:

AMQP_BROKER_HOST=127.0.0.1 jasminmongologd --connection-string $MONGO_CONNECTION_STRING --database $MONGO_LOGGER_DATABASE --collection $MONGO_LOGGER_COLLECTION