---

• Monitoring in Cloud Pak for Data
• Tips for creating a Streams application

The Streams Console is a web application that allows you to easily monitor and manage your Streams instance and jobs. You can quickly gain insights on the health, metrics, issues and performance of your applications and the systems they are running on.

In Streams on Cloud Pak for Data, the Streams Console is a more advanced alternative to the Job Graph.

This guide will cover how to perform the following tasks:

• Opening the Streams Console
• Submitting a Job
• Using the Streams Graph
• View a sample of streaming data
• Downloading logs

Streams Console

Opening the Streams Console

Submitting a job

After opening the Streams Console, you can follow these steps to submit a job to run on your Streams instance. Streams applications are always compiled into a file with a .sab extension. SAB stands for Streams application bundle. This is a single, relocatable file that contains all the artifacts that are needed to run your application. Learn more about application bundle files here.

So, when we say “submit a .sab file”, we mean, run a compiled Streams application.

1. Click on the play icon in the header bar at the top.
   

2. Choose one of the options and point to your .sab file.
3. To configure the job submission, click on the Configure button. To submit the job with the default configuration, click on the Submit button. Learn more about job configuration here.

Streams Graph

This is a graphical view of your Streams Application. Here you can apply color schemes to display flow rates, operator and connection health, errors, and more.

A Streams application displayed in the Streams Graph. Rectangles are operators and the arrows are Streams.

Managing and Monitoring Jobs in the Streams Graph

Hover over an operator, a job, or a Stream to see available actions. These include:

• Set application trace
• Restart PEs
• Submit a job
• View PE restart recommendations
• Download operator and PE logs
• Modify parallel regions

Displaying streaming data with Views

A View is a connection to a particular Stream in a running application that allows you to see a sample of the data in the Stream. Views can be defined in an SPL with the @view annotation, or in Python with the Stream.view function.

Once the application is running, you can use the View to observe the data on the stream. Additionally, Views can also be added at runtime to a job, with some exceptions.

To add a view or inspect the data in a View, you can also use the Streams Console or the Job Graph in IBM Cloud Pak for Data.

Quick facts about views

• Views provide a sample of the data on a Stream, and not all the tuples on the Stream.
• Use a View to fetch data from a Stream only while the application is running.
• The data retrieved by the View is read-only, so you cannot use a View to change the tuples on a Stream.

Displaying an existing view

1. In the Application Dashboard, hover over the menu in the top left corner.
2. In the popup that appears, expand the instance, and expand the Views node. This will display a list of views in all applications in the instance.

3. Find the view based on the application name and the view name, and click on it.

   

4. Click Add View Grid. This will add a new card to the console showing the data from the grid.

   

Adding a view to a running application

If you did not add a view in the application's source, you can still do so from the Streams Console:

1. In the Application Dashboard, find the Streams Graph card and expand it.
2. Hover over the stream that comes out of an operator and right-click.
3. Select Create Dashboard View.
4. Accept the default options and click on the OK button.
5. Minimize the Streams Graph card.
6. A new card is created in the dashboard that displays the tuples in the stream produced by the operator. Notice that the view is updated as new data arrives.

These steps are demonstrated in the following animation.

Creating a view on a stream

Customizing the Streams Console with charts:

Monitor metrics and health through various configurable charts like pie charts, bar charts, scatter charts, etc. and grids.

How to do it:

1. Click Add card in the console
   

2. In Visualization Settings tab, choose a type of metric, e.g. PE memory consumption, and in the Card Properties, select the type of graph, e.g. bar chart.

   

Download and View Logs

Analyze application trace, product and console logs through a reader friendly viewer.

How to use it:

1. Open the log viewer from the far-right pane of the Streams Console.

   

2. Select the job of interest. Expanding the tree and selecting an operator or PE will open the logs pane. Click any of the tabs: Application trace, Console log or Product log to show trace data, messages printed to standard out, and product logs, respectively
   

Cancel a Job

• Click the Cancel Jobs button in the toolbar.

  

• Select the job(s).

• Click Cancel jobs.

Learn more

• Find errors and performance problems in Streams Console
• Create and use Application Dashboards to monitor jobs
• Customize how your application will be deployed

• Monitoring in Cloud Pak for Data
• Tips for creating a Streams application