epadmin-record

epadmin record target — Creates an old format EventFlow feed simulation by recording a module's input streams.

SYNOPSIS

epadmin [globalparameters] command record [commandparameters]

DESCRIPTION

Use the record target to create an EventFlow feed simulation by recording a running module's input streams. This is most useful to record a module's actual live incoming data, or to record a sequence of manual input tuples.

Important

Feed simulation files created by this command can only be played back with the sbfeedsim-old command.

The feed simulation file created by epadmin record is in an older format that is not compatible with the epadmin playback or legacy sbfeedsim commands, and is not compatible with the Feed Simulation Editor in StreamBase Studio.

A successful recording creates two files:

  • An .sbrec file that contains feed simulation instructions and the schemas of all input streams in the specified module.

  • A CSV file for each input stream that contains the actual recorded tuple data.

The record target has three commands:

The designation [sn|ad] in syntax examples is a reminder that this command requires either the global parameter ‑‑servicename or the ‑‑adminport and ‑‑hostname combination to identify the node or cluster of interest.

epadmin display record

Shows the status of all active recordings, with two lines for each recording, as follows:

[A.sbuser] Record Identifier = 4
[A.sbuser] Paths = /Users/sbuser/tmp/A.sbrec /Users/sbuser/tmp/A-NYSE_Feed.csv

The record identifier is an integer assigned to each recording by the start command.

epadmin [sn|ad] display record
epadmin [sn|ad] display record --identifier=4
Command Parameter Description Required
identifier Recording identifier assigned by the start command. No. The default is to display all recordings currently underway.

epadmin start record

Starts an asynchronous record command running in the background, then returns. You can start and maintain multiple recordings at the same time. By default, recording files are saved at the root of the node's node directory. To save the files elsewhere, specify a full, absolute path with the --directory parameter.

epadmin [sn|ad] start record -name A
epadmin [sn|ad] start record -name A --engine=jvm1 --connecttime=60
epadmin [sn|ad] start record -name A --directory=/Users/sbuser/tmp
Command Parameter Description Required
connecttime Maximum time in seconds to wait for the specified node to become available. No. The default is ten seconds.
engine Engine name filter. No. The default is to start recording on all engines.
name Recording name. This becomes the basename of the .sbrec file generated, and the basename plus stream-name of each CSV file generated. For example, A.sbrec and A-NYSE_Feed.csv. Yes.
directory Output directory for the recorded data. This directory must exist on the node machine and must be writeable. Use a full, absolute path. No. The default is the root of the node directory.

epadmin stop record

Stops an ongoing recording by ID or stops all current recording for a specified node.

epadmin [sn|ad] stop record
epadmin [sn|ad] stop record --identifier=2

stop command parameters

Command Parameter Description Required
identifier Recording identifier assigned by the start command. Use display record to determine this ID. No. The default is to stop all active record commands.