Streams debugger commands

• (h)elp
• (g)o start running the application.
• (q)uit SDB
• (c)ontinue <probe point id> | * [p only | before | after]
• (b)reakpoint <operator name> <port type (i|o)> <port index | *> [d] [p <expression>]
• (i)njectpoint <operator name> <port type (i|o)> <port index | *>
• (t)racepoint <operator name> <port type (i|o)> <port index> [max tuples = 10] [d]
  [log] [p <expression>]
• (p)redicate <probe point id> <expression>
• (l)ist-probepoints
• list-(o)perators [*operator-name> [<port type (i|o)> <port index>] ]
• find [<field-name | *> [<field-type | *> | *] ]
        Finds fields definitions for the available operators.
• (e)nable-probepoint <probe point id | *>
• (d)isable-probepoint <probe point id | *>
• (r)emove-probepoint <probe point id | *>
• (s)how-probepoint <probe point id> [t (table format)]
• (u)pdate-tuple <probe point id> <attribute name> <attribute value>
• e(x)clude-tuple <probe point id> | * >
       Toggles drop of tuple.
• (clear) <probe point id>
        Clears the cached tuples for the specified trace point.
• (log) <probe point id> <start | stop>
        Starts or stops logging trace point tuples to a file.
• (save) <probe point id> <file name>
        Saves the cached tuples for a specified probe point to a file.
• (savecfg) [<cfg-name>]
        Saves the current probe point definitions.
• (loadcfg) [<cfg-name>]
        Loads previously saved probe point definitions.
• (setdbg) [<name> <value>]
        loglevel 0 | 1 | 2 | 3
        logformat log | syslog
        tracelevel 0 | 1 | 2 | 3 | 4 | 5
        traceformat default | short | long
• (gdb) <[breakpoint id] | operator name>
        Launch GDB, break on process method(s)

Quit sdb session.

Establish a breakpoint on an input or output port.

b <operator-name> (i | o) (<port-index> | *) [d] [p <predicate>]

For more information, see Suspending execution with breakpoints.

Establish a trace point on an input or output port.

t <operator-name> (i | o) <port-index> [max-tuples] [d] [log] [p <predicate>]

For more information, see Tracing tuples with trace points.

Resume execution of the program.

The continue command is used to continue execution after a breakpoint or tuple injection.

c <probe-point-id> | *

For more information, see Continuing execution of a stopped breakpoint and Inserting tuples with inject points.

Enables a probe point (breakpoint or tracepoint) if currently disabled.

e <probe-point-id> | *

To enable all probe points use e *.

Disables a probe point (breakpoint or tracepoint) which is currently enabled.

d <probe-point-id> | *

To disable all probe points use d *.

Remove an established probe point (breakpoint or tracepoint).

r <probe-point-id> | *

To remove all probe points use r *.

Creates a point to inject a tuple into a specific input or output port of an operator. The attribute values of the tuple can be updated with the (u)pdate command. The new tuple is injected after the (c)ontinue command.

i <operator-name> (i|o) (<port-index> | *)

For more information, see Inserting tuples with inject points.

Modifies or adds a probe point expression to an existing probe point.

p <probe-point-id> <expression>

Shows details (cached tuple values) about the specific probe point.

s <probe-point-id>

To view the list of probe points, use the (l)ist command. For more information, see Displaying tuples currently in the cache.

List the established probe points.

List all the operators (with number of input/output ports). For more information, see Displaying operators, ports, and schema information.

The find command helps to locate attributes among all ports.

find [*field-name | *> [*field-type | *> | *] ]

For more information, see Searching for attributes.

The update command allows one to change values of tuple attributes.

u <probe point id> <attribute name> <attribute value>

For more information, see Changing attribute values in tuples.

The exclude command is used to drop a tuple from a port.

x (<probe-point-id> | *)

For more information, see Dropping tuples from flow.

To save the cached tuples for a specified port to a file.

save <probe-point-id> <file-name>

For more information, see Saving probe point tuples to a file.

The log command is used to start and stop logging of all cached tuples to a file.

log <probe-point-id>

For more information, see Starting and stopping trace point logging.

Use the clear command to clear any cached tuples from an established tracepoint.

clear <probe-point-id>

For more information, see Clearing the trace point cache.

Use the savecfg command to save the current probe point definitions to a file.

savecfg [<cfg-name>]

For more information, see Saving and loading debug configuration.

Use the loadcfg command to load previously saved probe point definitions.

loadcfg [<cfg-name>]

For more information, see Saving and loading debug configuration.

Use the setdbg command to change the level and format for logging and tracing.

setdbg loglevel 0 | 1 | 2 | 3
setdbg logformat log | syslog
setdbg tracelevel 0 | 1 | 2 | 3 | 4 | 5
setdbg traceformat default | short | long

For more information, see Setting console logging and tracing options.

The gdb command launches the gdb source code debugger for the operator process method.

gdb <[breakpoint id] | operator-name>

For more information, see topic Debugging source code using gdb.