robotframework-prometheus 0.6.1__py3-none-any.whl

PrometheusInterface/__init__.py

@@ -0,0 +1,13 @@
+#  Copyright 2020-2024 Robert Bosch GmbH
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.

PrometheusInterface/prometheus_interface.py

@@ -0,0 +1,697 @@
+#  Copyright 2020-2024 Robert Bosch GmbH
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+# XC-HWP/ESW3-Queckenstedt
+
+# -- import standard Python modules
+import pickle, os, time, random
+import dotdict
+
+# -- import Prometheus interface
+from prometheus_client import start_http_server, Gauge, Counter, Info
+
+# -- import Robotframework API
+from robot.api.deco import keyword, library # required when using @keyword, @library decorators
+from robot.libraries.BuiltIn import BuiltIn
+
+# -- import some helpers
+from PythonExtensionsCollection.String.CString import CString
+from PythonExtensionsCollection.Utils.CUtils import *
+
+# --------------------------------------------------------------------------------------------------------------
+# this interface library
+#
+LIBRARY_VERSION      = "0.6.1"
+LIBRARY_VERSION_DATE = "17.06.2024"
+#
+THISMODULENAME = "prometheus_interface.py"
+THISMODULE     = f"{THISMODULENAME} v. {LIBRARY_VERSION} / {LIBRARY_VERSION_DATE}"
+#
+DEFAULT_PORT = 8000
+#
+DEFAULT_MESSAGE_LEVEL = "INFO"
+#
+# --------------------------------------------------------------------------------------------------------------
+# 
+@library
+class prometheus_interface():
+   """The class 'prometheus_interface' provides to communicate with the monitoring system Prometheus.
+For this purpose the 'Prometheus Python client library' is used.
+   """
+
+   ROBOT_AUTO_KEYWORDS   = False # only decorated methods are keywords
+   ROBOT_LIBRARY_VERSION = LIBRARY_VERSION
+   ROBOT_LIBRARY_SCOPE   = 'GLOBAL'
+
+   # --------------------------------------------------------------------------------------------------------------
+   #TM***
+
+   def __init__(self, port_number=DEFAULT_PORT, message_level=DEFAULT_MESSAGE_LEVEL):
+      self.__sMessageLevel = message_level
+      self.__port_number   = port_number
+
+      # prometheus metric types
+      self.__dictCounter = {}
+      self.__dictGauges  = {}
+      self.__dictInfos   = {}
+
+      start_http_server(self.__port_number)
+
+      # default info metric about this interface library
+      oInfo = Info("Prometheus_interface", "Prometheus interface info")
+      dictInfo = {}
+      dictInfo['file name'] = THISMODULENAME
+      dictInfo['version']   = LIBRARY_VERSION
+      dictInfo['date']      = LIBRARY_VERSION_DATE
+      dictInfo['location']  = self.where_am_i()
+      oInfo.info(dictInfo)
+
+
+   def __del__(self):
+      del self.__dictCounter
+      del self.__dictGauges
+      del self.__dictInfos
+
+   # --------------------------------------------------------------------------------------------------------------
+   # -- library informations
+   # --------------------------------------------------------------------------------------------------------------
+   #TM***
+
+   @keyword
+   def get_version(self):
+      """Returns the version of this interface library
+      """
+      return LIBRARY_VERSION
+
+   @keyword
+   def who_am_i(self):
+      """Returns the full name of this interface library
+      """
+      return THISMODULE
+
+   @keyword
+   def where_am_i(self):
+      """Returns path to this interface library
+      """
+      location = CString.NormalizePath(os.path.dirname(os.path.abspath(__file__)))
+      return location
+
+   @keyword
+   def get_port_number(self):
+      """Returns the port number assigned to this instance of the library
+      """
+      return self.__port_number
+
+
+   # --------------------------------------------------------------------------------------------------------------
+   # -- prometheus metric type 'Info'
+   # --------------------------------------------------------------------------------------------------------------
+   #TM***
+
+   @keyword
+   def add_info(self, name=None, description=None, labels=None):
+      """add_info
+      """
+      success = False
+      result  = "UNKNOWN"
+      if name is None:
+         result = "Parameter 'name' not defined"
+         return success, result
+      if description is None:
+         result = "Parameter 'description' not defined"
+         return success, result
+      if name in self.__dictInfos:
+         result = f"An info with name '{name}' is already defined"
+         return success, result
+      oInfo = None
+      if labels is None:
+         oInfo = Info(name, description)
+      else:
+         labellist = labels.split(';')
+         listLabelNames = []
+         for label in labellist:
+            label = label.strip()
+            listLabelNames.append(label)
+         oInfo = Info(name, description, listLabelNames)
+      self.__dictInfos[name] = oInfo
+      success = True
+      listResults = []
+      listResults.append(f"Info '{name}' added")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+
+   @keyword
+   def set_info(self, name=None, info=None, labels=None):
+      """set_info
+      """
+      success = False
+      result  = "UNKNOWN"
+      if name is None:
+         result = "Parameter 'name' not defined"
+         return success, result
+      if info is None:
+         result = "Parameter 'info' not defined"
+         return success, result
+      if name not in self.__dictInfos:
+         result = f"Info '{name}' not defined"
+         return success, result
+      dictInfo = {}
+      list_splitparts = info.split(';')
+      for splitpart in list_splitparts:
+         splitpart = splitpart.strip()
+         list_splitparts2 = splitpart.split(':')
+         if len(list_splitparts2) != 2:
+            success = False
+            result  = "Syntax error in parameter 'info' of '{name}': missing delimiter"
+            return success, result
+         param_name = list_splitparts2[0].strip()
+         if param_name == "":
+            success = False
+            result  = "Syntax error in parameter 'info' of '{name}': parameter name is empty"
+            return success, result
+         param_value = list_splitparts2[1].strip()
+         if param_value == "":
+            success = False
+            result  = "Syntax error in parameter 'info' of '{name}': parameter value is empty"
+            return success, result
+         dictInfo[param_name] = str(param_value)
+      oInfo = self.__dictInfos[name]
+      if labels is None:
+         oInfo.info(dictInfo)
+      else:
+         labellist = labels.split(';')
+         listLabelValues = []
+         for label in labellist:
+            label = label.strip()
+            listLabelValues.append(label)
+         oInfo.labels(*listLabelValues).info(dictInfo)
+      success = True
+      listResults = []
+      listResults.append(f"Info '{name}' set to'{info}'")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+
+
+# TODO lighting reaktivieren (as example)
+
+   # # @keyword
+   # # def add_lighting(self):
+      # # """add_lighting (experimental only)
+      # # """
+      # # self.__oLighting = Info('lighting', ': kind of lighting')
+
+   # # @keyword
+   # # def set_daylight(self):
+      # # """set_daylight (experimental only)
+      # # """
+      # # self.__oLighting.info({'lighting' : 'daylight'})
+
+   # # @keyword
+   # # def set_nightlight(self):
+      # # """set_nightlight (experimental only)
+      # # """
+      # # self.__oLighting.info({'lighting' : 'nightlight'})
+
+
+   # --------------------------------------------------------------------------------------------------------------
+   # -- prometheus metric type 'Counter'
+   # --------------------------------------------------------------------------------------------------------------
+   #TM***
+
+   @keyword
+   def add_counter(self, name=None, description=None, labels=None):
+      """This keyword adds a new counter. The values of existing counters can be changed with ``inc_counter``.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the new counter
+
+  / *Condition*: required / *Type*: str /
+
+* ``description``
+
+  The description of the new counter
+
+  / *Condition*: required / *Type*: str /
+
+* ``labels``
+
+  A semicolon separated list of label names assigned to the new counter
+
+  / *Condition*: optional / *Type*: str  / *Default*: None /
+
+**Returns:**
+
+* ``success``
+
+  / *Type*: bool /
+
+  Indicates if the computation of the keyword was successful or not
+
+* ``result``
+
+  / *Type*: str /
+
+  The result of the computation of the keyword
+      """
+      success = False
+      result  = "UNKNOWN"
+      if name is None:
+         result = "Parameter 'name' not defined"
+         return success, result
+      if description is None:
+         result = "Parameter 'description' not defined"
+         return success, result
+      if name in self.__dictCounter:
+         result = f"A counter with name '{name}' is already defined"
+         return success, result
+      oCounter = None
+      if labels is None:
+         oCounter = Counter(name, description)
+      else:
+         labellist = labels.split(';')
+         listLabelNames = []
+         for label in labellist:
+            label = label.strip()
+            listLabelNames.append(label)
+         oCounter = Counter(name, description, listLabelNames)
+      self.__dictCounter[name] = oCounter
+      success = True
+      listResults = []
+      listResults.append(f"Counter '{name}' added")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def add_counter(...):
+
+   @keyword
+   def inc_counter(self, name=None, value=None, labels=None):
+      """This keyword increments a counter. The counter has to be added with '``add_counter``' before.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the counter
+
+  / *Condition*: required / *Type*: str /
+
+* ``value``
+
+  The value of increment. If not given, the value of the counter is incremented by value 1.
+
+  / *Condition*: optional / *Type*: int  / *Default*: None /
+
+* ``labels``
+
+  A semicolon separated list of labels assigned to the counter. The order of labels must fit to the order of label names like defined in ``add_counter``.
+
+  / *Condition*: optional / *Type*: str  / *Default*: None /
+
+**Returns:**
+
+* ``success``
+
+  / *Type*: bool /
+
+  Indicates if the computation of the keyword was successful or not
+
+* ``result``
+
+  / *Type*: str /
+
+  The result of the computation of the keyword
+      """
+      success = False
+      result  = "UNKNOWN"
+      if name is None:
+         result = "Parameter 'name' not defined"
+         return success, result
+      if name not in self.__dictCounter:
+         result = f"Counter '{name}' not defined"
+         return success, result
+      if value is not None:
+         try:
+            value = int(value)
+         except Exception as ex:
+            success = False
+            result  = str(ex)
+            return success, result
+      oCounter = self.__dictCounter[name]
+      if labels is None:
+         if value is None:
+            oCounter.inc()
+         else:
+            oCounter.inc(value)
+      else:
+         labellist = labels.split(';')
+         listLabelValues = []
+         for label in labellist:
+            label = label.strip()
+            listLabelValues.append(label)
+         if value is None:
+            oCounter.labels(*listLabelValues).inc()
+         else:
+            oCounter.labels(*listLabelValues).inc(value)
+      success = True
+      listResults = []
+      listResults.append(f"Counter '{name}' incremented")
+      if value is not None:
+         listResults.append(f"by value '{value}'")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def inc_counter(...):
+
+
+   # --------------------------------------------------------------------------------------------------------------
+   # -- prometheus metric type 'Gauge'
+   # --------------------------------------------------------------------------------------------------------------
+   #TM***
+
+   @keyword
+   def add_gauge(self, name=None, description=None, labels=None):
+      """This keyword adds a new gauge. The values of existing gauges can be changed with ``set_gauge``, ``inc_gauge`` and ``dec_gauge``.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the new gauge
+
+  / *Condition*: required / *Type*: str /
+
+* ``description``
+
+  The description of the new gauge
+
+  / *Condition*: required / *Type*: str /
+
+* ``labels``
+
+  A semicolon separated list of label names assigned to the new gauge
+
+  / *Condition*: optional / *Type*: str  / *Default*: None /
+
+**Returns:**
+
+* ``success``
+
+  / *Type*: bool /
+
+  Indicates if the computation of the keyword was successful or not
+
+* ``result``
+
+  / *Type*: str /
+
+  The result of the computation of the keyword
+      """
+      success = False
+      result  = "UNKNOWN"
+      if name is None:
+         result = "Parameter 'name' not defined"
+         return success, result
+      if description is None:
+         result = "Parameter 'description' not defined"
+         return success, result
+      if name in self.__dictGauges:
+         result = f"A gauge with name '{name}' is already defined"
+         return success, result
+      oGauge = None
+      if labels is None:
+         oGauge = Gauge(name, description)
+      else:
+         labellist = labels.split(';')
+         listLabelNames = []
+         for label in labellist:
+            label = label.strip()
+            listLabelNames.append(label)
+         oGauge = Gauge(name, description, listLabelNames)
+      self.__dictGauges[name] = oGauge
+      success = True
+      listResults = []
+      listResults.append(f"Gauge '{name}' added")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def add_gauge(...):
+
+   @keyword
+   def set_gauge(self, name=None, value=None, labels=None):
+      """This keyword sets the value for a gauge. The gauge has to be added with '``add_gauge``' before.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the gauge
+
+  / *Condition*: required / *Type*: str /
+
+* ``value``
+
+  The new value of the gauge.
+
+  / *Condition*: optional / *Type*: int  / *Default*: None /
+
+* ``labels``
+
+  A semicolon separated list of labels assigned to the gauge. The order of labels must fit to the order of label names like defined in ``add_gauge``.
+
+  / *Condition*: optional / *Type*: str  / *Default*: None /
+
+**Returns:**
+
+* ``success``
+
+  / *Type*: bool /
+
+  Indicates if the computation of the keyword was successful or not
+
+* ``result``
+
+  / *Type*: str /
+
+  The result of the computation of the keyword
+      """
+      success = False
+      result  = "UNKNOWN"
+      if name is None:
+         result = "Parameter 'name' not defined"
+         return success, result
+      if name not in self.__dictGauges:
+         result = f"Gauge '{name}' not defined"
+         return success, result
+      if value is None:
+         result = "Parameter 'value' not defined"
+         return success, result
+      else:
+         try:
+            value = int(value)
+         except Exception as ex:
+            success = False
+            result  = str(ex)
+            return success, result
+      oGauge = self.__dictGauges[name]
+      if labels is None:
+         oGauge.set(value)
+      else:
+         labellist = labels.split(';')
+         listLabelValues = []
+         for label in labellist:
+            label = label.strip()
+            listLabelValues.append(label)
+         oGauge.labels(*listLabelValues).set(value)
+      success = True
+      listResults = []
+      listResults.append(f"Gauge '{name}' set to value '{value}'")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def set_gauge(...):
+
+   @keyword
+   def inc_gauge(self, name=None, value=None, labels=None):
+      """This keyword increments a gauge. The gauge has to be added with '``add_gauge``' before.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the gauge
+
+  / *Condition*: required / *Type*: str /
+
+* ``value``
+
+  The value of increment. If not given, the value of the gauge is incremented by value 1.
+
+  / *Condition*: optional / *Type*: int  / *Default*: None /
+
+* ``labels``
+
+  A semicolon separated list of labels assigned to the gauge. The order of labels must fit to the order of label names like defined in ``add_gauge``.
+
+  / *Condition*: optional / *Type*: str  / *Default*: None /
+
+**Returns:**
+
+* ``success``
+
+  / *Type*: bool /
+
+  Indicates if the computation of the keyword was successful or not
+
+* ``result``
+
+  / *Type*: str /
+
+  The result of the computation of the keyword
+      """
+      success = False
+      result  = "UNKNOWN"
+      if name is None:
+         result = "Parameter 'name' not defined"
+         return success, result
+      if name not in self.__dictGauges:
+         result = f"Gauge '{name}' not defined"
+         return success, result
+      if value is not None:
+         try:
+            value = int(value)
+         except Exception as ex:
+            success = False
+            result  = str(ex)
+            return success, result
+      oGauge = self.__dictGauges[name]
+      if labels is None:
+         if value is None:
+            oGauge.inc()
+         else:
+            oGauge.inc(value)
+      else:
+         labellist = labels.split(';')
+         listLabelValues = []
+         for label in labellist:
+            label = label.strip()
+            listLabelValues.append(label)
+         if value is None:
+            oGauge.labels(*listLabelValues).inc()
+         else:
+            oGauge.labels(*listLabelValues).inc(value)
+      success = True
+      listResults = []
+      listResults.append(f"Gauge '{name}' incremented")
+      if value is not None:
+         listResults.append(f"by value '{value}'")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def inc_gauge(...):
+
+   @keyword
+   def dec_gauge(self, name=None, value=None, labels=None):
+      """This keyword decrements a gauge. The gauge has to be added with '``add_gauge``' before.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the gauge
+
+  / *Condition*: required / *Type*: str /
+
+* ``value``
+
+  The value of decrement. If not given, the value of the gauge is decremented by value 1.
+
+  / *Condition*: optional / *Type*: int  / *Default*: None /
+
+* ``labels``
+
+  A semicolon separated list of labels assigned to the gauge. The order of labels must fit to the order of label names like defined in ``add_gauge``.
+
+  / *Condition*: optional / *Type*: str  / *Default*: None /
+
+**Returns:**
+
+* ``success``
+
+  / *Type*: bool /
+
+  Indicates if the computation of the keyword was successful or not
+
+* ``result``
+
+  / *Type*: str /
+
+  The result of the computation of the keyword
+      """
+      success = False
+      result  = "UNKNOWN"
+      if name is None:
+         result = "Parameter 'name' not defined"
+         return success, result
+      if name not in self.__dictGauges:
+         result = f"Gauge '{name}' not defined"
+         return success, result
+      if value is not None:
+         try:
+            value = int(value)
+         except Exception as ex:
+            success = False
+            result  = str(ex)
+            return success, result
+      oGauge = self.__dictGauges[name]
+      if labels is None:
+         if value is None:
+            oGauge.dec()
+         else:
+            oGauge.dec(value)
+      else:
+         labellist = labels.split(';')
+         listLabelValues = []
+         for label in labellist:
+            label = label.strip()
+            listLabelValues.append(label)
+         if value is None:
+            oGauge.labels(*listLabelValues).dec()
+         else:
+            oGauge.labels(*listLabelValues).dec(value)
+      success = True
+      listResults = []
+      listResults.append(f"Gauge '{name}' decremented")
+      if value is not None:
+         listResults.append(f"by value '{value}'")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def dec_gauge(...):
+
+
+# eof class prometheus_interface():
+

robotframework_prometheus-0.6.1.dist-info/METADATA

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: robotframework-prometheus
+Version: 0.6.1
+Summary: Additional Robot Framework keywords
+Home-page: https://github.com/test-fullautomation/robotframework-prometheus
+Author: Holger Queckenstedt
+Author-email: Holger.Queckenstedt@de.bosch.com
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Requires-Python: >=3.0
+Description-Content-Type: text/markdown
+Requires-Dist: PythonExtensionsCollection
+Requires-Dist: robotframework
+Requires-Dist: prometheus-client
+
+Package Description
+===================
+
+The interface library **prometheus\_interface** provides Robot Framework
+keywords to communicate with the monitoring system **Prometheus**.
+
+Currently this library is under development. We work on it. But what is
+available up to now, is not ready for being used in productive systems
+(but hopefully will be in near future).
+
+Package Documentation
+---------------------
+
+A (growing) detailed documentation of the **prometheus\_interface** can
+be found here:
+
+[PrometheusInterface.pdf](https://github.com/test-fullautomation/robotframework-prometheus/blob/develop/PrometheusInterface/PrometheusInterface.pdf)
+
+Feedback
+--------
+
+To give us a feedback, you can send an email to [Thomas
+Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
+
+In case you want to report a bug or request any interesting feature,
+please don\'t hesitate to raise a ticket.
+
+Maintainers
+-----------
+
+[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
+
+[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
+
+Contributors
+------------
+
+[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
+
+[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
+
+License
+-------
+
+Copyright 2020-2024 Robert Bosch GmbH
+
+Licensed under the Apache License, Version 2.0 (the \"License\"); you
+may not use this file except in compliance with the License. You may
+obtain a copy of the License at
+
+> [![License: Apache
+> v2](https://img.shields.io/pypi/l/robotframework.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an \"AS IS\" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+

robotframework_prometheus-0.6.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+PrometheusInterface/PrometheusInterface.pdf,sha256=Xzg5DBtrZA9Q-i04BCIrqVJe_UnOl5fW27SuVJxf2dw,180306
+PrometheusInterface/__init__.py,sha256=a6qP310WpO1pwWYLuGFyhneeD55p6HV4VlQ7RdK4Brw,596
+PrometheusInterface/prometheus_interface.py,sha256=F3hUwtHKB0AS-U-HP0iN9Y3nWR60gKzexxy3dBh9eYY,20642
+robotframework_prometheus-0.6.1.dist-info/METADATA,sha256=jfgeeiqiv5Nw6hh-mUDZolhfbc7_Vv2kyaeyoFvEryE,2622
+robotframework_prometheus-0.6.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+robotframework_prometheus-0.6.1.dist-info/top_level.txt,sha256=_cYDLZTXj9irWAxJ-QgVzFL6xBb9lysGFWiwP9vSvHw,20
+robotframework_prometheus-0.6.1.dist-info/RECORD,,

robotframework_prometheus-0.6.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

robotframework_prometheus-0.6.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+PrometheusInterface