Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Commands
Teracloud® Streams provides a number of commands you use to perform tasks.
spl-transport-stats command
The spl-transport-stats command creates a transport statistics model by running a transport performance test.

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
  - streamtool
    Streamtool is the Streams command-line interface.
  - Metrics
    Teracloud® Streams provides metrics to help evaluate the health of Teracloud Streams services, to aid in diagnosing performance issues, and to analyze throughput of requests. You can use the streamtool checkinstancemetrics, streamtool checkdomainmetrics, streamtool getdomainmetrics, and streamtool checkresourcemetrics commands to view the metrics data.
  - Reading syntax diagrams in the documentation
    There is a syntax convention for how parameters and values are represented in the command syntax diagrams in the Teracloud® Streams documentation.
  - sc command
    The sc command compiles SPL applications.
  - spl-app-info command
    The spl-app-info command reports information about a application bundle file.
  - spl-make-doc command
    The spl-make-doc command generates documentation for your toolkits.
  - spl-make-operator command
    The spl-make-operator command creates code generator modules from template files. The command can also create skeleton code generator templates and a default operator model if they do not exist.
  - spl-make-toolkit command
    The spl-make-toolkit command indexes a toolkit and makes the functions and operators it contains ready for use by SPL programs.
  - spl-schema-from-xml command
    The spl-schema-from-xml command creates an SPL tuple declaration from an XML document.
  - spl-transport-stats command
    The spl-transport-stats command creates a transport statistics model by running a transport performance test.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

spl-transport-stats

The spl-transport-stats command creates a transport statistics model by running a transport performance test.

Usage

Figure 1. spl-transport-stats

spl-transport-stats -h,--help |
[-F, --use-transport <transport-name>]
[-s, --silent] [-l, --local]
[-o, --output-directory <path>]
[-i, --instance-id <instance-name>]

Authority

You do not need any authority to run this command.

Description

The command generates the transport statistics model in a file named transportStatModelFor_xx.xml, where xx is the transport name passed with the -F or --use-transport command parameter.

Options and arguments

-F, --use-transport transport-name: Specifies to run the transport performance test for a specific transport. The following values are valid for transport-name: tcp; llm_rum_tcp; llm_rum_ib. These values are case sensitive. The default value is tcp.
Restrictions: If you use the LLM transport, do not enable encrypted connections between processing elements. If both the LLM transport and encrypted connections are enabled, the processing elements can't connect.
-h, --help: Specifies to show the command syntax and help information.
-i, --instance-id instance-name: Specifies the instance identifier. If you do not specify this option, Teracloud® Streams uses the instance identifier that is set in the STREAMS_INSTANCE_ID environment variable. By default, that instance identifier is StreamsInstance.
-l, --local: Specifies to locate the performance test operators on the same host by using a hostColocation config clause. The host where the application runs is chosen from the instance hosts when the application is submitted. The instance hosts might not include the host where you run the spl-transport-stats command. In this case, the output file name has _local as a suffix. For example, transportStatModelFor_xx_local.xml.
-o, --output-directory path: Specifies the directory where the file is output. The default path is ./output/etc/stat, relative to the current directory.
-s, --silent: Specifies to suppress the command output messages.