add comments

2 files changed, 35 insertions, 0 deletions

diff --git a/modules/telegraf/core.py b/modules/telegraf/core.py
index 0c9f9c7..b340742 100644
--- a/modules/telegraf/core.py
+++ b/modules/telegraf/core.py
@@ -27,6 +27,17 @@ def introduction():
 
 
 def modify_template(new_pipeline_path, api_url, schedulingPeriod, data_values, measurement_name, api_username, api_password, template_name):
+    """
+    data_values: valitud andmeväljad, mida konveier filtreerib
+    scedulingPeriod: kui tihti konveier jookseb
+    new_pipeline_name: uue konveieri nimi
+    api_url: andmete tõmbamise API url
+    api_username: Olemasolu korral API kasutaja nimi
+    api_parool: Olemasolu korral API kasutaja parool
+
+    Teeb mallis kõik vajalikud muudatused andmekonveieri valmimiseks
+    """
+
     ## Pipeline interval
     telegraf_utils.modify_agent(new_pipeline_path,"interval", schedulingPeriod)
 
@@ -80,6 +91,9 @@ def modify_template(new_pipeline_path, api_url, schedulingPeriod, data_values, m
 
 
 def build_pipeline():
+    """
+    Ehitab andmekonveieri kokku 
+    """
     if config.INTERACTIVE_MODE:
         data_values, api_url, api_username, api_password= common.get_data_values()
 
diff --git a/modules/telegraf/telegraf_utils.py b/modules/telegraf/telegraf_utils.py
index 2e72fbf..00bc232 100644
--- a/modules/telegraf/telegraf_utils.py
+++ b/modules/telegraf/telegraf_utils.py
@@ -1,6 +1,13 @@
 import toml
 
 def modify_input(new_pipeline_path, key, value):
+    """
+    new_pipeline_path: Uue konveieri faili asukoht 
+    key: plugginas muudetav võti
+    value: muudetava võtme väärtus
+
+    Muudab konfiguratsiooni faili 'inputs.http' plugginas etteantud väärtuse
+    """
     data = toml.load(new_pipeline_path)
     pluggin = data["inputs"]["http"][0]
 
@@ -18,6 +25,13 @@ def modify_input(new_pipeline_path, key, value):
 ##modify_input("templates/basic_ETL.toml", "test_pipers.toml, "urls", ["stillTesting"])
 
 def modify_agent(new_pipeline_path, key, value):
+    """
+    new_pipeline_path: Uue konveieri faili asukoht 
+    key: plugginas muudetav võti
+    value: muudetava võtme väärtus
+
+    Muudab konfiguratsiooni faili 'agent' plugginas etteantud väärtuse
+    """
     data = toml.load(new_pipeline_path)
     pluggin = data["agent"]
 
@@ -33,6 +47,13 @@ def modify_agent(new_pipeline_path, key, value):
 
 
 def modify_output(new_pipeline_path, key, value):
+    """
+    new_pipeline_path: Uue konveieri faili asukoht 
+    key: plugginas muudetav võti
+    value: muudetava võtme väärtus
+
+    Muudab konfiguratsiooni faili 'outputs.influxdb' plugginas etteantud väärtuse
+    """
     data = toml.load(new_pipeline_path)
     pluggin = data["outputs"]["influxdb"][0]