- Index

< Previous |  | Next >

## sbrecord

StreamBase Recording Tool — Records data enqueued onto all Input Streams

## SYNOPSIS

`sbrecord` [`OPTIONS`]

## DESCRIPTION

sbrecord records data enqueued onto all Input Streams in a running StreamBase application. For example, the sbrecord --name june28feedproc command records the data enqueued onto all Input Streams and creates several files that can be played back with the sbfeedsim command. The generated files are based on the `--name` parameter. Examples: `june28feedproc.sbrec`, which contains the recording's configuration properties (pointers to one or more `*.csv` generated data files, one for each Input Stream, such as `june28feedproc-stream1.csv` and `june28feedproc-stream2.csv`).

If authentication is enabled for this application, the sbrecord command requires `SBUser` privilege.

## OPTIONS

`-h` `command`, `--help` `command`

  Displays help for the specified command, then exits. For example, `sbrecord -h` shows a usage message for the sbrecord command.

`-u` `URI`

  Sets the URI of the StreamBase Server. The default is `sb://localhost:10000/`. The URI can also be set using the STREAMBASE_SERVER environment variable. See the sburi page of the Reference Guide (or see sburi(5) at the UNIX shell prompt) for a discussion of the URI format and its shortcuts.

`-p` `TCP-port`

  Sets the port number only for the StreamBase Server. Useful when the server is `localhost` and you only need to specify a non-default port, instead of specifying the full URI with the `-u` option. The default port is `10000.`

  ### Note

  The `-p` option is not supported for applications that have StreamBase authentication enabled (because there is no way to specify a username and password) or in conjunction with the multiple URI syntax.

`-J`jvm-option``

  Specifies a system property setting or other JVM argument to be passed to the JVM that runs this sbrecord command. Use this option to specify temporary settings that affect only the current invocation of sbrecord. You must specify multiple `-J` options to specify multiple JVM arguments.

  There must be no space after the `-J`. For example, specify `-J-Xmx2G`. Use the full option syntax for `jvm-option` that you would use at the Java command line, including the initial hyphen. For example, specify `-J-Dstreambase.log-level=2` to increase the log level for this invocation of sbrecord.

  Your `jvm-option` argument might require surrounding quotes, depending on the characters it contains and the shell you are using. However, do not use quotes to escape the spaces between separate JVM arguments; instead use separate `-J` options. For example: `-J-Xms512M -J-Xmx2G`

`--name` `recording-name`

  Required. A name used to identify the recording session. Files generated by the sbrecord command are based on the `--name` parameter. Examples: `june28feedproc.sbrec`, which contains the recording's configuration properties (pointers to one or more `*.csv` generated data files, one for each Input Stream, such as `june28feedproc-stream1.csv` and `june28feedproc-stream2.csv`).

`--outdir` `file-system-path`

  Optional. Sets the location of recorded data. The path must exist and be writeable. Default to the current working directory.

`--version`

  Prints version information and exits.

## FILES

The sbrecord command generates a configuration file, using the value from the `--name` parameter, and uses the `sbrec` file extension. For example, the sbrecord --name marketfeed command results in a configuration file named `marketfeed.sbrec`, which contains pointers to one or more CSV data files (one for each Input Stream in the running StreamBase application). In this example, each CSV file would be named `marketfeed-`stream-name`.csv`. There is one configuration file (`*.sbrec`) for each recording.

## ENVIRONMENT

`STREAMBASE_SERVER`

  Optional. Contains the URI for a StreamBase Server instance. Use this variable to set a default StreamBase URI for StreamBase commands that take the `-u` option. If set, commands use the URI in this variable, overriding their built-in default URI, which is `sb://localhost:10000.` If this variable is set, you must use the `-u` option to communicate with any server other than the one specified in this variable. See the sburi page in the Reference Guide for more on StreamBase URIs.

`STREAMBASE_RETITLE_TERMINALS`

  Optional. If set to any value, StreamBase programs assign a terminal window title to match the name of the executable being run. By default, terminal titles are not affected.

## SEE ALSO

sbd(1)
sbadmin
syslog (3)