epicsarchiver.statistics.command
================================

.. py:module:: epicsarchiver.statistics.command

.. autoapi-nested-parse::

   Command module for Archiver Statistics.



Attributes
----------

.. autoapisummary::

   epicsarchiver.statistics.command.LOG
   epicsarchiver.statistics.command.ARCHIVER_ALIASES


Functions
---------

.. autoapisummary::

   epicsarchiver.statistics.command.stats
   epicsarchiver.statistics.command.ioc_check


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

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

.. py:data:: ARCHIVER_ALIASES
   :value: ['tn', 'nin', 'lab']


.. py:function:: stats(ctx: click.core.Context, limit: int, other_hostname: str | None, time_minimum: int, connection_drops_minimum: int, config_gitlab_repo: pathlib.Path | None, config_archiver_alias: str | None, mb_per_day_minimum: float, events_dropped_minimum: int, channelfinder: str, ioc: str | None, verbose: bool, output: pathlib.Path, debug: bool) -> None

   Print out statistics from an archiver cluster.

   ARGUMENT output Where to print output detailed statistics.

   Includes PVs that are often dropping events, long disconnected, producing no events
   and not configured. Example usage:

   .. code-block:: console

       epicsarchiver --hostname archiver-01.example.com stats output.csv

   By default produces a csv output in the form

   IOC Name, IOC hostname, PV name, Statistic, Statistic Note
   IOC_NAME, PV:NAME, BufferOverflow, Dropped 33393 events by BufferOverflow



.. py:function:: ioc_check(ctx: click.core.Context, ioc: str, config_gitlab_repo: pathlib.Path | None, config_archiver_alias: str | None, mb_per_day_minimum: float, channelfinder: str, debug: bool) -> None

   Print out statistics of a single IOC from an archiver cluster.

   ARGUMENT IOC Name of IOC to check