epicsarchiver.statistics.services.archiver_statistics

Archiver Statistics Service.

Classes

ArchiverStatistics	Responses from the reports of the archiver appliance.
ArchiverWrapper	Wrapper around ArchiverStatistics and ArchiverMgmt for Statistics usage.

Module Contents

class epicsarchiver.statistics.services.archiver_statistics.ArchiverStatistics(hostname: str = 'localhost', port: int = 17665)

Bases: epicsarchiver.common.async_service.ServiceClient

Responses from the reports of the archiver appliance.

hostname = 'localhost'

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

Gets the pvs ordered by dropped events.

Returns:

List of responses

Return type:

list[DroppedPVResponse]

async get_disconnected_pvs() → list[epicsarchiver.statistics.models.stat_responses.DisconnectedPVsResponse]

Gets the list of disconnected pvs.

Returns:

List of responses

Return type:

list[DisconnectedPVsResponse]

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

Gets the list of pvs with no events.

Returns:

List of responses

Return type:

list[SilentPVsResponse]

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

Gets the list of pvs with no events.

Returns:

List of responses

Return type:

list[LostConnectionsResponse]

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

Gets the list of pvs with no events.

Returns:

List of responses

Return type:

list[StorageRatesResponse]

async get_paused_pvs() → list[epicsarchiver.statistics.models.stat_responses.PausedPVResponse]

Gets the list of paused pvs.

Returns:

List of responses

Return type:

list[PausedPVResponse]

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

Return the details of a PV.

Parameters:

• pvs (list[str]) – names of the pvs for which the details are to be determined.

• mb_per_day_min (float) – Minimum MB per day to filter by

Returns:

list of dict with the details of the matching PVs

class epicsarchiver.statistics.services.archiver_statistics.ArchiverWrapper(hostname: str = 'localhost', port: int = 17665)

Wrapper around ArchiverStatistics and ArchiverMgmt for Statistics usage.

mgmt

stats

async close() → None

Closes any connected sessions.

__repr__() → str

String representation of ArchiverWrapper.

Returns:

ouput string

Return type:

str