RTView® 
User Guide


Attach to StreamBase Data

NOTE: The StreamBase data source may not be licensed in your RTView installation.

To bring up the Attach to StreamBase Data dialog, right-click on the Property Name (e.g., the value property or the valueTable property) from the Object Properties window and select Attach to Data>SB. This dialog is used to attach an object property to StreamBase monitoring metrics or stream content and display real-time results in an RTView display. Once an object property has been attached it receives continuous updates.

The Attach to StreamBase Data dialog provides several drop down menus that allow you to specify information regarding the tuples you retrieve. If the drop down menu does not contain the item you require, type your selection into the text field. 

 

 
Connection The StreamBase connection name. You may specify a connection on the StreamBase Connections of the Application Options dialog.  NOTE: If * is entered, data will be retrieved from all defined connections.
Stream Name The name of the stream from which you want content. Choose either a Stream Name or RTViewDs. Available Stream Names are based on the Connection specified in the Application Options dialog.

NOTE:  All returned rows of data are identified by both Connection and Stream Name. In the returned table, Connection names will appear in a column named conn added to each incoming tuple.

Streams Returns a table with a single row containing the latest tuple data.
History Returns a table with one row for each tuple received. This table continuously grows to the maximum specified for History Depth in the Application Options dialog.

Example: streamname_history

History2 Returns a table containing one row for each tuple received up to that point in time. Does not continue updating as new tuples come in.

Example: streamname_history2

Field(s) If Stream, History or History2 is selected in the Stream Name field, the Field(s) field dropdown menu is populated with the following options. For RTViewDs options, see the RTViewDs table.
Filter Rows Check box to indicate whether or not to filter the rows.
Filter Column Name of the column field to use as a filter.
Filter Value Value that the filter field must equal.
Data Server Select to read data through your configured Data Server and not directly from the StreamBase data source.

Default - Select the default Data Server you configured in Application Options>Data Server.

None - Bypass data being redirected through the specified data server(s) for this attachment and instead attach directly to the data source.

Named Data Servers - Select a Named Data Server that you configured in Application Options>Data Server.

Drop down menus populate based on connections added from the Application Options dialog or those typed directly into the Attach to StreamBase Data dialog.

When an object property has been attached to data, the Property Name and Value in the Object Properties window will be displayed in green. This indicates that editing values from the Object Properties window is no longer possible. To remove the data attachment and resume editing capabilities in the Object Properties window, right-click on the Property Name and select Detach from Data. You will recognize that an object property has been detached from the data source when the Property Name and Value are no longer green


Substitutions
The Substitutions feature allows you to build open-ended displays in which data attachments depend on values defined at the time the display is run. A generic stream name such as $stream is used instead of a specific stream name. Later when the display is running, this generic value is defined by the actual name of a specific stream, such as SalesInfo. In this way, a single display can be reused to show data from a number of different sources. For more information on creating displays using substitution values, see Substitutions.


RTViewDs
The following special values can be entered for the Stream Name field:
 
RTViewDs Column Available Description
RTViewDs.Connections Connected

True / False. Indicates whether connected.

Status Status information for this connection.
StatusFull Status information for this connection.
Stream Count Count of active streams in a connection.
URI The connection name.
Version StreamBase client software version currently running.
RTViewDs.Streams Connected

True if  the connection for this stream is connected.

Last Tuple Time The time RTView received the latest tuple on this stream.
Stream  The name of the stream.
Time Since Last Tuple The amount of time in seconds that has passed since RTView received a tuple on this stream.
Tuples Received The total number of tuples received on this stream since RTView started. This does not include history.
Tuples Total The total number of tuples received on this stream since RTView started plus the total number of tuples from history.
URI The URI for the connection for this stream.
RTViewDs.OperatorInfo Timestamp The time that the Snapshot for this data was taken.
URI The URI for the connection for this monitor information.
Name The name of the operator.
InputPortCount The number of input ports on this operator.
InputTuplesDequeuedDelta The number of input tuples consumed by this operator since the previous Snapshot. If this number is less than the number of tuples enqueued to the input stream, then tuples are being queued up faster than the operator can consume them.
InputTuplesDequeuedTotal The total number of input tuples consumed by this operator since the StreamBase Server was started. If this number is less than the number of tuples enqueued to the input stream, then tuples are being queued up faster than the operator can consume them.
InputTuplesEnqueuedDelta The number of tuples enqueued on this operator's input streams since the previous Snapshot.
InputTuplesEnqueuedTotal The total number of input tuples enqueued on this operator's input streams since the StreamBase Server was started.
OutputPortCount The number of output ports on this operator.
OutputTuplesEnqueuedDelta The number of output tuples produced by this operator since the previous Snapshot.
OutputTuplesEnqueuedTotal The total number of output tuples produced by this operator since the StreamBase Server was started.
PercentUsage The number of profiler hits divided by the total profiler hits.
ProfilerHits The number of miniticks used by the operator, as defined by profiler samples.
Size The size of the operator. The definition of "size" varies by operator.
Status The status of the operator. When blank, this returns an empty string.
TotalProfilerHits The number of miniticks used by all operators in the contained ProfileState. The percentage usage is then profiler hits/total profiler hits.
RTViewDs.ThreadInfo Timestamp The time that the Snapshot for this data was taken.
URI The URI for the connection for this monitor information.
Name The name of the thread.
PercentCPU The percent of CPU used by this thread, in microseconds.
PercentSystem The percent of system CPU time used by this thread, in microseconds.
PercentUser The percent of user CPU time used by this thread, in microseconds.
SystemTimeDelta The system time spent by thread since the last Snapshot, in microseconds.
SystemTimeTotal The system time spent by this thread since the StreamBase Server started, in microseconds.
UserTimeDelta The user time spent since the last Snapshot, in microseconds.
UserTimeTotal The user time spent by thread since the StreamBase Server started, in microseconds.
RTViewDs.SystemInfo DequeueClientCount The current number of dequeueing clients.
FreeMemory The amount of free memory in the StreamBase Server process, in bytes.
MaxMemory The maximum amount of memory which the StreamBase Server process is allowed to allocate, in bytes.
Timestamp The time that the Snapshot for this data was taken.
URI The URI for the connection for this monitor information.
ProcessSize The amount of memory used the StreamBase Server process, in Megabytes.
TimeRunning The amount of time that the StreamBase Server has been running, in seconds.
TotalKB The total amount of memory, in kilobytes, available for use in the StreamBase server process.
TotalMemory The total amount of memory, in bytes, available for use in the StreamBase Server process.
FreeKB The amount of free memory, in kilobytes, in the StreamBase server process.
maxKB The maximum amount of memory, in kilobytes, which the StreamBase server process is allowed to allocate.
numDequeue The current number of dequeuing clients.
UsedMemory The total amount of memory currently in use in the StreamBase Server process, in bytes.




Select Columns Fields (Tables Only)
From the Attach to Data dialog you can specify which tuple fields to display as columns in a table and in what order they will appear. In order to populate the listing of available tuple fields, you must first select a valid stream name.

To bring up the Select Columns dialog, click on the ellipse button in the Field(s) field (or right-click in the Field(s) field and click Select Columns). The dialog contains a list of Available Columns that you can add to your table.

To add a field, select an item from the Available Columns list and click on the Add button. If the item you require is not listed, type your selection into the Enter Column Name field. Click the Remove button to delete an item previously added to the Selected Columns list. You can control the order of fields in a table by arranging the items in the Selected Columns list with the Move Up and Move Down buttons.

If no data is available for a table row within a selected column, the table cell will display one of the following values: N/A, false, 0, or 0.0.
 


The following describes Attach to StreamBase Data dialog commands:
 
Command Description
OK Applies values and closes the dialog.
Apply Applies values without closing the dialog.
Reset Resets all fields to last values applied.
Clear Clears all fields. Detaches object from data source (once Apply or OK is selected).
Cancel Closes the dialog with last values applied.

   


 
SL, SL-GMS, GMS, RTView, SL Corporation, and the SL logo are trademarks or registered trademarks of Sherrill-Lubinski Corporation in the United States and other countries. Copyright © 1998-2011 Sherrill-Lubinski Corporation. All Rights Reserved.

 

JMS, JMX and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only. 

 

Third Party Notice Requirements