epicsarchiver.statistics.reports.ioc_report

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

Examples

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

LOG

Classes

IocReport

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

Module Contents

epicsarchiver.statistics.reports.ioc_report.LOG: logging.Logger[source]

class epicsarchiver.statistics.reports.ioc_report.IocReport[source]

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

Parameters:

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

ioc_name: str[source]

channelfinder: epicsarchiver.statistics.services.channelfinder.ChannelFinder[source]

archiver: epicsarchiver.statistics.services.archiver_statistics.ArchiverWrapper[source]

mb_per_day_minimum: float[source]

config_options: epicsarchiver.statistics.configuration.ConfigOptions | None[source]

print_report() → None[source]: Print report about the statistics of connections from IOC to archiver.

async generate() → dict[epicsarchiver.statistics.models.stat_responses.Ioc, dict[str, epicsarchiver.statistics.models.stats.PVStats]][source]

Generate all the statistics data for an ioc.

Returns:: statistics list
Return type:: dict[Ioc, dict[str, _PVStats]]

async _check_not_configured(pv_names: set[str], pv_details: dict[str, epicsarchiver.statistics.models.stats.PVStats], config_options: epicsarchiver.statistics.configuration.ConfigOptions) → None[source]

async _get_archived_pvs_details(pv_names: set[str]) → dict[str, epicsarchiver.statistics.models.stats.PVStats][source]