eventlog

Name

eventlog -- Record Event Data to Disk.

Synopsis

eventlog [options...]

DESCRIPTION

Records event data verbatim from ring buffers to disk files. The program monitors the source ring buffer for a begin run item. At that point it opens an event file for that run and begins to record data from the ring.

Runs are recorded in files in the target directory. Event files are named run-runnumber-segment.evt where runnumber is the run number of the run taken from the begin run item, segment is a file segment numbered from zero.

Runs are segmented in file that are no larger than a segment size. This is done to avoid creating files that are too large for a file system to handle or too large for NFS to accurately serve.

An option allows the program to be started by a controlling program for a single run (e.g. by the readout GUI).

Options have sensible defaults. See OPTIONS below.

OPTIONS

--source=ringuri

Defines the event source as a Ring buffer Uniform Resource Identifier (URI). The URI can be for a local or a remote ring buffer. By default the ring: tcp://localhost/username where username is the username of the account running the program.

--path=dir

Provides the path to the directory in which the program will write its event files. By default, this is current working directory at the time eventlog is started.

eventlog ensures that the path is a directory and is writable.

--segmentsize=size-spec

Specifies the size of the files segments created. size-spec can be any of an integer number of bytes or an integer followed by one of the suffixes: g, m, k that multiply the integer by a gigabyte, a megabyte and a kilobyte repsectively.

The default value is a 1900m, which should be suitable for most operating environments.

--oneshot

When present, the program only records a single run, then exits. The program will also create the .started file in the target directory when it's ready to record data, and the .exited file when it's about to exit.