Streams debugger commands
The Streams Debugger provides a set of commands to help you debug your application.
- (h)elp command
-
Displays the list of valid commands and their parameters.
- (q)uit command
Quits the sdb session.
- (b)reakpoint command
Establishes 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.
- (t)racepoint command
Establishes 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.
- (g)o command
Resumes execution of the program.
- (c)ontinue command
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.
- (e)nable-probepoint command
Enables a probe point (breakpoint or tracepoint) if currently disabled.
e <probe-point-id> | *
To enable all probe points use
e *
.
- (d)isable-probepoint command
Disables a probe point (breakpoint or tracepoint) which is currently enabled.
d <probe-point-id> | *
To disable all probe points use
d *
.
- (r)emove-probepoint command
Removes an established probe point (breakpoint or tracepoint).
r <probe-point-id> | *
To remove all probe points use
r *
.
- (i)njectpoint command
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.
- (p)redicate command
Modifies or adds a probe point expression to an existing probe point.
p <probe-point-id> <expression>
- (s)how-probepoint command
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.
- (l)ist-probepoints command
Lists the established probe points.
- list-(o)perators command
Lists all the operators (with number of input/output ports). For more information, see Displaying operators, ports, and schema information.
- (find) command
The
find
command helps to locate attributes among all ports.find [*field-name | *> [*field-type | *> | *] ]
For more information, see Searching for attributes.
- (u)pdate-tuple command
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.
- e(x)clude-tuple command
The
exclude
command is used to drop a tuple from a port.x (<probe-point-id> | *)
For more information, see Dropping tuples from flow.
- (save) command
The
save
command is used 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.
- (log) command
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.
- (clear) command
The
clear
command clears any cached tuples from an established tracepoint.clear <probe-point-id>
For more information, see Clearing the trace point cache.
- (savecfg) command
The
savecfg
command saves the current probe point definitions to a file.savecfg [<cfg-name>]
For more information, see Saving and loading debug configuration.
- (loadcfg) command
The
loadcfg
command loads previously saved probe point definitions.loadcfg [<cfg-name>]
For more information, see Saving and loading debug configuration.
- (setdbg) command
The
setdbg
command changes 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.
- (gdb) command
The
gdb
command launches thegdb
source code debugger for the operator process method.gdb <[breakpoint-id] | operator-name>
For more information, see topic Debugging source code using gdb.