epadmin-playback

epadmin playback target — Manages playback sessions of EventFlow feed simulations.

SYNOPSIS

epadmin [globalparameters] command playback [commandparameters]

DESCRIPTION

Use the start playback command to send an EventFlow feed simulation to an input stream on a running node. You can start and maintain multiple playback sessions at the same time to the same node or to multiple nodes in a cluster. Each started playback session is assigned an integer identifier. These ID numbers continue to increment as long as the node is running.

Each started session stays resident even when its invoked feed simulation has stopped, such as when it has exhausted its input data file. This allows you to continue monitoring sessions with display playback until you issue a stop playback command to remove them.

You can pause and resume playback sessions, and can change their tuple data rate with set playback.

The playback target has eight 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 playback

Use the display command to view the status of all current playback sessions for the specified node or cluster. 

epadmin --servicename=A.sbuser display playback // for the named node
epadmin --servicename=sbuser display playback // for all nodes in the cluster
epadmin --servicename=A.sbuser display playback --id=1 // for the session with ID 1

The display output is like the following: 

[A.sbuser] Path = default
[A.sbuser] Playback Identifier = 1
[A.sbuser] Status = Running
[A.sbuser] Start Time = Thu Mar 26 16:50:05 EDT 2020
[A.sbuser] Tuples Processed = 189000
[A.sbuser] Tuples/Second Rate = 1000.0
Command Parameter Description Required
identifier Playback identifier as issued by the start command. No. The default is to display all active playback sessions.

epadmin pause playback

Pauses an active playback session. 

epadmin [sn|ad] pause playback
epadmin [sn|ad] pause playback --identifier=1
Command Parameter Description Required
identifier Playback identifier as issued by the start command. No. The default is to pause all active playback sessions.

epadmin resume playback

Resumes a paused playback session. You cannot resume a playback session whose status is Stopped, only one with status Paused. 

epadmin [sn|ad] resume playback
epadmin [sn|ad] resume playback --identifier=1
Command Parameter Description Required
identifier Playback identifier as issued by the start command. No. The default is to resume all paused playback commands.

epadmin set playback

Use the set command to change the tuple data rate of a running playback session. 

epadmin [sn|ad] set playback --ratepersecond=5.3
epadmin [sn|ad] set playback --asfastaspossible
epadmin [sn|ad] set playback --identifier=1 --rate=10
epadmin [sn|ad] set playback --identifier=1 --asfast
Command Parameter Description Required
asfastaspossible Boolean to enable running the simulation as fast as possible. One of asfastaspossible or ratepersecond must be specified. No default.
identifier Playback identifier as issued by the start command. No. The default is to set rates on all active playback commands.
ratepersecond The tuple playback rate per second expressed as a double value. One of asfastaspossible or ratepersecond must be specified. No default.

epadmin start playback

Starts an asynchronous playback command running in the background, then returns.

The results are not defined if you start more than one playback session that read from the same input data file, such as a CSV file. To avoid a potential read conflict, use duplicate or separate input data files for separate playback sessions.

The only required command parameter is the path to the feed simulation file with .sbfs extension that you want to run. Develop these files in StreamBase Studio with the Feed Simulation Editor.

If the feed simulation file requires a named data file in its Data File generation method, then you must also provide the path to that data file with --csvfile. If the feed simulation file specifies one data file, but you specify a different but compatible one with --csvfile, the file specified on the command line is used. 

epadmin [sn|ad] start playback --simulationfile=my.sbfs
epadmin [sn|ad] start playback --sim=my.sbfs --path=container2
epadmin [sn|ad] start playback --sim=my.sbfs --csvfile=mydata.csv --connecttime=60
epadmin [sn|ad] start playback --sim=my.sbfs --asfastaspossible
epadmin [sn|ad] start playback --sim=my.sbfs --maxtime=10 --maxtup=1000 --mult=2.3
epadmin [sn|ad] start playback --sim=my.sbfs --prefill --tuplebuffer=10000
Command Parameter Description Required
asfastaspossible Boolean to enable running the feed simulation as fast as possible. No. The default is false.
connecttime Maximum time in seconds to wait for the specified node to become available No. The default is ten seconds.
csvfile Path to a data file referenced in the Generation Method of the feed simulation, or to a compatible data file to override one specified in the feed simulation.

For a remote node, csvfile must be specified for the command to be able to copy the data file to the node machine for use by the simulation.

Not required for Default, Custom, or JDBC generation methods in the simulationfile; but required if the simulationfile specifies the Data File generation method. No default.
engine Engine name filter. No. The default is to start playback on all engines.
maxtime Specifies the maximum time in seconds to run the simulation. No. The default is no maximum value.
maxtuples Specifies the maximum number of tuples to generate. No. The default is no maximum value.
multiplier Specifies the speed up multiplier for all streams in the simulation as a double value. No. The default is no multiplier.
path Container name. Playback is started for input streams in this StreamBase container. No. The default is the default container.
prefilltuplebuffer Boolean controlling whether the tuple buffer is to be filled before sending the first tuple when using data files or JDBC data sources. No. The default is false.
simulationfile Path to feed simulation file. For a remote node, the specified feed simulation file is copied to the node machine, but any referenced files in the simulation are not automatically copied to the node machine. Use he csvfile parameter to copy these files as well to the node machine. Yes.
tuplebuffersize Maximum number of tuples to buffer on each stream. A value of 0 disables all buffering. No. The default is 100.

epadmin stop playback

Stops a running playback session. 

epadmin [sn|ad] stop playback        // Stops all session on this cluseter
epadmin [sn|ad] stop playback --id=1 // Stops one particular session
Command Parameter Description Required
identifier Playback identifier as issued by the start command. No. The default is to stop all active playback sessions.

epadmin wait playback

Waits for a playback command to complete. Use this in a script or a set of commands to pause processing of the script until the playback session finishes. 

epadmin [sn|ad] wait playback
epadmin [sn|ad] wait playback --identifier=1
Command Parameter Description Required
identifier Playback identifier as issued by the start command. No. The default is to wait for all active playback commands.

SEE ALSO

Help System for epadmin
epadmin(1)
epadmin-globals(1)