Merge pull request #24 from ralatsdc/rl/upstream-use-common-environme…

…nt-variable-names

Use common environment variable names

couchdb-saver.env

@@ -0,0 +1,12 @@
+PROJECT_NAME=<PROJECT_NAME>
+HOSTNAME=<HOSTNAME>
+MQTT_IP=mqtt
+SENSOR_SAVE_TOPIC=/${PROJECT_NAME}/${HOSTNAME}/Sensor_Save/edgetech-audio-recorder/string
+TELEMETRY_TOPIC=/${PROJECT_NAME}/${HOSTNAME}/Telemetry/edgetech-audio-recorder/string
+AUDIO_SAVE_TOPIC=/${PROJECT_NAME}/${HOSTNAME}/Audio_Save/edgetech-audio-recorder/string
+COUCHDB_ERROR_TOPIC=/${PROJECT_NAME}/${HOSTNAME}/CouchDB_Error/edgetech-audio-recorder/string
+COUCHDB_USER=<COUCHDB_USER>
+COUCHDB_PASSWORD=<COUCHDB_PASSWORD>
+COUCHDB_SERVER_IP_ADDR=<COUCHDB_SERVER_IP_ADDR>
+DEVICE_IP=<DEVICE_IP>
+LOG_LEVEL=INFO

couchdb-saver/couchdb_saver_pub_sub.py

@@ -4,6 +4,7 @@
 """
 import os
 import json
+import logging
 from time import sleep
 from typing import Any, Dict
 
@@ -23,6 +24,7 @@ class CouchDBSaverPubSub(BaseMQTTPubSub):
         BaseMQTTPubSub (BaseMQTTPubSub): parent class written in the EdgeTech Core module
     """
 
+    # TODO: Include HOSTNAME?
     def __init__(
         self: Any,
         sensor_save_topic: str,
@@ -34,6 +36,7 @@ def __init__(
         couchdb_server_ip: str,
         device_ip: str,
         debug: bool = False,
+        log_level: str = "INFO",
         **kwargs: Any,
     ) -> None:
         """The CouchDBSaverPubSub takes MQTT topics to write data from and CouchDB authentication
@@ -50,6 +53,8 @@ def __init__(
             couchdb_user (str): the username for CouchDB authentication
             couchdb_password (str): the password for CouchDB authentication
             couchdb_server_ip (str): the IP address for couchDB authentication
+            log_level (str): One of 'NOTSET', 'DEBUG', 'INFO', 'WARN',
+            'WARNING', 'ERROR', 'FATAL', 'CRITICAL'
             device_ip (str): the IP of the current device
         """
         # to override any of the BaseMQTTPubSub attributes
@@ -65,6 +70,7 @@ def __init__(
         self.couchdb_server_ip = couchdb_server_ip
         self.device_ip = device_ip
         self.debug = debug
+        self.log_level = log_level
 
         # open schema file for validation
         with open("couchdb_saver.schema", "r", encoding="utf-8") as file_pointer:
@@ -75,6 +81,22 @@ def __init__(
         sleep(1)
         self.publish_registration("CouchDB Saver Registration")
 
+        # Log configuration parameters
+        logging.info(
+            f"""CouchDBSaverPubSub initialized with parameters:
+    sensor_save_topic = {sensor_save_topic}
+    telemetry_save_topic = {telemetry_save_topic}
+    audio_save_topic = {audio_save_topic}
+    couchdb_error_topic = {couchdb_error_topic}
+    couchdb_user = {couchdb_user}
+    couchdb_password = {couchdb_password}
+    couchdb_server_ip = {couchdb_server_ip}
+    device_ip = {device_ip}
+    debug = {debug}
+    log_level = {log_level}
+            """
+        )
+
     def _to_save_callback(
         self: Any, _client: mqtt.Client, _userdata: Dict[Any, Any], msg: Any
     ) -> None:
@@ -137,14 +159,15 @@ def main(self: Any) -> None:
 
 if __name__ == "__main__":
     saver = CouchDBSaverPubSub(
-        sensor_save_topic=str(os.environ.get("SENSOR_TOPIC")),
-        telemetry_save_topic=str(os.environ.get("TELEMETRY_TOPIC")),
-        audio_save_topic=str(os.environ.get("AUDIO_TOPIC")),
+        mqtt_ip=str(os.environ.get("MQTT_IP")),
+        sensor_save_topic=str(os.environ.get("SENSOR_SAVE_TOPIC")),
+        telemetry_save_topic=str(os.environ.get("TELEMETRY_SAVE_TOPIC")),
+        audio_save_topic=str(os.environ.get("AUDIO_SAVE_TOPIC")),
         couchdb_error_topic=str(os.environ.get("COUCHDB_ERROR_TOPIC")),
         couchdb_user=str(os.environ.get("COUCHDB_USER")),
         couchdb_password=str(os.environ.get("COUCHDB_PASSWORD")),
         couchdb_server_ip=str(os.environ.get("COUCHDB_SERVER_IP_ADDR")),
         device_ip=str(os.environ.get("DEVICE_IP")),
-        mqtt_ip=str(os.environ.get("MQTT_IP")),
+        log_level=str(os.environ.get("LOG_LEVEL")),
     )
     saver.main()

docker-compose.yml

@@ -16,15 +16,16 @@ services:
     build:
       context: ./couchdb-saver
       dockerfile: ./Dockerfile
+    restart: unless-stopped
     volumes:
       - /home/mobian/sensor-data:/sensor-data
-    restart: unless-stopped
-    depends_on: 
-      - mqtt
-    env_file:
-      - .env
     logging:
       driver: "json-file"
       options:
         max-size: "10M"
-        max-file: "10"
+        max-file: "10"
+    depends_on: 
+      - mqtt
+    env_file:
+      - path: ./couchdb-saver.env
+        required: false