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