perun.backend.powercap_rapl
===========================

.. py:module:: perun.backend.powercap_rapl

.. autoapi-nested-parse::

   Defines Intel RAPL related classes.



Attributes
----------

.. autoapisummary::

   perun.backend.powercap_rapl.log
   perun.backend.powercap_rapl.RAPL_PATH
   perun.backend.powercap_rapl.DIR_RGX
   perun.backend.powercap_rapl.SUBDIR_RGX


Classes
-------

.. autoapisummary::

   perun.backend.powercap_rapl.PowercapRAPLBackend


Module Contents
---------------

.. py:data:: log

.. py:data:: RAPL_PATH
   :value: '/sys/class/powercap/'


.. py:data:: DIR_RGX
   :value: 'intel-rapl:(\\d)$'


.. py:data:: SUBDIR_RGX
   :value: 'intel-rapl:\\d:\\d$'


.. py:class:: PowercapRAPLBackend

   Bases: :py:obj:`perun.backend.backend.Backend`


   Powercap RAPL as a source of cpu and memory devices.

   Uses the powercap filesystem files to gather device information and creates metrics for each available device


   .. py:attribute:: id
      :value: 'powercap_rapl'



   .. py:attribute:: name
      :value: 'Powercap RAPL'



   .. py:attribute:: description
      :value: 'Reads energy usage from CPUs and DRAM using Powercap RAPL'



   .. py:method:: setup() -> None

      Check Intel RAPL access.



   .. py:method:: close() -> None

      Backend shutdown code (does nothing for intel rapl).



   .. py:method:: availableSensors() -> dict[str, tuple]

      Return string id set of visible devices.

      :returns: Set with visible device ids.
      :rtype: set[str]



   .. py:method:: getSensors(deviceList: set[str]) -> list[perun.data_model.sensor.Sensor]

      Gather device objects based on a set of device ids.

      :param deviceList: Set of device ids.
      :type deviceList: set[str]

      :returns: Device objects.
      :rtype: list[Sensor]