3.1. Usage

This section explains how to run Recording Service from a command line. In particular, it describes:

3.1.1. Starting Recording Service

Recording Service runs as a separate application. The script to run the executable is in <NDDSHOME>/bin. (See Section 1.3 for the path to NDDSHOME.)

To start Recording Service with a default configuration, enter:


This command will run Recording Service indefinitely until you stop it.

You can run Recording Service using the command-line parameters defined below.


Recording Service is pre-loaded with a builtin configuration that has default settings. See Section 3.2.18.

3.1.2. Stopping Recording Service

To stop Recording Service, press Ctrl-c. Recording Service will perform a clean shutdown.

3.1.3. Recording Service Command-Line Parameters

The following table describes all the command-line parameters available in Recording Service. To list the available parameters, run rtirecordingservice -help.

All command-line parameters are optional; if specified, they override the values of any corresponding settings in the loaded XML configuration. See Section 3.2.4 for the XML elements that can be overridden with command-line parameters.

Table 3.1 Recording Service Command-Line Parameters
Parameter Description
-appName <string> Application name used to identify this execution for remote administration and to name the Connext DDS participant.
-cfgFile <string> Semicolon-separated list of configuration file paths.
Default: unspecified
-cfgName Configuration name used to find a <recording_service> matching tag in the configuration file.
-domainIdBase <int> This value is added to the domain IDs in the <domain_participant> tag in the configuration file. For example, if you set -domainIdBase to 50 and use domain IDs 0 and 1 in the configuration file, then Recording Service will use domains 50 and 51 for recording (though the recorded data will appear as though it was recorded in domains 0 and 1).
Default: 0
-D<name>=<value> Defines a variable that can be used as an alternate replacement for XML environment variables, specified in the form $(VAR_NAME).
Note that definitions in the environment take precedence over these definitions.
-help Shows this help.
-heapSnapshotDir Output directory where the heap monitoring snapshots are dumped. The filename format is:
-heapSnapshotPeriod <sec> Period at which heap monitoring snapshots are dumped. Enables heap monitoring if > 0.
Default: 0 (disabled)
-logFormat <format>

A mask to configure the format of the log messages for both Recording Service and Connext DDS:

  • DEFAULT - Print message, method name, and activity context
  • TIMESTAMPED - Print message, method name, activity context, and timestamp
  • MINIMAL - Print only message number and method name
  • MAXIMAL - Print all available fields

Default: DEFAULT

-maxObjectsPerThread <int> Maximum number of thread-specific objects that can be created.
Default: 1024.
-remoteAdministrationDomainId <int> Enables remote administration and sets the domain ID for communication.
Default: Remote administration is not enabled.
-remoteMonitoringDomainId <int> Enables remote monitoring and sets the domain ID for status publication.
Default: Remote monitoring is not enabled.
-verbosity [0-6]
RTI Service verbosity
  • 0 - silent
  • 1 - exceptions (Connext DDS and Recording Service)
  • 2 - warnings (Recording Service)
  • 3 - information (Recording Service)
  • 4 - warnings (Connext DDS and Recording Service)
  • 5 - tracing (Recording Service)
  • 6 - tracing (Connext DDS and Recording Service)

Default: 1 (exceptions)

-version Prints the program version and exits.