From fda63b0568f052cf61b21e2a8e950b7dba1024e3 Mon Sep 17 00:00:00 2001 From: Siri Hansen Date: Thu, 24 Feb 2011 13:23:45 +0100 Subject: Document new cdv script and cdv.bat file for starting crashdump viewer --- lib/observer/doc/src/crashdump.xml | 6 ++++- lib/observer/doc/src/crashdump_help.html | 4 +-- lib/observer/doc/src/crashdump_ug.xml | 44 ++++++++++++++++++++++---------- 3 files changed, 37 insertions(+), 17 deletions(-) (limited to 'lib/observer/doc') diff --git a/lib/observer/doc/src/crashdump.xml b/lib/observer/doc/src/crashdump.xml index f8d7641524..b6056c2ed1 100644 --- a/lib/observer/doc/src/crashdump.xml +++ b/lib/observer/doc/src/crashdump.xml @@ -5,7 +5,7 @@
2003 - 2007 + 2011 Ericsson AB, All Rights Reserved @@ -38,6 +38,10 @@

The Crashdump Viewer is an HTML based tool for browsing Erlang crashdumps. Crashdump Viewer runs under the WebTool application.

+ +

See the user's guide + for more information about how to get started with the Crashdump + Viewer.

 diff --git a/lib/observer/doc/src/crashdump_help.html b/lib/observer/doc/src/crashdump_help.html index 736a024288..268b9495d6 100644 --- a/lib/observer/doc/src/crashdump_help.html +++ b/lib/observer/doc/src/crashdump_help.html @@ -131,7 +131,7 @@ SRC="min_head.gif"> - +

ETS tables

The ETS table information page shows all ETS table @@ -304,4 +304,4 @@ Copyright © 1991-2003 - \ No newline at end of file + diff --git a/lib/observer/doc/src/crashdump_ug.xml b/lib/observer/doc/src/crashdump_ug.xml index 9913b30e38..dc65fe5b39 100644 --- a/lib/observer/doc/src/crashdump_ug.xml +++ b/lib/observer/doc/src/crashdump_ug.xml @@ -4,7 +4,7 @@

- 20032009 + 20032011 Ericsson AB. All Rights Reserved. @@ -38,12 +38,31 @@
Getting Started -

From an erlang node, start Crashdump Viewer by calling - crashdump_viewer:start(). This will automatically start - WebTool and display the web address where WebTool can be - found. See the documentation for the WebTool application for - further information about how to use WebTool. -

+ +

The easiest way to start Crashdump Viewer is to use the + provided shell script named cdv with the full path to the + erlang crashdump as an argument. The script can be found in the + priv directory of the observer application. This starts + WebTool, Crashdump Viewer and a web browser, and loads the given + file. The browser should then display a page named General + Information which shows a short summary of the information in + the crashdump.

+ +

The default browser is Internet Explorer on Windows or else + Firefox. To use another browser, give the browser's start command + as the second argument to cdv. If the given browser name is + not known to Crashdump Viewer, the browser argument is executed as + a command with the start URL as the only argument.

+ +

Under Windows the batch file cdv.bat can be used.

+ +

It is also possible to start the Crashdump Viewer from within + an erlang node by calling crashdump_viewer:start/0. This + will automatically start WebTool and display the web address where + WebTool can be found. See the documentation for the WebTool + application for further information about how to use WebTool.

+

Point your web browser to the address displayed, and you should now see the start page of WebTool. At the top of the page, you will see a link to "CrashDumpViewer". Click this link to get to @@ -52,15 +71,12 @@ connection to the internet, or you must set no proxy for localhost.)

-

You can also start WebTool, Crashdump Viewer and a browser in - one go by running the start_webtool script found in the - priv directory of the WebTool application, e.g. -

->start_webtool crashdump_viewer

From the start page of Crashdump Viewer, push the "Load Crashdump" button to load a crashdump into the tool. Then enter - the filename of the crashdump in the entry field and push the "Ok" - button. + the filename of the crashdump in the entry field and push the + "Ok" button. This will bring you to the General Information + page, i.e. the same page as the cdv script will open in + the browser.

Crashdumps generated by OTP R9C and later are loaded directly into the Crashdump Viewer, while dumps from earlier releases first -- cgit v1.2.3 From e4d6273ea3c73d705286776b248562fbbe985866 Mon Sep 17 00:00:00 2001 From: Siri Hansen Date: Sat, 5 Mar 2011 19:07:08 +0100 Subject: Improve documentation for etop --- lib/observer/doc/src/etop.xml | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) (limited to 'lib/observer/doc') diff --git a/lib/observer/doc/src/etop.xml b/lib/observer/doc/src/etop.xml index 1ea67e6864..78047caab3 100644 --- a/lib/observer/doc/src/etop.xml +++ b/lib/observer/doc/src/etop.xml @@ -5,7 +5,7 @@

2002 - 2007 + 2011 Ericsson AB, All Rights Reserved @@ -26,27 +26,33 @@ etop Siri hansen - 1 + - 2002-03-27 - PA1 - etop.sgml + + +
etop Erlang Top is a tool for presenting information about erlang processes similar to the information presented by "top" in UNIX. +

etop should be started with the provided scripts etop and getop for text based and graphical - presentation respectively. Under Windows the batch files - etop.bat and getop.bat can be used. -

-

All interaction with etop when running the graphical - presentation should happen via the menus. For the text based - presentation the functions described below can be used. -

-

The following configuration parameters exist for etop. -

+ presentation respectively. This will start a hidden erlang node + which connects to the node to be measured. The measured node is + given with the -node option. If the measured node has a + different cookie than the default cookie for the user who + invokes the script, the cookie must be explicitly given witht + the -setcookie option.

+ +

Under Windows the batch files etop.bat and + getop.bat can be used.

+ +

The following configuration parameters exist for the + etop tool. When executing the etop or getop + scripts, these parameters can be given as command line options, + e.g. getop -node testnode@myhost -setcookie MyCookie.

node The measured node. @@ -96,6 +102,15 @@ Default: runtime (reductions if Value: on | off

Default: on + +

All interaction with etop when running the graphical + presentation should happen via the menus. For the text based + presentation the functions described below can be used. +

+ +

See the user's guide for + more information about the etop tool.

+ -- cgit v1.2.3