robotframework-prometheus 0.6.1__tar.gz → 0.9.0__tar.gz

robotframework_prometheus-0.9.0/MANIFEST.in

@@ -0,0 +1 @@
+include build_backend.py

robotframework_prometheus-0.9.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: robotframework-prometheus
+Version: 0.9.0
+Summary: Robot Framework keywords to communicate with the monitoring system Prometheus
+Author-email: Holger Queckenstedt <Holger.Queckenstedt@de.bosch.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://pypi.org/project/robotframework-prometheus/
+Project-URL: Documentation, https://github.com/test-fullautomation/robotframework-prometheus/blob/develop/PrometheusInterface/PrometheusInterface.pdf
+Project-URL: Readme, https://github.com/test-fullautomation/robotframework-prometheus/blob/develop/README.rst
+Project-URL: Repository, https://github.com/test-fullautomation/robotframework-prometheus
+Project-URL: Issues, https://github.com/test-fullautomation/robotframework-prometheus/issues
+Keywords: robotframework,stringfunctions
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+Requires-Dist: robotframework>=6.1
+Requires-Dist: colorama
+Requires-Dist: prometheus-client
+Requires-Dist: GenPackageDoc
+Requires-Dist: PythonExtensionsCollection
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: docutils>=0.22.4; extra == "docs"
+
+.. Copyright 2020-2026 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.
+
+Package Description
+===================
+
+The interface library **robotframework-prometheus** provides Robot Framework keywords to communicate with the monitoring system **Prometheus**.
+
+How to install
+--------------
+
+The interface library **robotframework-prometheus** can be installed in two different ways.
+
+1. Installation via PyPi (recommended for users)
+
+   .. code::
+
+      pip install robotframework-prometheus
+
+   `robotframework-prometheus in PyPi <https://pypi.org/project/robotframework-prometheus/>`_
+
+2. Installation via GitHub (recommended for developers)
+
+   * Clone the **robotframework-prometheus** repository to your machine.
+
+     .. code::
+
+        git clone https://github.com/test-fullautomation/robotframework-prometheus.git
+
+     `robotframework-prometheus in GitHub <https://github.com/test-fullautomation/robotframework-prometheus>`_
+
+   * Use the following command to install **robotframework-prometheus** (executed in repository main folder):
+
+     .. code::
+
+        python -m pip install .
+
+     Or:
+
+     .. code::
+
+        python -m pip install --proxy <proxy> .
+
+     This command will also download and install all dependencies that are required to work with the source files in the current repository.
+     After the initial installation of **robotframework-prometheus** is done, you have the following two possibilities:
+
+     1. *Clean the previous installation*:
+
+        .. code::
+
+           python "./cleanup_installation.py"
+
+        ``cleanup_installation.py`` explicitly deletes all files and folders within the component installation folder under
+        ``site-packages`` and also deletes local build artefacts.
+
+     2. *Render the component documentation*:
+
+        .. code::
+
+           python "./genpackagedoc.py"
+
+        This would e.g. be required in case of changes in the interface of **robotframework-prometheus**.
+
+        The documentation is rendered by a separate application called **GenPackageDoc**, that is part
+        of the build dependencies and runtime dependencies of **robotframework-prometheus**.
+
+        **GenPackageDoc** needs to be configured. Details about how to do this, can be found in the
+        `README.rst <https://github.com/test-fullautomation/python-genpackagedoc/blob/develop/README.rst>`_
+        (sections *Install dependencies* and *Configure dependencies*).
+
+   * Use the following command to build **robotframework-prometheus** (executed in repository main folder):
+
+     .. code::
+
+        python -m build .
+
+     Or:
+
+     .. code::
+
+        python -m pip config set global.proxy <proxy>
+        python -m build .
+
+
+Package Documentation
+---------------------
+
+A 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-2026 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|
+
+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.
+
+
+.. |License: Apache v2| image:: https://img.shields.io/pypi/l/robotframework.svg
+   :target: http://www.apache.org/licenses/LICENSE-2.0.html

{robotframework-prometheus-0.6.1 → robotframework_prometheus-0.9.0}/PrometheusInterface/__init__.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2024 Robert Bosch GmbH
+#  Copyright 2020-2026 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.

{robotframework-prometheus-0.6.1 → robotframework_prometheus-0.9.0}/PrometheusInterface/prometheus_interface.py

@@ -1,4 +1,4 @@
-#  Copyright 2020-2024 Robert Bosch GmbH
+#  Copyright 2020-2026 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.
@@ -19,7 +19,7 @@ import pickle, os, time, random
 import dotdict
 
 # -- import Prometheus interface
-from prometheus_client import start_http_server, Gauge, Counter, Info
+from prometheus_client import start_http_server, Gauge, Counter, Info, Summary, Histogram
 
 # -- import Robotframework API
 from robot.api.deco import keyword, library # required when using @keyword, @library decorators
@@ -32,8 +32,8 @@ from PythonExtensionsCollection.Utils.CUtils import *
 # --------------------------------------------------------------------------------------------------------------
 # this interface library
 #
-LIBRARY_VERSION      = "0.6.1"
-LIBRARY_VERSION_DATE = "17.06.2024"
+LIBRARY_VERSION      = "0.9.0"
+LIBRARY_VERSION_DATE = "23.02.2026"
 #
 THISMODULENAME = "prometheus_interface.py"
 THISMODULE     = f"{THISMODULENAME} v. {LIBRARY_VERSION} / {LIBRARY_VERSION_DATE}"
@@ -62,16 +62,18 @@ For this purpose the 'Prometheus Python client library' is used.
       self.__port_number   = port_number
 
       # prometheus metric types
-      self.__dictCounter = {}
-      self.__dictGauges  = {}
-      self.__dictInfos   = {}
+      self.__dictCounter    = {}
+      self.__dictGauges     = {}
+      self.__dictInfos      = {}
+      self.__dictSummaries  = {}
+      self.__dictHistograms = {}
 
       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['file_name'] = THISMODULENAME
       dictInfo['version']   = LIBRARY_VERSION
       dictInfo['date']      = LIBRARY_VERSION_DATE
       dictInfo['location']  = self.where_am_i()
@@ -82,6 +84,24 @@ For this purpose the 'Prometheus Python client library' is used.
       del self.__dictCounter
       del self.__dictGauges
       del self.__dictInfos
+      del self.__dictSummaries
+
+   # --------------------------------------------------------------------------------------------------------------
+
+   def convert_to_int_or_float(self, value):
+      """Little helper to convert a string value to an integer or a float
+      """
+      try:
+         converted_value = int(value)
+         return converted_value # is int
+      except ValueError:
+         pass
+      try:
+         converted_value = float(value)
+         return converted_value # is float
+      except ValueError:
+         pass
+      return None # not int and not float
 
    # --------------------------------------------------------------------------------------------------------------
    # -- library informations
@@ -121,7 +141,41 @@ For this purpose the 'Prometheus Python client library' is used.
 
    @keyword
    def add_info(self, name=None, description=None, labels=None):
-      """add_info
+      """This keyword adds a new info. The content of an existing info can be defined with ``set_info``.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the new info
+
+  / *Condition*: required / *Type*: str /
+
+* ``description``
+
+  The description of the new info
+
+  / *Condition*: required / *Type*: str /
+
+* ``labels``
+
+  A semicolon separated list of label names assigned to the new info
+
+  / *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"
@@ -155,7 +209,41 @@ For this purpose the 'Prometheus Python client library' is used.
 
    @keyword
    def set_info(self, name=None, info=None, labels=None):
-      """set_info
+      """This keyword defines the content of an info. The info has to be added with '``add_info``' before.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the info
+
+  / *Condition*: required / *Type*: str /
+
+* ``info``
+
+  The info itself (every info is a key-value information).
+
+  / *Condition*: required / *Type*: dict /
+
+* ``labels``
+
+  A semicolon separated list of labels assigned to the info. The order of labels must fit to the order of label names like defined in ``add_info``.
+
+  / *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"
@@ -207,27 +295,6 @@ For this purpose the 'Prometheus Python client library' is used.
       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'
    # --------------------------------------------------------------------------------------------------------------
@@ -693,5 +760,302 @@ For this purpose the 'Prometheus Python client library' is used.
    # eof def dec_gauge(...):
 
 
+   # --------------------------------------------------------------------------------------------------------------
+   # -- prometheus metric type 'Summary'
+   # --------------------------------------------------------------------------------------------------------------
+   #TM***
+
+   @keyword
+   def add_summary(self, name=None, description=None, labels=None):
+      """This keyword adds a new summary. The values of existing summaries can be set with ``observe_summary```.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the new summary
+
+  / *Condition*: required / *Type*: str /
+
+* ``description``
+
+  The description of the new summary
+
+  / *Condition*: required / *Type*: str /
+
+* ``labels``
+
+  A semicolon separated list of label names assigned to the new summary
+
+  / *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.__dictSummaries:
+         result = f"A summary with name '{name}' is already defined"
+         return success, result
+      oSummary = None
+      if labels is None:
+         oSummary = Summary(name, description)
+      else:
+         labellist = labels.split(';')
+         listLabelNames = []
+         for label in labellist:
+            label = label.strip()
+            listLabelNames.append(label)
+         oSummary = Summary(name, description, listLabelNames)
+      self.__dictSummaries[name] = oSummary
+      success = True
+      listResults = []
+      listResults.append(f"Summary '{name}' added")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def add_summary(...):
+
+   @keyword
+   def observe_summary(self, name=None, value=None, labels=None):
+      """This keyword observes a summary. The summary has to be added with '``add_summary``' before.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the summary
+
+  / *Condition*: required / *Type*: str /
+
+* ``value``
+
+  The value assigned to the summary.
+
+  / *Condition*: required / *Type*: int or float /
+
+* ``labels``
+
+  A semicolon separated list of labels assigned to the summary. The order of labels must fit to the order of label names like defined in ``add_summary``.
+
+  / *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 value is None:
+         result = "Parameter 'value' not defined"
+         return success, result
+      value_type = type(value)
+      value = self.convert_to_int_or_float(value)
+      if value is None:
+         success = False
+         result  = f"invalid type '{value_type}' of input parameter 'value'; expected int or float"
+         return success, result
+      if name not in self.__dictSummaries:
+         result = f"Summary '{name}' not defined"
+         return success, result
+      oSummary = self.__dictSummaries[name]
+      if labels is None:
+         oSummary.observe(value)
+      else:
+         labellist = labels.split(';')
+         listLabelValues = []
+         for label in labellist:
+            label = label.strip()
+            listLabelValues.append(label)
+         oSummary.labels(*listLabelValues).observe(value)
+      success = True
+      listResults = []
+      listResults.append(f"Summary '{name}' observed value {value}")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def observe_summary(...):
+
+
+   # --------------------------------------------------------------------------------------------------------------
+   # -- prometheus metric type 'Histogram'
+   # --------------------------------------------------------------------------------------------------------------
+   #TM***
+
+   @keyword
+   def add_histogram(self, name=None, description=None, labels=None):
+      """This keyword adds a new histogram. The values of existing histograms can be set with ``observe_histogram```.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the new histogram
+
+  / *Condition*: required / *Type*: str /
+
+* ``description``
+
+  The description of the new histogram
+
+  / *Condition*: required / *Type*: str /
+
+* ``labels``
+
+  A semicolon separated list of label names assigned to the new histogram
+
+  / *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.__dictHistograms:
+         result = f"A histogram with name '{name}' is already defined"
+         return success, result
+      oHistogram = None
+      if labels is None:
+         oHistogram = Histogram(name, description)
+      else:
+         labellist = labels.split(';')
+         listLabelNames = []
+         for label in labellist:
+            label = label.strip()
+            listLabelNames.append(label)
+         oHistogram = Histogram(name, description, listLabelNames)
+      self.__dictHistograms[name] = oHistogram
+      success = True
+      listResults = []
+      listResults.append(f"Summary '{name}' added")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def add_histogram(...):
+
+   @keyword
+   def observe_histogram(self, name=None, value=None, labels=None):
+      """This keyword observes a histogram. The histogram has to be added with '``add_histogram``' before.
+
+**Arguments:**
+
+* ``name``
+
+  The name of the histogram
+
+  / *Condition*: required / *Type*: str /
+
+* ``value``
+
+  The value assigned to the histogram.
+
+  / *Condition*: required / *Type*: int or float /
+
+* ``labels``
+
+  A semicolon separated list of labels assigned to the histogram. The order of labels must fit to the order of label names like defined in ``add_histogram``.
+
+  / *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 value is None:
+         result = "Parameter 'value' not defined"
+         return success, result
+      value_type = type(value)
+      value = self.convert_to_int_or_float(value)
+      if value is None:
+         success = False
+         result  = f"invalid type '{value_type}' of input parameter 'value'; expected int or float"
+         return success, result
+      if name not in self.__dictHistograms:
+         result = f"Histogram '{name}' not defined"
+         return success, result
+      oHistogram = self.__dictHistograms[name]
+      if labels is None:
+         oHistogram.observe(value)
+      else:
+         labellist = labels.split(';')
+         listLabelValues = []
+         for label in labellist:
+            label = label.strip()
+            listLabelValues.append(label)
+         oHistogram.labels(*listLabelValues).observe(value)
+      success = True
+      listResults = []
+      listResults.append(f"Histogram '{name}' observed value {value}")
+      if labels is not None:
+         listResults.append(f"with labels: '{labels}'")
+      result = " ".join(listResults)
+      return success, result
+   # eof def observe_histogram(...):
+
 # eof class prometheus_interface():