diff options
Diffstat (limited to 'lib/observer/doc')
23 files changed, 475 insertions, 483 deletions
diff --git a/lib/observer/doc/src/Makefile b/lib/observer/doc/src/Makefile index 0f564d3299..baeeeb1c65 100644 --- a/lib/observer/doc/src/Makefile +++ b/lib/observer/doc/src/Makefile @@ -34,6 +34,8 @@ RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) # Target Specs # ---------------------------------------------------- XML_APPLICATION_FILES = ref_man.xml +XML_REF1_FILES = \ + cdv.xml XML_REF3_FILES = \ crashdump.xml \ observer.xml \ @@ -59,19 +61,14 @@ BOOK_FILES = book.xml XML_FILES = \ $(BOOK_FILES) $(XML_CHAPTER_FILES) \ - $(XML_PART_FILES) $(XML_REF3_FILES) \ + $(XML_PART_FILES) $(XML_REF1_FILES) $(XML_REF3_FILES) \ $(XML_APPLICATION_FILES) $(XML_REF6_FILES) -ONLY_HTML_FILE = \ - crashdump_help.html +ONLY_HTML_FILE = GIF_FILES = \ et_processes.gif \ et_modsprocs.gif \ - etop_main.gif \ - etop_5.gif \ - etop_lines.gif \ - etop_opt.gif \ note.gif # ---------------------------------------------------- @@ -81,6 +78,7 @@ HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ INFO_FILE = ../../info +MAN1_FILES = $(XML_REF1_FILES:%.xml=$(MAN1DIR)/%.1) MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) MAN6_FILES = $(XML_REF6_FILES:%_app.xml=$(MAN6DIR)/%.6) @@ -110,6 +108,7 @@ html: gifs $(HTML_REF_MAN_FILE) $(ONLY_HTML_FILE:%=$(HTMLDIR)/%) clean clean_docs: rm -rf $(HTMLDIR)/* + rm -f $(MAN1DIR)/* rm -f $(MAN3DIR)/* rm -f $(MAN6DIR)/* rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) @@ -119,7 +118,7 @@ clean clean_docs: $(HTMLDIR)/$(ONLY_HTML_FILE): $(INSTALL_DATA) $(ONLY_HTML_FILE) $@ -man: $(MAN3_FILES) $(MAN6_FILES) +man: $(MAN1_FILES) $(MAN3_FILES) $(MAN6_FILES) gifs: $(GIF_FILES:%=$(HTMLDIR)/%) @@ -139,6 +138,8 @@ release_docs_spec: docs $(INSTALL_DATA) $(HTMLDIR)/* \ "$(RELSYSDIR)/doc/html" $(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)" + $(INSTALL_DIR) "$(RELEASE_PATH)/man/man1" + $(INSTALL_DATA) $(MAN1DIR)/* "$(RELEASE_PATH)/man/man1" $(INSTALL_DIR) "$(RELEASE_PATH)/man/man3" $(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3" $(INSTALL_DIR) "$(RELEASE_PATH)/man/man6" diff --git a/lib/observer/doc/src/book.xml b/lib/observer/doc/src/book.xml index 7ecb153b2f..c47852e697 100644 --- a/lib/observer/doc/src/book.xml +++ b/lib/observer/doc/src/book.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE book SYSTEM "book.dtd"> <book xmlns:xi="http://www.w3.org/2001/XInclude"> <header titlestyle="normal"> <copyright> - <year>2002</year><year>2009</year> + <year>2002</year><year>2013</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> diff --git a/lib/observer/doc/src/cdv.xml b/lib/observer/doc/src/cdv.xml new file mode 100644 index 0000000000..fc8f16bc4e --- /dev/null +++ b/lib/observer/doc/src/cdv.xml @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE comref SYSTEM "comref.dtd"> + +<comref> + <header> + <copyright> + <year>2013</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>The cdv program</title> + <prepared>Siri Hansen</prepared> + <responsible>Siri Hansen</responsible> + <docno></docno> + <approved></approved> + <checked></checked> + <date>2013-10-015</date> + <rev>PA1</rev> + <file>cdv.xml</file> + </header> + <com>cdv</com> + <comsummary>Script used for starting the Crashdump Viewer from the + OS command line. + </comsummary> + + <description> + <p>The <c>cdv</c> shell script can be found under the <c>priv</c> + directory of the <c>observer</c> application. The script is used + for starting the Crashdump Viewer tool from the OS command + line.</p> + <p>For Windows users, <c>cdv.bat</c> can be found in the same + location.</p> + </description> + + <funcs> + <func> + <name>cdv [file]</name> + <fsummary>Start the Crashdump Viewer and load the given file.</fsummary> + <desc> + <p>The <c>file</c> arguments is optional. If not given, a file + dialog will pop up allowing the user to select a crashdump + from the file system.</p> + </desc> + </func> + </funcs> + +</comref> diff --git a/lib/observer/doc/src/crashdump.xml b/lib/observer/doc/src/crashdump.xml index b6056c2ed1..27e42e83b7 100644 --- a/lib/observer/doc/src/crashdump.xml +++ b/lib/observer/doc/src/crashdump.xml @@ -1,11 +1,11 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd"> <erlref> <header> <copyright> <year>2003</year> - <year>2011</year> + <year>2013</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> @@ -31,13 +31,14 @@ <checked></checked> <date>2003-03-10</date> <rev>PA1</rev> - <file>crashdump.sgml</file> + <file>crashdump.xml</file> </header> <module>crashdump_viewer</module> - <modulesummary>A HTML based tool for browsing Erlang crashdumps.</modulesummary> + <modulesummary>A WxWidgets based tool for browsing Erlang + crashdumps.</modulesummary> <description> - <p>The Crashdump Viewer is an HTML based tool for browsing Erlang - crashdumps. Crashdump Viewer runs under the WebTool application.</p> + <p>The Crashdump Viewer is a WxWidgets based tool for browsing Erlang + crashdumps.</p> <p>See the <seealso marker="crashdump_ug">user's guide</seealso> for more information about how to get started with the Crashdump @@ -46,16 +47,26 @@ <funcs> <func> <name>start() -> ok</name> + <name>start(File) -> ok</name> <fsummary>Start the crashdump_viewer</fsummary> + <type> + <v>File = string()</v> + <d>The file name of the crashdump.</d> + </type> <desc> - <p>This function starts the <c>crashdump_viewer</c>.</p> + <p>This function starts the <c>crashdump_viewer</c> GUI and + loads the given crashdump.</p> + + <p>If <c>File</c> is not given, a file dialog will be opened + where the crashdump can be selected.</p> </desc> </func> <func> <name>stop() -> ok</name> <fsummary>Stop the crashdump_viewer</fsummary> <desc> - <p>This function stops the <c>crashdump_viewer</c>.</p> + <p>This function stops the <c>crashdump_viewer</c> and closes + all GUI windows.</p> </desc> </func> </funcs> diff --git a/lib/observer/doc/src/crashdump_help.html b/lib/observer/doc/src/crashdump_help.html deleted file mode 100644 index 268b9495d6..0000000000 --- a/lib/observer/doc/src/crashdump_help.html +++ /dev/null @@ -1,307 +0,0 @@ -</<!doctype chapter PUBLIC "-//Stork//DTD chapter//EN"> -<!-- - ``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 via the world wide web 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. - - The Initial Developer of the Original Code is Ericsson Utvecklings AB. - Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings - AB. All Rights Reserved.'' - - $Id$ ---> -<html> -<head> -<title>Crashdump Viewer help</title> -</head> -<body BGCOLOR="#FFFFFF"> -<center> -<a HREF="http://www.erlang.se"><img BORDER=0 ALT="[Erlang Systems]" -SRC="min_head.gif"></a> -</center> -<blockquote> - <h2>Information pages</h2> - - <p>Each menu item points to an information page. If no information - is found for an item, the page will simply say "No information - found". The reason for not finding any information about an item - can be that the dump is truncated, that it is a dump from an old - OTP release in which this item was not written or that the item - simply wasn't present in the system at the point of failure. - - <p>If the dump was truncated, a warning is displayed. - - <p>Even if some information about an item exists, there might be - empty fields if the dump originates from an old OTP release. - - <p>The value "-1" in any field means "unknown", and in most cases - it means that the dump was truncated somewhere around this field. - - <p>Only some of the fields in the different information pages are - described here. These are fields that to not exist in the raw - crashdump, or in some way differs from the fields in the raw - crashdump. Details about other field can be found in the user's - guide for the Erlang runtime system, in the chapter "How to - interpret the Erlang crash dumps". A link to this chapter can be - found in the Crashdump Viewer's menu under documentation, and - there are also direct links from the specific sections below to - related information in "How to interpret the Erlang crash dumps". - - <a NAME="general_info"> - <h3>General information</h3> - - <p>This is the first page shown when a new dump is loaded into - the system. It shows a very short overview of the dump. - - <p>'Node name' will only exist in dumps originating from OTP R9C - and later. - - <p>The following fields are not described in the Erlang runtime - system user's guide: - - <dl> - <dt><strong>Crashdump created on</strong></dt> - <dd>Time of failure.</dd> - - <dt><strong>Memory allocated</strong></dt> - <dd>The total number of bytes allocated, equivalent to - <code>c:memory(total)</code>. This will only be present in - dumps from OTP R9C and later.</dd> - - <dt><strong>Memory maximum</strong></dt> - <dd>The maximum number of bytes that has been allocated - during the lifetime of the originating node. This will not be - present in dumps older than OTP R9C, and even in newer - releases it is only shown if the Erlang runtime system was run - instrumented.</dd> - - <dt><strong>Atoms</strong></dt> - <dd>If at all available in the dump, this is the total - number of atoms in the atom table. If the size of the atom - table is not available, the number of atoms visible in the - dump is presented.</dd> - - <dt><strong>Processes, ETS tables and Funs</strong></dt> - <dd>The number of processes, ETS tables and funs visible in - the dump.</dd> - </dl> - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#general_info> - More...</a> - </center> - - - <a NAME="processes"> - <h3>Processes</h3> - - <p>The Process Information page shows a list of all processes - found in the crashdump, including some short information about - each process. By default the processes are sorted by their - pids. To sort by other topic, click any heading in the process - table. - - <p>Detailed information about a specific process is shown when - the pid is clicked. - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#processes> - More...</a> - </center> - - - - <a NAME="ports"> - <h3>Ports</h3> - - <p>The port information page shows all port information found in - the dump. - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#ports> - More...</a> - </center> - - - - <a NAME="ets_tables"><a NAME="internal_ets_tables"> - <h3>ETS tables</h3> - - <p>The ETS table information page shows all ETS table - information found in the dump. The 'Id' is the same as the - 'Table' field found in the raw crashdump, and 'Memory' is the - 'Words' field from the raw crashdump translated into - bytes. 'Type' is the type of table, and it can be either "hash" - or "tree". For tree tables there will be no value in the - 'Bucket' field. - - <p>Clicking a pid in the 'Owner' column takes you to the - detailed information about the process owning the ETS table. - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#ets_tables> - More...</a> - </center> - - - <a NAME="timers"> - <h3>Timers</h3> - - <p>The timer information page shows all timer information found - in the dump. - - <p>Clicking a pid in the 'Owner' column takes you to the - detailed information about the process owning the timer. - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#timers> - More...</a> - </center> - - - - <a NAME="funs"> - <h3>Fun table</h3> - - <p>The Fun table information page shows all Fun information - found in the dump. Fun information will only exist in dumps from - OTP R8B or later. - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#funs> - More...</a> - </center> - - - - <a NAME="atoms"> - <h3>Atoms</h3> - - <p>The atoms information page lists all atoms found in the - dump. The last created atom is listed first. - - <p>Note that if the dump is from OTP R8B or earlier, the raw - dump lists the atoms in the opposite order and the Crashdump - Viewer reverses them. This means that there is no problem if the - dump is not truncated. However, if the dump is truncated, the - last atoms might not be shown at all!! - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#atoms> - More...</a> - </center> - - - <a NAME="distribution_info"> - <h3>Distribution information</h3> - - <p>The distribution information page shows all distribution - information found in the dump. - - <p>If the page shows "Not alive", it means that the node was not - distributed. - - <p>It the node was distributed, all connected nodes are - shown. Visible nodes are alive nodes with a living connection to - the originating node. Hidden nodes are the same as visible - nodes, except they are started with the "-hidden" flag. Not - connected nodes are nodes that are not connected to the - originating node anymore, but references (i.e. process or port - identitifiers) exist. - - <p>'Links/Monitors' may contain information about links or - monitors between processes on the originating node and the - connected node. - - <p>'Extra Info' may contain debug information (i.e. special - information written if the emulator is debug compiled) or error - information. - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#distribution_info> - More...</a> - </center> - - - <a NAME="loaded_modules"> - <h3>Loaded modules</h3> - - <p>The loaded modules information page shows all modules that - were loaded on the originating node, and the current size of the - code. If old code exsits, the old size is also shown. - - <p>Detailed information about a specific module is shown when - the module name is clicked. - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#loaded_modules> - More...</a> - </center> - - - <a NAME="internal_tables"> - <h3>Internal tables</h3> - - <p>Internal tables are shown in two information pages: hash - tables and index tables. - - <center> - <a href=/crashdump_erts_doc/crash_dump.html#internal_tables> - More...</a> - </center> - - - <a NAME="memory"> - <h3>Memory</h3> - - <p>Memory information is divided into three pages. - - <p>The first page, <strong>Memory</strong>, shows information - similar to what you can obtain on a living node with - <code>c:memory()</code>. This will only be present in dumps from - OTP R9C and later. - <a href=/crashdump_erts_doc/crash_dump.html#memory>More...</a> - - <p>The <strong>Allocated areas</strong> page shows information - similar to what you can obtain on a living node with - <code>erlang:system_info(allocated_areas)</code>. - <a href=/crashdump_erts_doc/crash_dump.html#allocated_areas>More...</a> - - <p>The <strong>Allocator information</strong> page shows - information about allocators. The contents of the page will vary - with the version. - <a href=/crashdump_erts_doc/crash_dump.html#allocator>More...</a> - - <center> - - </center> - - - <h3>Documentation</h3> - - <p>'Crashdump Viewer help' is this document. - - <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. - -</blockquote> -<center> -<hr> -<font SIZE=-1> - -Copyright © 1991-2003 -<a HREF="http://www.erlang.se">Ericsson Utvecklings AB</a><br> -<!--#include virtual="/ssi/otp_footer.html"--> -</font> -</center> -</body> -</html> diff --git a/lib/observer/doc/src/crashdump_ug.xml b/lib/observer/doc/src/crashdump_ug.xml index 8aef1ffdf0..d22fb4cc40 100644 --- a/lib/observer/doc/src/crashdump_ug.xml +++ b/lib/observer/doc/src/crashdump_ug.xml @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE chapter SYSTEM "chapter.dtd"> <chapter> @@ -13,12 +13,11 @@ 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> @@ -31,9 +30,9 @@ <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> + <p>The Crashdump Viewer is a WxWidgets based tool for browsing + Erlang crashdumps. + </p> </section> <section> @@ -42,93 +41,357 @@ <p>The easiest way to start Crashdump Viewer is to use the provided shell script named <c>cdv</c> with the full path to the erlang crashdump as an argument. The script can be found in the - priv directory of the <c>observer</c> 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.</p> - - <p>The default browser is Internet Explorer on Windows, open on Mac OS X, - or else Firefox. To use another browser, give the browser's start command - as the second argument to <c>cdv</c>. 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.</p> + priv directory of the <c>observer</c> application. This starts the + Crashdump Viewer GUI and loads the given file. If no file name is + given, a file dialog will be opened where the file can be + selected.</p> <p>Under Windows the batch file <c>cdv.bat</c> can be used.</p> <p>It is also possible to start the Crashdump Viewer from within an erlang node by calling <seealso - marker="crashdump_viewer#start/0">crashdump_viewer:start/0</seealso>. 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>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. This will bring you to the General Information - page, i.e. the same page as the <c>cdv</c> script will open in - the browser. - </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> + marker="crashdump_viewer#start/0">crashdump_viewer:start/0</seealso> + or <seealso + marker="crashdump_viewer#start/1">crashdump_viewer:start/1</seealso>.</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> + <title>The graphical interface</title> + + <p>The main window is opened when Crashdump Viewer has loaded a + crashdump. It contains a title bar, a menu bar, a number of + information panels and a status bar.</p> + + <p>The title bar shows the name of the currently loaded + crashdump.</p> + + <p>The menu bar contains a <em>File</em> menu and a <em>Help</em> + menu. From the File menu a new crashdump can be loaded or the tool + can be terminated. From the Help menu this user's guide and the + chapter "How to interpret the Erlang crash dumps" from the user's + guide for Erlang runtime system can be opened. "How to interpret + the Erlang crash dumps" describes the raw crashdumps in + detail. 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> + + <p>The status bar at the bottom of the window will show a warning + if the currently loaded dump is truncated.</p> + + <p>The centre area of the main window contains the information + panels. Each panel displays information about a specific item or a + list of items. A panel is selected by clicking the title of the + tab.</p> + + <p>From panels that display lists of items, for example the + Processes- or the Ports panel, a new window with further + information can be opened by double clicking a row or by right + clicking the row and selecting an item from the drop down + menu. The new window is called a detail window. Detail windows can + be opened for processes, ports, nodes and modules.</p> + + <p>The various information shown in a detail window might contain + links to processes or ports. Clicking one of these links will open + the detail window for the process or port in question. If the + process or port resided on a remote node, there will be no + information available. Clicking the link will then pop up a dialog + where you can choose whether to open the detail window for the + remote node or not. + </p> + + <p>Some of the panels contain a left hand menu where sub items of + the panel's information area can be selected. Click on one of the + rows, and the information will be displayed in the right hand + information area.</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> + <title>Data content</title> + + <p>Each panel in the main window contains an information + page. If no information is found for an item, the page will be + empty. The reason for not finding any information about an item + can be that the dump is truncated, that it is a dump from an old + OTP release in which this item was not written or that the item + simply wasn't present in the system at the point of failure.</p> + + <p>If the dump was truncated, a warning is displayed in the + status bar of the main window.</p> + + <p>Even if some information about an item exists, there might be + empty fields if the dump originates from an old OTP release.</p> + + <p>The value "-1" in any field means "unknown", and in most + cases it means that the dump was truncated somewhere around this + field.</p> + + <p>The sections below describe some of the fields in the + different information panels. These are fields that do not exist + in the raw crashdump, or in some way differ from the fields in + the raw crashdump. Details about other fields can be found in + the user's guide for the Erlang runtime system, in the chapter + "How to interpret the Erlang crash dumps". That chapter can also + be opened from the Help menu in the Crashdump Viewer's main + window, and there are also direct links from the specific + sections below to related information in "How to interpret the + Erlang crash dumps".</p> </section> -</chapter> + <section> + <marker id="general_info"/> + <title>General information</title> + + <p>The <em>General information</em> panel shows a short overview + of the dump.</p> + + <p>The following fields are not described in the Erlang runtime + system user's guide:</p> + + <taglist> + <tag><em>Crashdump created on</em></tag> + <item>Time of failure.</item> + + <tag><em>Memory allocated</em></tag> + <item>The total number of bytes allocated, equivalent to + <c>c:memory(total)</c>.</item> + + <tag><em>Memory maximum</em></tag> + <item>The maximum number of bytes that has been allocated during + the lifetime of the originating node. This will only be shown if + the Erlang runtime system was run instrumented.</item> + + <tag><em>Atoms</em></tag> + <item>If available in the dump, this is the total number of + atoms in the atom table. If the size of the atom table is not + available, the number of atoms visible in the dump is + presented.</item> + + <tag><em>Processes, ETS tables and Funs</em></tag> + <item>The number of processes, ETS tables and funs visible in + the dump.</item> + </taglist> + + <p> + <seealso marker="erts:crash_dump#general_info">More...</seealso> + </p> + </section> + + <section> + <marker id="processes"/> + <title>Processes</title> + + <p>The <em>Processes</em> panel shows a list of all processes + found in the crashdump, including some short information about + each process. By default the processes are sorted by their + pids. To sort by other topic, click the desired column + heading.</p> + + <p>The <em>Memory</em> column shows the 'Memory' field which was + added to crashdumps in R16B01. This is the total amount of memory + used by the process. For crashdumps from earlier releases, this + column shows the 'Stack+heap' field. The value shown is always in + bytes.</p> + + <p>To view detailed information about a specific process, double + click the row in the list or right click the row and select + "Properties for <pid>".</p> + + <p> + <seealso marker="erts:crash_dump#processes">More...</seealso> + </p> + </section> + + <section> + <marker id="ports"/> + <title>Ports</title> + + <p>The <em>Ports</em> panel is similar to the <em>Processes</em> + panel, except it lists all ports found in the crashdump.</p> + + <p>To see more details about a specific port, dobule click the row + or right click it and select "Properties for <port>". From + the right click menu you can also select "Properties for + <pid>", where <pid> is the process connected to the + port.</p> + + <p> + <seealso marker="erts:crash_dump#ports"> + More...</seealso> + </p> + </section> + + <section> + <marker id="ets_tables"/><marker id="internal_ets_tables"/> + <title>ETS tables</title> + + <p>The <em>ETS Tables</em> panel shows all ETS table information + found in the dump. The 'Id' is the same as the 'Table' field found + in the raw crashdump, and 'Memory' is the 'Words' field from the + raw crashdump translated into bytes. 'Type' is the type of table, + and it can be either "hash" or "tree". For tree tables there will + be no value in the 'Bucket' field.</p> + + <p>To open the detailed information page about the owner process + of an ETS table, right click the row and select "Properties for + <pid>".</p> + + <p>Double clicking a row in the ETS Tables panel has no + effect.</p> + + <p>From the left hand menu you can also select to see internal ETS + tables.</p> + + <p> + <seealso marker="erts:crash_dump#ets_tables"> + More...</seealso> + </p> + </section> + + <section> + <marker id="timers"/> + <title>Timers</title> + + <p>The <em>Timers</em> panel shows all timer information found in + the dump.</p> + + <p>To open the detailed information page about the owner process + of a timer, right click the row and select "Properties for + <pid>".</p> + + <p>Double clicking a row in the Timers panel has no effect.</p> + + <p> + <seealso marker="erts:crash_dump#timers">More...</seealso> + </p> + </section> + + <section> + <marker id="funs"/> + <title>Funs</title> + + <p>The <em>Funs</em> panel shows all Fun information found in the + dump.</p> + + <p>To open the detailed information page about the module to which + the fun belongs, right click the row and select "Properties for + <mod>".</p> + + <p>Double clicking a row in the Funs panel has no effect.</p> + + <p> + <seealso marker="erts:crash_dump#funs">More...</seealso> + </p> + </section> + + <section> + <marker id="atoms"/> + <title>Atoms</title> + + <p>The <em>Atoms</em> panel lists all atoms found in the dump. By + default the atoms are sorted in creation order from first to + last. This is opposite of the raw crashdump where atoms are listed + from last to first, meaning that if the dump was truncated in the + middle of the atom list only the last created atoms will be seen + in the <em>Atoms</em> panel.</p> + + <p> + <seealso marker="erts:crash_dump#atoms">More...</seealso> + </p> + </section> + + <section> + <marker id="distribution_info"/> + <title>Nodes</title> + + <p>The <em>Nodes</em> panel shows a list of all external erlang + nodes which are referenced from the crashdump.</p> + + <p>If the page is empty it either means that the crashed node was + not distributed, that it was distributed but had no references to + other nodes or that the dump was truncated.</p> + + <p>If the node was distributed, all referenced nodes are + shown. The column named <em>Connection type</em> shows if the node + is visible, hidden or not connected. Visible nodes are alive nodes + with a living connection to the originating node. Hidden nodes are + the same as visible nodes, except they are started with the + <c>-hidden</c> flag. Not connected nodes are nodes that are not + connected to the originating node anymore, but references + (i.e. process or port identifiers) exist.</p> + + <p>To see more detailed information about a node, double click the + row or right click the row and select "Properties for node + <node>". From the right click menu you can also select + "Properties for <port>", to open the detailed information + window for the controlling port.</p> + + <p>In the detailed information window for a node, any exsisting + links and monitors between processes on the originating node and + the connected node are shown. <em>Extra Info</em> may contain + debug information (i.e. special information written if the + emulator is debug compiled) or error information.</p> + + <p> + <seealso marker="erts:crash_dump#distribution_info"> + More...</seealso> + </p> + </section> + + <section> + <marker id="loaded_modules"/> + <title>Loaded modules</title> + + <p>The <em>Modules</em> panel lists all modules that were loaded + on the originating node, and the current size of the code. If old + code exsits, the old size is also shown.</p> + + <p>To see detailed information about a specific module, double + click the row or right click it and select "Properties for + <mod>".</p> + + <p> + <seealso marker="erts:crash_dump#loaded_modules"> + More...</seealso> + </p> + </section> + + <section> + <marker id="memory"/> + <title>Memory</title> + + <p>The <em>Memory</em> panel shows memory and allocator + information. From the left hand menu you can select:</p> + + <p> + <list> + + <item><em>Memory</em> <seealso + marker="erts:crash_dump#memory">More...</seealso></item> + + <item><em>Allocator Summary</em> - this page presents a + summary of values from all allocators below.</item> + + <item><em><Allocator></em> - one entry per allocator + <seealso + marker="erts:crash_dump#allocator">More...</seealso></item> + + <item><em>Allocated Areas</em> <seealso + marker="erts:crash_dump#allocated_areas">More...</seealso></item> + + </list> + </p> + </section> + + <section> + <marker id="internal_tables"/> + <title>Internal tables</title> + + <p>On the <em>Internal Tables</em> panel you can choose from the + left hand menu to see hash tables or index tables.</p> + + <p> + <seealso marker="erts:crash_dump#internal_tables">More...</seealso> + </p> + </section> +</chapter> diff --git a/lib/observer/doc/src/etop.xml b/lib/observer/doc/src/etop.xml index af6bb2442b..9f3cdd6de8 100644 --- a/lib/observer/doc/src/etop.xml +++ b/lib/observer/doc/src/etop.xml @@ -1,11 +1,11 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd"> <erlref> <header> <copyright> <year>2002</year> - <year>2012</year> + <year>2013</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> @@ -38,21 +38,19 @@ <description> <p><c>etop</c> should be started with the provided scripts - <c>etop</c> and <c>getop</c> for text based and graphical - presentation respectively. This will start a hidden erlang node + <c>etop</c>. This will start a hidden erlang node which connects to the node to be measured. The measured node is given with the <c>-node</c> 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 <c>-setcookie</c> option.</p> - <p>Under Windows the batch files <c>etop.bat</c> and - <c>getop.bat</c> can be used.</p> + <p>Under Windows the batch file <c>etop.bat</c> can be used.</p> <p>The following configuration parameters exist for the - <c>etop</c> tool. When executing the <c>etop</c> or <c>getop</c> - scripts, these parameters can be given as command line options, - e.g. <c>getop -node testnode@myhost -setcookie MyCookie</c>.</p> + <c>etop</c> tool. When executing the <c>etop</c> script, + these parameters can be given as command line options, + e.g. <c>etop -node testnode@myhost -setcookie MyCookie</c>.</p> <taglist> <tag>node</tag> <item>The measured node. @@ -103,11 +101,6 @@ Value: <c>on | off</c> <br></br> Default: <c>on</c></item> </taglist> - <p>All interaction with <c>etop</c> when running the graphical - presentation should happen via the menus. For the text based - presentation the functions described below can be used. - </p> - <p>See the <seealso marker="etop_ug">user's guide</seealso> for more information about the <c>etop</c> tool.</p> @@ -118,7 +111,7 @@ Default: <c>on</c></item> <fsummary>Start etop</fsummary> <desc> <p>This function starts <c>etop</c>. - Note that etop is preferably started with the etop and getop scripts</p> + Note that etop is preferably started with the etop script.</p> </desc> </func> <func> diff --git a/lib/observer/doc/src/etop_5.gif b/lib/observer/doc/src/etop_5.gif Binary files differdeleted file mode 100644 index 9650176366..0000000000 --- a/lib/observer/doc/src/etop_5.gif +++ /dev/null diff --git a/lib/observer/doc/src/etop_lines.gif b/lib/observer/doc/src/etop_lines.gif Binary files differdeleted file mode 100644 index 10620a1155..0000000000 --- a/lib/observer/doc/src/etop_lines.gif +++ /dev/null diff --git a/lib/observer/doc/src/etop_main.gif b/lib/observer/doc/src/etop_main.gif Binary files differdeleted file mode 100644 index 699cb986c8..0000000000 --- a/lib/observer/doc/src/etop_main.gif +++ /dev/null diff --git a/lib/observer/doc/src/etop_opt.gif b/lib/observer/doc/src/etop_opt.gif Binary files differdeleted file mode 100644 index e420bff7f6..0000000000 --- a/lib/observer/doc/src/etop_opt.gif +++ /dev/null diff --git a/lib/observer/doc/src/etop_ug.xml b/lib/observer/doc/src/etop_ug.xml index ccbb626465..c57df1d324 100644 --- a/lib/observer/doc/src/etop_ug.xml +++ b/lib/observer/doc/src/etop_ug.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE chapter SYSTEM "chapter.dtd"> <chapter> <header> <copyright> - <year>2002</year><year>2009</year> + <year>2002</year><year>2013</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -39,9 +39,7 @@ <section> <title>Output</title> - <p>The output from <c>etop</c> can be graphical or text based. - </p> - <p>Text based it looks like this:</p> + <p>The output from <c>etop</c> looks like this:</p> <code type="none"><![CDATA[ ======================================================================================== tiger@durin 13:40:32 @@ -63,10 +61,6 @@ Pid Name or Initial Func Time Reds Memory MsgQ Current Func <127.137.0> net_kernel:do_spawn_ 0 553 5840 0 dbg:do_relay_1/1 ======================================================================================== ]]></code> - <p>And graphically it looks like this:</p> - <image file="etop_main.gif"> - <icaption>Graphical presentation of etop</icaption> - </image> <p>The header includes some system information: </p> <taglist> @@ -102,9 +96,7 @@ Pid Name or Initial Func Time Reds Memory MsgQ Current Func <section> <title>Start</title> - <p>To start etop with the graphical presentation, use the script - <c>getop</c> or the batch file <c>getop.bat</c>, e.g. <c>getop -node tiger@durin</c></p> - <p>To start etop with the text based presentation use the script + <p>To start etop use the script <c>etop</c> or the batch file <c>etop.bat</c>, e.g. <c>etop -node tiger@durin</c>, </p> </section> @@ -115,30 +107,12 @@ Pid Name or Initial Func Time Reds Memory MsgQ Current Func <c>-OptName Value</c> to the command line, e.g. <c>etop -node tiger@durin -setcookie mycookie -lines 15</c>. </p> <p>The parameters <c>lines</c>, <c>interval</c>, <c>accumulate</c> - and <c>sort</c> can be changed during runtime. Use the - <em>Options</em> menu with the graphical presentation or the - function <c>etop:config/2</c> with the text based presentation. + and <c>sort</c> can be changed during runtime by the + function <c>etop:config/2</c>. </p> <p>A list of all valid configuration parameters can be found in the reference manual for <c>etop</c>. </p> - <p>Note that it is even possible to change which information to - sort by by clicking the header line of the table in the graphical - presentation. - </p> - - <section> - <title>Example: Change configuration with graphical presentation</title> - <image file="etop_opt.gif"> - <icaption>Select the option to change from the Options menu.</icaption> - </image> - <image file="etop_lines.gif"> - <icaption>Enter the new value in the popup window and click "Ok"</icaption> - </image> - <image file="etop_5.gif"> - <icaption>The interface is updated with the new configuration</icaption> - </image> - </section> <section> <title>Example: Change configuration with text based presentation</title> @@ -187,18 +161,14 @@ Pid Name or Initial Func Time Reds Memory MsgQ Current Func <section> <title>Print to file</title> <p>At any time, the current <c>etop</c> display can be dumped to a - text file. Use <em>Dump to file</em> on the <em>File</em> menu - with the graphical presentation or the function <c>etop:dump/1</c> - with the text based presentation. + text file with the function <c>etop:dump/1</c>. </p> </section> <section> <title>Stop</title> - <p>To stop <c>etop</c>, use <em>Exit</em> on the <em>File</em> - menu for the graphical presentation, or the function - <c>etop:stop/0</c> with the text based presentation. - </p> + <p>Use the function <c>etop:stop/0</c> to stop <c>etop</c>. + </p> </section> </chapter> diff --git a/lib/observer/doc/src/fascicules.xml b/lib/observer/doc/src/fascicules.xml index 0678195e07..37feca543f 100644 --- a/lib/observer/doc/src/fascicules.xml +++ b/lib/observer/doc/src/fascicules.xml @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE fascicules SYSTEM "fascicules.dtd"> <fascicules> diff --git a/lib/observer/doc/src/notes_history.xml b/lib/observer/doc/src/notes_history.xml index 2300983131..55e965022c 100644 --- a/lib/observer/doc/src/notes_history.xml +++ b/lib/observer/doc/src/notes_history.xml @@ -1,11 +1,11 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE chapter SYSTEM "chapter.dtd"> <chapter> <header> <copyright> <year>2006</year> - <year>2011</year> + <year>2013</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> diff --git a/lib/observer/doc/src/observer.xml b/lib/observer/doc/src/observer.xml index 03830f2b1c..315301e2c8 100644 --- a/lib/observer/doc/src/observer.xml +++ b/lib/observer/doc/src/observer.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd"> <erlref> <header> <copyright> - <year>2011</year> + <year>2011</year><year>2013</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> diff --git a/lib/observer/doc/src/observer_app.xml b/lib/observer/doc/src/observer_app.xml index e643568a39..e4790ce98c 100644 --- a/lib/observer/doc/src/observer_app.xml +++ b/lib/observer/doc/src/observer_app.xml @@ -1,11 +1,11 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE appref SYSTEM "appref.dtd"> <appref> <header> <copyright> <year>2002</year> - <year>2011</year> + <year>2013</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> diff --git a/lib/observer/doc/src/observer_ug.xml b/lib/observer/doc/src/observer_ug.xml index 569d72e71e..3aeaf1997a 100644 --- a/lib/observer/doc/src/observer_ug.xml +++ b/lib/observer/doc/src/observer_ug.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE chapter SYSTEM "chapter.dtd"> <chapter> <header> <copyright> - <year>2011</year> + <year>2011</year><year>2013</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> diff --git a/lib/observer/doc/src/part.xml b/lib/observer/doc/src/part.xml index 0d6aad09f2..c05f9bdf9c 100644 --- a/lib/observer/doc/src/part.xml +++ b/lib/observer/doc/src/part.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE part SYSTEM "part.dtd"> <part xmlns:xi="http://www.w3.org/2001/XInclude"> <header> <copyright> - <year>2002</year><year>2011</year> + <year>2002</year><year>2013</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> diff --git a/lib/observer/doc/src/part_notes.xml b/lib/observer/doc/src/part_notes.xml index cd659395af..a900779e2f 100644 --- a/lib/observer/doc/src/part_notes.xml +++ b/lib/observer/doc/src/part_notes.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE part SYSTEM "part.dtd"> <part xmlns:xi="http://www.w3.org/2001/XInclude"> <header> <copyright> - <year>2004</year><year>2009</year> + <year>2004</year><year>2013</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> diff --git a/lib/observer/doc/src/part_notes_history.xml b/lib/observer/doc/src/part_notes_history.xml index 1ba0875fec..8f13861bb9 100644 --- a/lib/observer/doc/src/part_notes_history.xml +++ b/lib/observer/doc/src/part_notes_history.xml @@ -1,11 +1,11 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE part SYSTEM "part.dtd"> <part> <header> <copyright> <year>2006</year> - <year>2011</year> + <year>2013</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> diff --git a/lib/observer/doc/src/ref_man.xml b/lib/observer/doc/src/ref_man.xml index c33ce74141..c3805b2d86 100644 --- a/lib/observer/doc/src/ref_man.xml +++ b/lib/observer/doc/src/ref_man.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE application SYSTEM "application.dtd"> <application xmlns:xi="http://www.w3.org/2001/XInclude"> <header> <copyright> - <year>2002</year><year>2011</year> + <year>2002</year><year>2013</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -38,5 +38,6 @@ <xi:include href="ttb.xml"/> <xi:include href="etop.xml"/> <xi:include href="crashdump.xml"/> + <xi:include href="cdv.xml"/> </application> diff --git a/lib/observer/doc/src/ttb.xml b/lib/observer/doc/src/ttb.xml index 1453bbdf10..6e60a9cb3b 100644 --- a/lib/observer/doc/src/ttb.xml +++ b/lib/observer/doc/src/ttb.xml @@ -1,11 +1,11 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd"> <erlref> <header> <copyright> <year>2002</year> - <year>2011</year> + <year>2013</year> <holder>Ericsson AB, All Rights Reserved</holder> </copyright> <legalnotice> diff --git a/lib/observer/doc/src/ttb_ug.xml b/lib/observer/doc/src/ttb_ug.xml index 402d079c2c..a1740b618e 100644 --- a/lib/observer/doc/src/ttb_ug.xml +++ b/lib/observer/doc/src/ttb_ug.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE chapter SYSTEM "chapter.dtd"> <chapter> <header> <copyright> - <year>2002</year><year>2011</year> + <year>2002</year><year>2013</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> |
