Command Line Documentation

epicsarchiver

Command line tool for interacting with the archiver.

epicsarchiver [OPTIONS] COMMAND [ARGS]...

Options

--version: Show the version and exit.

-h, --hostname <hostname>: Achiver Appliance hostname or IP [default: localhost]

Environment variables

EPICSARCHIVER_HOSTNAME: Provide a default for --hostname

get

Print out data from an archiver cluster.

ARGUMENT pvs What pvs to get data of.

Example usage:

epicsarchiver --hostname archiver-01.example.com get PV_NAME1 PV_NAME2

epicsarchiver get [OPTIONS] PVS...

Options

--debug

Turn on debug logging

Default:: False

-s, --start <start>: Start time of query [default: 30 seconds ago]

-e, --end <end>: End time of query, [default: now]

-p, --processor-name <processor_name>

PreProcessor to use

Docs at https://epicsarchiver.readthedocs.io/en/latest/user/userguide.html#processing-of-data

Options:: FIRSTSAMPLE | LASTSAMPLE | FIRSTFILL | LASTFILL | MEAN | MIN | MAX | COUNT | NCOUNT | NTH | MEDIAN | STD | JITTER | IGNOREFLYERS | FLYERS | VARIANCE | POPVARIANCE | KURTOSIS | SKEWNESS | LINEAR | LOESS | OPTIMIZED | OPTIMLASTSAMPLE | CAPLOTBINNING | DEADBAND | ERRORBAR

-b, --bin_size <bin_size>: Bin size (mostly in seconds) for preprocessor.

Arguments

PVS: Required argument(s)

ioc-check

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

ARGUMENT IOC Name of IOC to check

epicsarchiver ioc-check [OPTIONS] IOC

Options

--debug

Turn on debug logging

Default:: False

-cf, --channelfinder <channelfinder>: Channel Finder hostname or IP [default: channelfinder.tn.esss.lu.se]

-d, --config-gitlab-repo <config_gitlab_repo>: Gitlab repo for files with lists of PVs

--config-archiver-alias <config_archiver_alias>

Alias of the Archiver cluster chosen via info tag in IOC Record

Options:: tn | nin | lab

-mb, --mb-per-day-minimum <mb_per_day_minimum>: Minimum storage rate in MB/day

Arguments

IOC: Required argument

stats

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:

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

epicsarchiver stats [OPTIONS] OUTPUT

Options

--debug

Turn on debug logging

Default:: False

-l, --limit <limit>: Limit size of queries

-o, --other_hostname <other_hostname>: Other Archiver Appliance hostname or IP [default: localhost]

-cf, --channelfinder <channelfinder>: Channel Finder hostname or IP [default: channelfinder.tn.esss.lu.se]

-t, --time-minimum <time_minimum>: Minimum time since last disconnect in days.

-mb, --mb-per-day-minimum <mb_per_day_minimum>: Minimum storage rate in MB/day

-c, --connection-drops-minimum <connection_drops_minimum>: Minimum connection drops to see.

-edm, --events-dropped-minimum <events_dropped_minimum>: Minimum event drops to see.

-i, --ioc <ioc>: IOC to filter by.

-v, --verbose: Verbose output

-d, --config-gitlab-repo <config_gitlab_repo>: Gitlab repo for files with lists of PVs

--config-archiver-alias <config_archiver_alias>

Alias of the Archiver cluster chosen via info tag in IOC Record

Options:: tn | nin | lab

Arguments

OUTPUT: Required argument