diff options
Diffstat (limited to 'lib/observer/doc/src/crashdump_ug.xml')
| -rw-r--r-- | lib/observer/doc/src/crashdump_ug.xml | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/lib/observer/doc/src/crashdump_ug.xml b/lib/observer/doc/src/crashdump_ug.xml new file mode 100644 index 0000000000..9913b30e38 --- /dev/null +++ b/lib/observer/doc/src/crashdump_ug.xml @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2003</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Crashdump Viewer</title> + <prepared></prepared> + <docno></docno> + <date></date> + <rev></rev> + <file>crashdump_ug.xml</file> + </header> + + <section> + <title>Introduction</title> + <p>The Crashdump Viewer is an HTML based tool for browsing Erlang + crashdumps. Crashdump Viewer runs under the WebTool application. + </p> + </section> + + <section> + <title>Getting Started</title> + <p>From an erlang node, start Crashdump Viewer by calling + <c>crashdump_viewer:start()</c>. 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. + </p> + <p>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 + the start page for Crashdump Viewer. (Note that if webtool is on + localhost, you must configure your web browser to have direct + connection to the internet, or you must set no proxy for + localhost.) + </p> + <p>You can also start WebTool, Crashdump Viewer and a browser in + one go by running the <c>start_webtool</c> script found in the + <c>priv</c> directory of the WebTool application, e.g. + <br></br> +<c>>start_webtool crashdump_viewer</c></p> + <p>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. + </p> + <p>Crashdumps generated by OTP R9C and later are loaded directly + into the Crashdump Viewer, while dumps from earlier releases first + are translated by the Crashdump Translater. The Crashdump + Translater creates a new file with the same name as the original + crashdump, but with the extension <c>.translated</c>. If there is + no write access to the directory of the original file, you will be + asked to enter a new path and filename for the translated file. + </p> + </section> + + <section> + <title>Navigating</title> + <p>The lefthand frame contains a menu. Menu folders can be + expanded and collapsed by clicking the folder picture. When a menu + item is clicked, the item information is shown in the big + information frame. + </p> + <p>The filename frame above the information frame shows the full + name of the currently viewed Erlang crashdump. + </p> + <p>To load a new crashdump, click the "Load New Crashdump" button + in the menu frame. + </p> + <p>The various information shown in the information frame will + contain links to process identifiers (PIDs) and port + identifiers. Clicking one of these links will take you to the + detailed information page for the process or port in question. Use + the "Back" button in your browser to get back to the + startingpoint. If the process or port resided on a remote node, + there will be no information available. Clicking the link will + then take you to the information about the remote node. + </p> + </section> + + <section> + <title>Help</title> + <p>Further help on how to use the Crashdump Viewer tool can be + found in the tool's menu under 'Documentation': + </p> + <p>'Crashdump Viewer help' is a short document describing each + information page and any additional information that might occur, + compared to the raw dump described in 'How to interpret Erlang + crashdumps'. + </p> + <p>'How to interpret Erlang crashdumps' is a document from the + Erlang runtime system describing details in the raw + crashdumps. Here you will also find information about each single + field in the different information pages. This document can also + be found directly in the OTP online documentation, via the Erlang + runtime system user's guide. + </p> + </section> +</chapter> + |