From ab22fe599d0e6918cea46d620acaf7f8e16d36b6 Mon Sep 17 00:00:00 2001 From: Siri Hansen Date: Thu, 19 May 2016 15:15:51 +0200 Subject: [observer] Update user guide Document the new Ports tab and tracing of ports. --- lib/observer/doc/src/observer_ug.xml | 109 +++++++++++++++++++++++++++-------- 1 file changed, 86 insertions(+), 23 deletions(-) (limited to 'lib/observer') diff --git a/lib/observer/doc/src/observer_ug.xml b/lib/observer/doc/src/observer_ug.xml index be5d249f37..6eb72f3e58 100644 --- a/lib/observer/doc/src/observer_ug.xml +++ b/lib/observer/doc/src/observer_ug.xml @@ -168,7 +168,7 @@

The length of the message queue for the process.

 -

Option Process info opens a detailed information window on the selected process, +

Option Process info opens a detailed information window on the process under the mouse pointer, including the following:

Process Information @@ -195,12 +195,53 @@

-

Option Trace Processes adds the selected process identifiers to tab +

Option Trace selected processes adds the selected process identifiers to tab Trace Overview plus the node that the processes reside on.

-

Option Trace Named Processes adds the registered name of the processes. This can be +

Option Trace selected processes by name adds the registered name of the processes. This can be useful when tracing is done on many nodes, as processes with that name are then traced on all traced nodes.

+

Option Kill process brutally kills the processes under + the mouse pointer by sending an exit signal with + reason kill.

+ + + +
+ Ports Tab +

Tab Ports lists port information in columns. + For each port the following information is displayed: +

+ + Id +

The port identifier.

 + Connected +

The process identifier for the process that owns the + port.

 + Name +

The registered name of the port, if any.

 + Controls +

The name of the command set by erlang:open_port/2.

 + Slot +

The internal index of the port.

 + + +

Option Port info opens a detailed information window + for the port under the mouse pointer. In addition to the + information above, it also shows links and monitors.

+ +

Option Trace selected ports adds the selected port + identifiers, and the nodes that the ports reside on, + to tab Trace Overview.

+ +

Option Trace selected ports by name adds the + registered name of the port to tab Trace Overview. This + can be useful when tracing is done on many nodes, as ports with + that name are then traced on all traced nodes.

+ +

Option Close + executes erlang:port_close/1 + on the port under the mouse pointer.

@@ -211,8 +252,11 @@ applications are not diplayed. Use menu View to view "system" ETS tables, unreadable ETS tables, or Mnesia tables.

-

Double-click to view the table content. To view table information, select the table - and activate menu View > Table information.

+

Double-click to view the table content, or right-click and + select option Show Table Content. To view table + information, select the table and activate menu View > + Table information, or right-click and select option Table + info.

You can use regular expressions and search for objects, and edit or delete them.

@@ -220,11 +264,12 @@
Trace Overview Tab -

Tab Trace Overview handles tracing. Trace - by selecting the processes to be traced and how to trace - them. You can trace messages, function calls, and events, where - events are process-related events such as spawn, - exit, and many others. +

Tab Trace Overview handles tracing. Trace by selecting + the processes or ports to be traced and how to trace them. For + processes, you can trace messages, function calls, scheduling, + garbage collections, and process-related events such + as spawn, exit, and many others. For ports, you can + trace messages, scheduling and port-related events.

To trace function calls, you also need to set up @@ -234,31 +279,49 @@ specifications can also be used to trigger more information in the trace messages.

-

Trace patterns only apply to the traced processes.

 + +

You can also set match specifications on messages. By default, + if tracing messages, all messages sent and/or received by the + process or port are traced. Match specifications can be used to + reduce the number of traced messages and/or to trigger more + information in the trace messages.

+ +

Trace patterns only apply to the traced processes and + ports.

- Processes are added from the Applications or Processes tabs. - A special new identifier, meaning all processes spawned after trace - start, can be added with button Add 'new' Process. + Processes are added from the Applications + or Processes tabs. Ports are added from + the Ports tab. A special new identifier, + meaning all processes, or ports, started after trace start, can + be added with buttons Add 'new' Processes and Add + 'new' Ports, respecively.

- When adding processes, a window with trace options is displayed. The chosen - options are set for the selected processes. - Process options can be changed by right-clicking a process. + When adding processes or ports, a window with trace options is + displayed. The chosen options are set for the selected + processes/ports. To change the options, right-click the process + or port and select Edit process options. To remove a + process or port from the list, right-click and select Remove + process or Remove port, respectively.

- Processes added by process identifiers add the nodes these - processes reside on in the node list. More nodes can be added by clicking - button Add Nodes. + Processes and ports added by process/port identifiers add the + nodes these processes/ports reside on in the node list. More + nodes can be added by clicking button Add Nodes, or by + right-clicking in the Nodes list and select Add + Nodes. To remove nodes, select them, then right-click and + choose Remove nodes.

If function calls are traced, trace patterns must be added by clicking button Add Trace Pattern. Select a module, function(s), and a match specification. If no functions are selected, all functions in the module are traced.

- Trace patterns can also be added for traced messages. This is - done in the same way as for traced function calls. Separate - trace patterns must be set for sent and received messages. + Trace patterns can also be added for traced messages. Click + button Add Trace Pattern and select Messages + sent or Messages received, and a match + specification.

A few basic match specifications are provided in the tool, and -- cgit v1.2.3