| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src/site/apt/viewing-log-events.apt at 2022-05-30 |
| | Rendered using Apache Maven Fluido Skin 1.8 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" /> |
| <title>Apache Chainsaw – </title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.8.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-1.8.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><a href="http://logging.apache.org/" id="bannerLeft"><img src="images/ls-logo.jpg" alt="Logging Services"/></a></div> |
| <div class="pull-right"><a href="../log4j/2.x/" id="bannerRight"><img src="images/logo.png" alt="Apache log4j"/></a></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2022-05-30<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 2.2.0-SNAPSHOT<span class="divider">|</span></li> |
| <li class=""><a href="http://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> |
| <li class=""><a href="http://logging.apache.org/" class="externalLink" title="Logging Services">Logging Services</a><span class="divider">/</span></li> |
| <li class=""><a href="http://logging.apache.org:80/chainsaw/" class="externalLink" title="Chainsaw">Chainsaw</a><span class="divider">/</span></li> |
| <li class="active "></li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Get Chainsaw</li> |
| <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> |
| <li><a href="changes-report.html" title="Changes"><span class="none"></span>Changes</a></li> |
| <li><a href="https://www.apache.org/licenses/LICENSE-2.0" class="externalLink" title="License"><span class="none"></span>License</a></li> |
| <li><a href="distributionnotes.html" title="Important Distribution Notes"><span class="none"></span>Important Distribution Notes</a></li> |
| <li class="nav-header">About Chainsaw</li> |
| <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="quicktour.html" title="Quick Tour"><span class="none"></span>Quick Tour</a></li> |
| <li><a href="zeroconf.html" title="Zeroconf"><span class="none"></span>Zeroconf</a></li> |
| <li><a href="roadmap.html" title="Roadmap"><span class="none"></span>Roadmap</a></li> |
| <li><a href="apidocs/index.html" title="JavaDoc"><span class="none"></span>JavaDoc</a></li> |
| <li class="nav-header">Manual</li> |
| <li class="active"><a href="#"><span class="none"></span>Viewing Log Events</a></li> |
| <li><a href="colorizing-output.html" title="Colorizing Output"><span class="none"></span>Colorizing Output</a></li> |
| <li><a href="expression-rules.html" title="Expression Rules"><span class="none"></span>Expression Rules</a></li> |
| <li><a href="configuration-library.html" title="Configuration Library"><span class="none"></span>Configuration Library</a></li> |
| <li class="nav-header">Community</li> |
| <li><a href="mail-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a></li> |
| <li><a href="issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a></li> |
| <li class="nav-header">Development</li> |
| <li><a href="source-repository.html" title="Repository"><span class="none"></span>Repository</a></li> |
| <li><a href="xref/index.html" title="Cross Reference"><span class="none"></span>Cross Reference</a></li> |
| <li><a href="dependencies.html" title="Dependencies"><span class="none"></span>Dependencies</a></li> |
| <li><a href="cpd.html" title="Duplication"><span class="none"></span>Duplication</a></li> |
| <li><a href="pmd.html" title="PMD"><span class="none"></span>PMD</a></li> |
| <li class="nav-header">Apache</li> |
| <li><a href="http://www.apache.org" class="externalLink" title="Home"><span class="none"></span>Home</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> |
| <li><a href="https://www.apache.org/security/" class="externalLink" title="Security"><span class="none"></span>Security</a></li> |
| <li><a href="http://www.apachecon.com" class="externalLink" title="Conferences"><span class="none"></span>Conferences</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10" > |
| <section> |
| <h2><a name="Viewing_Log_Events"></a>Viewing Log Events</h2> |
| <p>When viewing a lot of information, the main viewing screen looks as follows:</p><figure><img src="images/chainsaw-log-panel.png" alt="" /></figure> |
| <p>There are three main parts of the screen that we will go over now.</p></section><section> |
| <h2><a name="Logger_Pane"></a>Logger Pane</h2> |
| <p>On the left side of the screen, we have the logger pane:</p><figure><img src="images/logger-pane.png" alt="" /></figure> |
| <p>This pane displays all of the loggers that we have seen messages from. The loggers that have been seen can be interacted with. For example, right-clicking on a logger brings up a context menu that will allow you to do different operations, such as:</p> |
| <ul> |
| <li>Focusing/ignoring a specified logger</li> |
| <li>Adding a color rule for a logger</li> |
| <li>Adding information to the 'find' field</li></ul></section><section> |
| <h2><a name="Log_Messages"></a>Log Messages</h2> |
| <p>In the center of the screen we have the main log viewing area. </p><figure><img src="images/log-pane.png" alt="" /></figure> |
| <p>This contains all of the log messages that we have seen from this receiver. Each log event is a separate row in this table, and each field in the log event corresponds to a column.</p> |
| <p>Right-clicking in this area brings up a context menu. From this context menu, you may perform several actions. You can perform several actions on the data, some of which overlap with the logger pane. Note that these actions are not based off of the entire log message, but rather what column you have clicked on. For example, making a color rule when you right-click on the LOGGER column will create a rule based off of the currently selected logger name. If you instead click on the LEVEL column, the rule will be based off of the curren level.</p> |
| <p>Some of the actions that you can perform on the table are:</p> |
| <ul> |
| <li>Add value under cursor to 'Refine Focus' field</li> |
| <li>Add value under cursor to 'Find' field</li> |
| <li>Change how the relative times are displayed</li> |
| <li>Define a color rule </li> |
| <li>Copy an entry to the clipboard(column or log event)</li> |
| <li>Show/hide different panes</li> |
| <li>Undock into a new window</li> |
| <li>Best-fit the column for the given data</li></ul> |
| <p>At the top of the pane are two text boxes that are used for searching/filtering. The one on the left, 'Refine Focus', lets you focus on different parts of the information. For example, you can refine focus on a logger by using an <a href="./expression-rules.html">expression rule</a>. This allows you to quickly filter messages based off of their attributes. When using the 'Refine Focus' box, log messages that do not match are automatically hidden so as to not clutter the screen.</p> |
| <p>The 'Find' field on the other hand is a traditional search bar. It will search through the messages for interesting data without hiding log events that don't match. An expression rule can also be defined here to search for information.</p></section><section> |
| <h2><a name="Detail_Pane"></a>Detail Pane</h2> |
| <p>At the very bottom of the screen, we have the detail pane:</p><figure><img src="images/details-pane.png" alt="" /></figure> |
| <p>This pane shows information about the currently selected log message. The exact details shown in this pane can be customized by right-clicking and bringing up a context menu.</p></section> |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright © 2002–2022<a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| .</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
