| 1 | <?xml version='1.0' encoding='UTF-8'?>
|
|---|
| 2 | <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
|
|---|
| 3 | <topic xml:lang="en-us" id="log-viewer">
|
|---|
| 4 | <title>The Log Viewer</title>
|
|---|
| 5 |
|
|---|
| 6 | <body>
|
|---|
| 7 | <p>Every time you start up a VM, <ph conkeyref="vbox-conkeyref-phrases/product-name"/> creates a log file that
|
|---|
| 8 | records system configuration and events. The <b outputclass="bold">Log Viewer</b> is a <ph
|
|---|
| 9 | conkeyref="vbox-conkeyref-phrases/vbox-mgr"/> tool that enables you to view and analyze system logs. </p>
|
|---|
| 10 | <!-- 7.1: New pic required? Tab operation changed. Log Viewer/Filter pane. bugref:10496 -->
|
|---|
| 11 | <fig id="fig-log-viewer-tool">
|
|---|
| 12 | <title>Log Viewer Tool, Showing System Events</title>
|
|---|
| 13 | <xref href="images/log-viewer.png" format="png" platform="htmlhelp">
|
|---|
| 14 | <image href="images/log-viewer.png" width="10cm" placement="break">
|
|---|
| 15 | <alt>Log Viewer Tool, Showing System Events</alt>
|
|---|
| 16 | </image>
|
|---|
| 17 | </xref>
|
|---|
| 18 | <image platform="ohc" href="images/log-viewer.png" width="10cm" placement="break">
|
|---|
| 19 | <alt>Log Viewer Tool, Showing System Events</alt>
|
|---|
| 20 | </image>
|
|---|
| 21 | </fig>
|
|---|
| 22 | <p>To display the Log Viewer, do either of the following: </p>
|
|---|
| 23 | <ul>
|
|---|
| 24 | <li>
|
|---|
| 25 | <p>Click the VM name in the machine list and select <b outputclass="bold">Logs</b> from the machine tools menu. </p>
|
|---|
| 26 | </li>
|
|---|
| 27 | <li>
|
|---|
| 28 | <p>In the guest VM, select <b outputclass="bold">Machine</b>, <b outputclass="bold">Show Log</b>. </p>
|
|---|
| 29 | </li>
|
|---|
| 30 | </ul>
|
|---|
| 31 | <p>Log messages for the VM are displayed in tabs in the Log Viewer window. See <xref href="collect-debug-info.dita"
|
|---|
| 32 | >Collecting Debugging Information</xref> for details of the various log files generated by <ph
|
|---|
| 33 | conkeyref="vbox-conkeyref-phrases/product-name"/>. </p>
|
|---|
| 34 | <p>If you select multiple VMs in the machine list, logs are listed for each VM. </p>
|
|---|
| 35 | <p>The toolbar of the Log Viewer includes the following options: </p>
|
|---|
| 36 | <ul>
|
|---|
| 37 | <li>
|
|---|
| 38 | <p><b outputclass="bold">Save:</b> Exports the contents of
|
|---|
| 39 | the selected log file to a text file. Specify the destination
|
|---|
| 40 | filename and location in the displayed dialog.
|
|---|
| 41 | </p>
|
|---|
| 42 | </li>
|
|---|
| 43 | <li>
|
|---|
| 44 | <p><b outputclass="bold">Find:</b> Searches for a text
|
|---|
| 45 | string in the log file.
|
|---|
| 46 | </p>
|
|---|
| 47 | </li>
|
|---|
| 48 | <li>
|
|---|
| 49 | <p><b outputclass="bold">Filter:</b> Uses filter terms to
|
|---|
| 50 | display specific types of log messages. Common log message
|
|---|
| 51 | terms used by <ph conkeyref="vbox-conkeyref-phrases/product-name"/>, such as Audio and NAT, are
|
|---|
| 52 | included by default. Select one or more terms from the
|
|---|
| 53 | drop-down list. To add your own filter term, enter the text
|
|---|
| 54 | string in the text box field.
|
|---|
| 55 | </p>
|
|---|
| 56 | </li>
|
|---|
| 57 | <li>
|
|---|
| 58 | <p><b outputclass="bold">Bookmark:</b> Saves the location of a log message, enabling you to
|
|---|
| 59 | find it quickly. To create a bookmark, either click the line number, or select some text
|
|---|
| 60 | and then click <b outputclass="bold">Bookmark</b>. </p>
|
|---|
| 61 | </li>
|
|---|
| 62 | <li>
|
|---|
| 63 | <p><b outputclass="bold">Preferences:</b> Configures the text display used in the log
|
|---|
| 64 | message window. </p>
|
|---|
| 65 | </li>
|
|---|
| 66 | <li>
|
|---|
| 67 | <p><b outputclass="bold">Refresh:</b> Refreshes the log
|
|---|
| 68 | file you are currently viewing. Only log messages in the
|
|---|
| 69 | current tab are updated.
|
|---|
| 70 | </p>
|
|---|
| 71 | </li>
|
|---|
| 72 | <li>
|
|---|
| 73 | <p><b outputclass="bold">Reload:</b> Refreshes all log
|
|---|
| 74 | files. Log messages in every tab are updated.
|
|---|
| 75 | </p>
|
|---|
| 76 | </li>
|
|---|
| 77 | <li>
|
|---|
| 78 | <p><b outputclass="bold">Settings:</b> Displays the
|
|---|
| 79 | <b outputclass="bold">Settings</b> window for the VM,
|
|---|
| 80 | enabling you to make configuration changes.
|
|---|
| 81 | </p>
|
|---|
| 82 | </li>
|
|---|
| 83 | <li>
|
|---|
| 84 | <p><b outputclass="bold">Discard:</b> For a running VM,
|
|---|
| 85 | discards the saved state for the VM and closes it down.
|
|---|
| 86 | </p>
|
|---|
| 87 | </li>
|
|---|
| 88 | <li>
|
|---|
| 89 | <p><b outputclass="bold">Show/Start:</b> For a running VM,
|
|---|
| 90 | <b outputclass="bold">Show</b> displays the VM window.
|
|---|
| 91 | For a stopped VM, <b outputclass="bold">Start</b>
|
|---|
| 92 | displays options for powering up the VM.
|
|---|
| 93 | </p>
|
|---|
| 94 | </li>
|
|---|
| 95 | </ul>
|
|---|
| 96 | </body>
|
|---|
| 97 |
|
|---|
| 98 | </topic>
|
|---|
