epicsarchiver.statistics.models.pv_details

Handles the PVDetails report per PV from the Archiver.

Classes

DetailEnum	Enum of detail types present in the archiver per PV.
Details	Representation of the response from the pvDetails endpoint in archiver.

Functions

_dropped_pv_response(...)

Module Contents

class epicsarchiver.statistics.models.pv_details.DetailEnum

Bases: str, enum.Enum

Enum of detail types present in the archiver per PV.

PVName = 'PV Name'

DBRType = 'Archiver DBR type (from typeinfo):'

PVAccess = 'Are we using PVAccess?'

Method = 'Sampling method:'

Period = 'Sampling period:'

Capacity = 'Sample buffer capacity'

EventRate = 'Estimated event rate (events/sec)'

EventsLost = 'How many events lost totally so far?'

TotalEvents = 'How many events so far?'

Connnected = 'Is this PV currently connected?'

LastLostConnection = 'When did we last lose a connection to this PV?'

LostConnections = 'How many times have we lost and regained the connection to this PV?'

LostEventsTimestamp = 'How many events lost because the timestamp is in the far future or past so far?'

LostEventsBuffer = 'How many events lost because the sample buffer is full so far?'

LostEventsType = 'How many events lost because the DBR_Type of the PV has changed from what it used to be?'

MBStorageRate = 'Estimated storage rate (MB/day)'

LastEvent = 'When did we receive the last event?'

Hostname = 'Hostname of PV from CA'

Instance = 'Instance archiving PV'

CommandThread = 'The CAJ command thread id'

classmethod from_str(desc: str) → DetailEnum | None

Convert from a string to DetailEnum.

Parameters:

desc (str) – input string

Returns:

An enum representation.

Return type:

DetailEnum | None

epicsarchiver.statistics.models.pv_details._dropped_pv_response(pv_name: str, value: str, reason: epicsarchiver.statistics.models.stat_responses.DroppedReason, stat: epicsarchiver.statistics.models.stats.Stat) → tuple[epicsarchiver.statistics.models.stats.Stat, epicsarchiver.statistics.models.stat_responses.DroppedPVResponse] | None

class epicsarchiver.statistics.models.pv_details.Details

Bases: Dict[DetailEnum, str]

Representation of the response from the pvDetails endpoint in archiver.

classmethod from_json(json: list[dict[str, str]]) → Details

Convert from the json representation at the Archiver Endpoint.

Takes some of the details which are relevant for reports to create Details.

Parameters:

json (list[dict[str, str]]) – input json

Returns:

dictionary of DetailEnum to string value.

Return type:

Details

to_base_responses(mb_per_day_min: float = 0) → dict[epicsarchiver.statistics.models.stats.Stat, epicsarchiver.statistics.models.stat_responses.BaseStatResponse]

Convert to a BaseStatResponse dict to match Generic Archiver Statistics.

Parameters:

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

Returns:

Stat to BaseStatResponse output

Return type:

dict[Stat, BaseStatResponse]

detail_to_base_response(detail_enum: DetailEnum, value: str, mb_per_day_min: float = 0) → tuple[epicsarchiver.statistics.models.stats.Stat, epicsarchiver.statistics.models.stat_responses.BaseStatResponse] | None

Convert a single detail to a Stat and BaseStatResponse.

Parameters:

• detail_enum (DetailEnum) – Detail

• value (str) – String value of the detail

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

Returns:

Output

Return type:

tuple[Stat, BaseStatResponse] | None