code documentation

diff --git a/python.d/hddtemp.chart.py b/python.d/hddtemp.chart.py
index 1cf8a5fbbfa45c90047d066a9b8fd7e784a0e21e..75153b8f8dbf484f7e200d3af99f87d6faa8a5f9 100644 (file)
--- a/python.d/hddtemp.chart.py
+++ b/python.d/hddtemp.chart.py
@@ -54,6 +54,10 @@ class Service(NetSocketService):
         return data
 
     def check(self):
+        """
+        Parse configuration, check if hddtemp is available, and dynamically create chart lines data
+        :return: boolean
+        """
         self._parse_config()
 
         data = self._get_data()

diff --git a/python.d/python_modules/base.py b/python.d/python_modules/base.py
index 86bdea7361e1659c4c536f9173944ec838013634..f158730da71bef27d84a21edae79f6b32d1c51ed 100644 (file)
--- a/python.d/python_modules/base.py
+++ b/python.d/python_modules/base.py
@@ -366,8 +366,12 @@ class SimpleService(BaseService):
 
 
 class UrlService(SimpleService):
+    # TODO HTTP Basic Authentication
     def __init__(self, configuration=None, name=None):
         self.url = ""
+        self.user = None
+        self.password = None
+        self.request = None
         SimpleService.__init__(self, configuration=configuration, name=name)
 
     def _get_raw_data(self):
@@ -458,7 +462,7 @@ class NetSocketService(SimpleService):
 
     def _parse_config(self):
         """
-        Format configuration data and try to connect to server
+        Parse configuration data
         :return: boolean
         """
         if self.name is not None or self.name != str(None):
@@ -489,6 +493,10 @@ class LogService(SimpleService):
         self.retries = 100000  # basically always retry
 
     def _get_raw_data(self):
+        """
+        Get log lines since last poll
+        :return: list
+        """
         lines = []
         try:
             if os.path.getsize(self.log_path) < self._last_position:
@@ -508,6 +516,10 @@ class LogService(SimpleService):
         return None
 
     def check(self):
+        """
+        Parse basic configuration and check if log file exists
+        :return: boolean
+        """
         if self.name is not None or self.name != str(None):
             self.name = ""
         else:

diff --git a/python.d/squid.chart.py b/python.d/squid.chart.py
index c1e568f5b5362628efe32082831a6a6da0c90e0c..d3110907f8b851bbbe2a8cda98ec04b6d5110dc2 100644 (file)
--- a/python.d/squid.chart.py
+++ b/python.d/squid.chart.py
@@ -9,14 +9,6 @@ from base import NetSocketService
 priority = 60000
 retries = 5
 
-# default job configuration (overridden by python.d.plugin)
-# config = {'local': {
-#             'update_every': update_every,
-#             'retries': retries,
-#             'priority': priority,
-#             'url': 'http://localhost/stub_status'
-#          }}
-
 # charts order (can be overridden if you want less charts, or different order)
 ORDER = ['clients_net', 'clients_requests', 'servers_net', 'servers_requests']
 
@@ -61,7 +53,7 @@ class Service(NetSocketService):
 
     def _get_data(self):
         """
-        Get data from http request
+        Get data via http request
         :return: dict
         """
         try:
@@ -79,6 +71,10 @@ class Service(NetSocketService):
             return None
 
     def check(self):
+        """
+        Parse essential configuration, autodetect squid configuration (if needed), and check if data is available
+        :return: boolean
+        """
         self._parse_config()
         # format request
         self.request.decode()