epicsarchiver.statistics.services.archiver_statistics
=====================================================

.. py:module:: epicsarchiver.statistics.services.archiver_statistics

.. autoapi-nested-parse::

   Archiver Statistics Service.



Classes
-------

.. autoapisummary::

   epicsarchiver.statistics.services.archiver_statistics.ArchiverStatistics
   epicsarchiver.statistics.services.archiver_statistics.ArchiverWrapper


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

.. py:class:: ArchiverStatistics(hostname: str = 'localhost', port: int = 17665)

   Bases: :py:obj:`epicsarchiver.common.async_service.ServiceClient`


   Responses from the reports of the archiver appliance.


   .. py:attribute:: hostname
      :value: 'localhost'



   .. py:method:: get_pvs_dropped(reason: epicsarchiver.statistics.models.stat_responses.DroppedReason, limit: int | None = 1000) -> list[epicsarchiver.statistics.models.stat_responses.DroppedPVResponse]
      :async:


      Gets the pvs ordered by dropped events.

      :returns: List of responses
      :rtype: list[DroppedPVResponse]



   .. py:method:: get_disconnected_pvs() -> list[epicsarchiver.statistics.models.stat_responses.DisconnectedPVsResponse]
      :async:


      Gets the list of disconnected pvs.

      :returns: List of responses
      :rtype: list[DisconnectedPVsResponse]



   .. py:method:: get_silent_pvs(limit: int | None = 1000) -> list[epicsarchiver.statistics.models.stat_responses.SilentPVsResponse]
      :async:


      Gets the list of pvs with no events.

      :returns: List of responses
      :rtype: list[SilentPVsResponse]



   .. py:method:: get_lost_connections_pvs(limit: int | None = 1000) -> list[epicsarchiver.statistics.models.stat_responses.LostConnectionsResponse]
      :async:


      Gets the list of pvs with no events.

      :returns: List of responses
      :rtype: list[LostConnectionsResponse]



   .. py:method:: get_storage_rates(limit: int | None = 1000) -> list[epicsarchiver.statistics.models.stat_responses.StorageRatesResponse]
      :async:


      Gets the list of pvs with no events.

      :returns: List of responses
      :rtype: list[StorageRatesResponse]



   .. py:method:: get_paused_pvs() -> list[epicsarchiver.statistics.models.stat_responses.PausedPVResponse]
      :async:


      Gets the list of paused pvs.

      :returns: List of responses
      :rtype: list[PausedPVResponse]



   .. py:method:: get_pv_details(pvs: list[str], mb_per_day_min: float = 0) -> dict[str, epicsarchiver.statistics.models.stats.PVStats]
      :async:


      Return the details of a PV.

      :param pvs: names of the pvs for which the details are to be
                  determined.
      :type pvs: list[str]
      :param mb_per_day_min: Minimum MB per day to filter by
      :type mb_per_day_min: float

      :returns: list of dict with the details of the matching PVs



.. py:class:: ArchiverWrapper(hostname: str = 'localhost', port: int = 17665)

   Wrapper around ArchiverStatistics and ArchiverMgmt for Statistics usage.


   .. py:attribute:: mgmt


   .. py:attribute:: stats


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


      Closes any connected sessions.



   .. py:method:: __repr__() -> str

      String representation of ArchiverWrapper.

      :returns: ouput string
      :rtype: str