Skip to content

Running distributed applications

Submit applications to a runtime environment for distributed execution across multiple hosts, then monitor and manage them all within VS Code. This mode is ideal for deploying in a test or staging environment.

Running Streams instance required

You will need a running Streams instance before you can submit distributed applications. See Managing instance lifecycle on how to create and start one if needed.

Submitting an application

There are several ways to submit an application to a Streams instance:

  1. In File Explorer, right-click the SPL file containing your application
  2. Click Build and Submit
  3. Configure any submission options in the form
  4. Click the Submit Job button
  1. In File Explorer, right-click the SAB file created after building your application
  2. Click Submit Job
  3. Configure any submission options in the form
  4. Click the Submit Job button
  1. Click on the (Streams Explorer) icon in the Activity Bar
  2. Hover over the name of the instance you want to submit the app to
  3. Click the timer (Submit Job) icon
  4. Configure any submission options in the form
  5. Click the Submit Job button
  1. Open the SPL file containing your application
  2. Click the (Streams Development) icon in the Activity Bar
  3. Click the (Submit) icon
  4. Configure any submission options in the form
  5. Click the Submit Job button

Once a job is running, you can view its graph, inspect logs, or cancel it.

Viewing the job graph

Running jobs can be viewed as a directed graph in the Streams Console:

  1. In the (Streams Explorer) view, navigate to the instance containing the job
  2. Hover over the job you want to view the runtime graph of
  3. Click the fork (Show Job Graph) icon
  4. Click Open in the dialog box to confirm

Viewing job logs

View PE and job logs directly in VS Code via the Streams Log Watcher panel:

  1. Enter Ctrl+Shift+U (Windows/Linux) or Cmd+Shift+U (macOS) to open the OUTPUT panel
  2. Click the STREAMS LOG WATCHER tab

You can then select which PE, job, or log channel to view.

Screenshot showing Streams Log Watcher tab selected in bottom VS Code panel

Downloading job logs

  1. In the (Streams Explorer) view, navigate to the instance containing the job
  2. Hover over the job you want to download logs for
  3. Click the document--download (Download Job Logs) icon
  4. Enter the file to save the logs to
  5. Click the OK button

Canceling a job

  1. In the (Streams Explorer) view, navigate to the instance containing the job
  2. Hover over the job you wish to cancel
  3. Click the (Cancel Job) icon
  4. Click Yes in the dialog box to confirm