epicsarchiver.statistics.reports.ioc_report
===========================================

.. py:module:: epicsarchiver.statistics.reports.ioc_report

.. autoapi-nested-parse::

   Generate a report detailing a list of statistics of Archiver pvs from an IOC.

   .. rubric:: Examples

   .. code-block:: python

       ioc_report = IocReport(
           "IOC_NAME",
           ChannelFinder("channelfinder.example.org"),
           ArchiverWrapper("archiver.example.org"),
           100,  # mb_per_day_minimum
           configuration.ConfigOptions("/config_repo", "tn"),
       )
       ioc_report.print_report()



Attributes
----------

.. autoapisummary::

   epicsarchiver.statistics.reports.ioc_report.LOG


Classes
-------

.. autoapisummary::

   epicsarchiver.statistics.reports.ioc_report.IocReport


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

.. py:data:: LOG
   :type:  logging.Logger

.. py:class:: IocReport

   Data for generating a report about an ioc connection to archiver.

   :param ioc_name: Name of ioc
   :type ioc_name: str
   :param channelfinder: Channelfinder to get pv info of ioc
   :type channelfinder: ChannelFinder
   :param archiver: Archiver to check
   :type archiver: ArchiverWrapper
   :param mb_per_day_minimum: Minimum mb per day to filter on storage statistics
   :type mb_per_day_minimum: float
   :param config_options: configuration options
   :type config_options: configuration.ConfigOptions | None


   .. py:attribute:: ioc_name
      :type:  str


   .. py:attribute:: channelfinder
      :type:  epicsarchiver.statistics.services.channelfinder.ChannelFinder


   .. py:attribute:: archiver
      :type:  epicsarchiver.statistics.services.archiver_statistics.ArchiverWrapper


   .. py:attribute:: mb_per_day_minimum
      :type:  float


   .. py:attribute:: config_options
      :type:  epicsarchiver.statistics.configuration.ConfigOptions | None


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

      Print report about the statistics of connections from IOC to archiver.



   .. py:method:: generate() -> dict[epicsarchiver.statistics.models.stat_responses.Ioc, dict[str, epicsarchiver.statistics.models.stats.PVStats]]
      :async:


      Generate all the statistics data for an ioc.

      :returns: statistics list
      :rtype: dict[Ioc, dict[str, _PVStats]]



   .. py:method:: _check_not_configured(pv_names: set[str], pv_details: dict[str, epicsarchiver.statistics.models.stats.PVStats], config_options: epicsarchiver.statistics.configuration.ConfigOptions) -> None
      :async:



   .. py:method:: _get_archived_pvs_details(pv_names: set[str]) -> dict[str, epicsarchiver.statistics.models.stats.PVStats]
      :async: