Teracloud Streams extension for Visual Studio Code

Build solutions that drive real-time business decisions by combining streaming and stored data with analytics.

The Teracloud Streams extension provides an integrated development experience for building, running, and deploying streaming applications directly within Visual Studio Code. A Teracloud Streams 7.2 or later installation is required to use the full capabilities of the extension.

Designed for developers working with Streams Processing Language (SPL), toolkits, and build artifacts, the extension supports:

• SPL project development with language support
• Build, run, and submit SPL applications
• Toolkit navigation and management
• Instance and job overview via the Streams Explorer

Get Started

The quickest way to get started is with the Teracloud Streams dev container, which bundles a full development and runtime environment using the Quick Start Edition.

Prerequisites:

• A container runtime such as Docker
• The Dev Containers extension

Steps:

1. Open the Command Palette (Ctrl+Shift+P) and run Dev Containers: New Dev Container...

2. Paste the following into the prompt and select Use as template...

   ghcr.io/teracloud-streams/devcontainer-templates/teracloud-streams:latest
   

3. If prompted, review the template info and click Trust @undefined from Github

4. Optionally enter a name for the container, then click Create Dev Container

5. Once the container has started, open the included example

Already have Teracloud Streams 7.2+ installed? Install the extension and configure it to point to your install.

For more details, see Set up a development environment.

Workflows

Developing applications

Leverage syntax highlighting and SPL langauge server features to enhance writing SPL applications and toolkits.

Create SPL projects or main applications using helpful wizards.

View and manage toolkits available to your applications.

Use the SPL compiler provided in a Teracloud Streams install to build applications

These actions are accessible via the context menu, Command Palette, or Streams Development view.

Running standalone applications

Use the Streams Development view to launch built applications in standalone mode directly from the editor.

Submitting jobs

Submit your built applications or .sab files to a connected instance to test application deployment and runtime platform configurations.

Managing runtime instances and jobs

Use the Streams Explorer for viewing and managing runtime instances and jobs, including viewing health, downloading or viewing logs, and modifying environment variables and app configurations.

For job graphs and advanced management operations, the Teracloud Streams web console can be launched from the Streams Explorer.

Features

Syntax Highlighting and SPL Language Support

Supports SPL (.spl) files and offers IntelliSense, code navigation, diagnostics, hover info, formatting, and other hints.

Streams Development View

A unified view for SPL application development. Build your application, view its build config, browse or manage available toolkits, launch your application in standalone mode, or submit to a runtime instance.

Streams Explorer

A structured view of configured Streams instances and their associated jobs. Connect to local or remote instances, monitor job state, and submit application bundles.

Streams Log Watcher

Inspect job and processing element logs directly within VS Code.

Documentation

See the Teracloud Streams Developer Tools website for full documentation on configuring the extension, performing the workflows, and advanced usage.

Feedback

This extension is actively maintained. For support requests or bug reports, please use the issues tab in our Support Repository.