From d5bcf04e611d057a8bf66417dcc6ab097096a796 Mon Sep 17 00:00:00 2001 From: brb Date: Wed, 12 Jul 2023 14:01:06 +0200 Subject: [PATCH] updated readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 0ceeb97..60977f1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # bandwidth_probing Service that runs in a container and measures network bandwidth at a specified interval. The results are sent to a MongoDB database. Logs are sent to discord channel. + +## Environment Variables + +```python +LOGGER_LEVEL: Literal['debug', 'info', 'warning', 'error', 'critical'] = 'debug' +USER_ID: int = 0 # id number 0 is reserved for testing +REPLICATES: int = 3 # number of replicates to be measured per event +TRIGGER_INTERVAL_SECONDS: float = 3600 # seconds between events +DATA_QUEUE_FLUSH_INTERVAL_SECONDS: float = 600 # seconds between attempts to push data stuck in data queue + +DB_IP_ADDRESS: str = '192.168.1.2' +DB_NAME: str = 'bandwidth_probing' +DB_COLLECTION_NAME: str = 'data' + +DISCORD_SERVICE_NAME: str = 'bandwidth_probing +DISCORD_WEBHOOK_URL: str = 'https://discord.com/api/webhooks/1127970367047225354/wNkoRex4OncMw11OCJg6atR_xgHS2VhLrku4jYIUw81Kr4sutdD3Tt-XAltG0UQy14rZ' +DISCORD_LOGGER_LEVEL: Literal['debug', 'info', 'warning', 'error', 'critical'] = 'warning' +```