appserver/admingui/common/src/main/help/en/help/ref-logviewer.html

<!--

    Copyright (c) 2005, 2018 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->

<p><a id="ref-logviewer" name="ref-logviewer"></a><a id="GHCOM00059" name="GHCOM00059"></a></p>

<h4><a id="sthref138" name="sthref138"></a><a id="sthref139" name="sthref139"></a><a id="sthref140" name="sthref140"></a>Log Viewer</h4>
<a name="BEGIN" id="BEGIN"></a>
<p>Use the Log Viewer page to view the log files for selected GlassFish Server instances and clusters and to customize the log display.</p>
<p>The Log Viewer page contains four areas:</p>
<ul>
<li>
<p>Search Criteria</p>
</li>
<li>
<p>Advanced Search</p>
</li>
<li>
<p>Modify Search</p>
</li>
<li>
<p>Search Results</p>
</li>
</ul>
<p>The Search Criteria area contains the following options.</p>
<dl>
<dt>Advanced Search</dt>
<dd>
<p>Clicking this link opens an area that allows you to make additional refinements to the log viewer.</p>
</dd>
<dt>Timestamp</dt>
<dd>
<p>The Most Recent radio button displays the most recent messages. The Specific Range radio button opens From and To fields that allow you to view messages only from a certain period of time.</p>
<p>For the Time value, the syntax must take the following form (<i>SSS</i> stands for milliseconds):</p>
<pre>
<i>hh</i>:<i>mm</i>:<i>ss</i>.<i>SSS</i>
</pre>
<p>For example:</p>
<pre>
17:10:00.000
</pre>
<p>If the From value is later than the To value, an error message appears.</p>
</dd>
<dt>Log Level</dt>
<dd>
<p>The selected log level for filtering. By default, the display includes all messages that appear in the server log at the chosen log level and more severe levels. Select the checkbox labeled "Do not include more severe messages" to display messages at only the chosen level.</p>
<p>To ensure that the messages you want to view appear in the server log, first set the appropriate log levels on the Module Log Levels page. See <a href="task-eelogginglevels.html">To Configure Log Levels</a>.</p>
<p>If you choose to filter log messages based on log level, only messages matching the specified filter criteria are shown. However, this filtering does not affect which messages are logged to the server log.</p>
</dd>
</dl>
<p>The Advanced Search area contains the following options.</p>
<dl>
<dt>Logger</dt>
<dd>
<p>Logger namespaces to filter by module. Use shift-click or control-click to choose multiple namespaces.</p>
<p>Selecting a namespace at a higher level selects all the namespaces below it. For example, selecting <code>jakarta.enterprise.system</code> also selects the loggers for all the modules under that namespace: <code>jakarta.enterprise.system.core</code>, <code>jakarta.enterprise.system.tools.admin</code>, and so on.</p>
</dd>
<dt>Custom Logger</dt>
<dd>
<p>Loggers specific to a particular application, one per line.</p>
<p>If the application has several modules, you can view any or all of them. For example, suppose the application has loggers with the following names:</p>
<pre>
com.mycompany.myapp.module1
com.mycompany.myapp.module2
com.mycompany.myapp.module3
</pre>
<p>To view messages from all modules in the application, type <code>com.mycompany.myapp</code>. To view messages from <code>module2</code> only, type <code>com.mycompany.myapp.module2</code>.</p>
<p>When you specify one or more custom loggers, messages from GlassFish Server modules appear only if you specify them explicitly in the Logger area.</p>
</dd>
<dt>Display</dt>
<dd>
<p>The number of messages to view at a time. The default number of messages displayed is 40. Other choices are 100, 250, and 1000.</p>
<p>To view stack traces, deselect the "Limit excessively long messages" checkbox. By default, stack traces do not appear in the viewer; to view them, click the <code>(details)</code> link for a message.</p>
</dd>
</dl>
<p>The Modify Search area lets you specify the server instance or cluster and the name of an associated log file to view.</p>
<dl>
<dt>Instance</dt>
<dd>
<p>The server instance or cluster for which log records will be displayed. The default is server. Other choices depend on the clusters and instances that may be defined and enabled for the domain.</p>
</dd>
<dt>Log File</dt>
<dd>
<p>The name of the log file you want to display. The default is <code>server.log</code>. Other choices depend on the log settings for the selected target.</p>
</dd>
</dl>
<p>The Log Viewer Results table displays the server log messages. Use the Records before and Records after buttons at the top of the table to choose the range of records you want to view.</p>
<p>For each message, the Log Viewer Results table contains the following information.</p>
<dl>
<dt>Record Number</dt>
<dd>
<p>The number of the message in the server log.</p>
</dd>
<dt>Log Level</dt>
<dd>
<p>The log level of the message.</p>
</dd>
<dt>Message</dt>
<dd>
<p>The brief text of the log message. Click the <code>(details)</code> link to view a formatted version of a message.</p>
</dd>
<dt>Logger</dt>
<dd>
<p>The logger module that generated the log message.</p>
</dd>
<dt>Timestamp</dt>
<dd>
<p>The date and time when the log message was issued.</p>
</dd>
<dt>Name/Value Pairs</dt>
<dd>
<p>The thread name and ID of the log message.</p>
</dd>
</dl>
<a id="GHCOM354" name="GHCOM354"></a>
<h5>Related Tasks</h5>
<ul>
<li>
<p><a href="task-eelogging.html">To Configure General Logging Settings</a></p>
</li>
<li>
<p><a href="task-eelogginglevels.html">To Configure Log Levels</a></p>
</li>
<li>
<p><a href="task-logviewer.html">To View Log Files for the DAS</a></p>
</li>
</ul>
<a id="GHCOM355" name="GHCOM355"></a>
<h5>Related asadmin Commands</h5>
<ul>
<li>
<p><code>set-log-level</code></p>
</li>
<li>
<p><a href="http://www.oracle.com/pls/topic/lookup?ctx=E26576_01&id=GSRFM00224"><code>rotate-log</code>(1)</a></p>
</li>
</ul>


<small>Copyright &#169; 2005, 2017, Oracle and/or its affiliates. All rights reserved. <a href="docinfo.html">Legal Notices</a></small>