238 lines
6.5 KiB
HTML
238 lines
6.5 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>
|
|
Module: Rex::Logging
|
|
|
|
— Documentation by YARD 0.9.37
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
|
|
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
pathId = "Rex::Logging";
|
|
relpath = '../';
|
|
</script>
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<div class="nav_wrap">
|
|
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
<div id="resizer"></div>
|
|
</div>
|
|
|
|
<div id="main" tabindex="-1">
|
|
<div id="header">
|
|
<div id="menu">
|
|
|
|
<a href="../_index.html">Index (L)</a> »
|
|
<span class='title'><span class='object_link'><a href="../Rex.html" title="Rex (module)">Rex</a></span></span>
|
|
»
|
|
<span class="title">Logging</span>
|
|
|
|
</div>
|
|
|
|
<div id="search">
|
|
|
|
<a class="full_list_link" id="class_list_link"
|
|
href="../class_list.html">
|
|
|
|
<svg width="24" height="24">
|
|
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
</svg>
|
|
</a>
|
|
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
|
|
<div id="content"><h1>Module: Rex::Logging
|
|
|
|
|
|
|
|
</h1>
|
|
<div class="box_info">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
<dt>Defined in:</dt>
|
|
<dd>lib/rex/logging.rb<span class="defines">,<br />
|
|
lib/rex/logging/log_sink.rb,<br /> lib/rex/logging/sinks/stderr.rb,<br /> lib/rex/logging/sinks/stdout.rb,<br /> lib/rex/logging/sinks/stream.rb,<br /> lib/rex/logging/log_dispatcher.rb,<br /> lib/rex/logging/sinks/flatfile.rb,<br /> lib/rex/logging/log_sink_factory.rb,<br /> lib/rex/logging/sinks/stdout_without_timestamps.rb,<br /> lib/rex/logging/sinks/timestamp_colorless_flatfile.rb</span>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
<h2>Defined Under Namespace</h2>
|
|
<p class="children">
|
|
|
|
|
|
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Logging/LogSink.html" title="Rex::Logging::LogSink (module)">LogSink</a></span>, <span class='object_link'><a href="Logging/LogSinkFactory.html" title="Rex::Logging::LogSinkFactory (module)">LogSinkFactory</a></span>, <span class='object_link'><a href="Logging/Sinks.html" title="Rex::Logging::Sinks (module)">Sinks</a></span>
|
|
|
|
|
|
|
|
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Logging/LogDispatcher.html" title="Rex::Logging::LogDispatcher (class)">LogDispatcher</a></span>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<h2>
|
|
Constant Summary
|
|
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
</h2>
|
|
|
|
<dl class="constants">
|
|
|
|
<dt id="LOG_ERROR-constant" class="">LOG_ERROR =
|
|
<div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Log severities</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div>
|
|
</dt>
|
|
<dd><pre class="code"><span class='symbol'>:error</span></pre></dd>
|
|
|
|
<dt id="LOG_DEBUG-constant" class="">LOG_DEBUG =
|
|
|
|
</dt>
|
|
<dd><pre class="code"><span class='symbol'>:debug</span></pre></dd>
|
|
|
|
<dt id="LOG_INFO-constant" class="">LOG_INFO =
|
|
|
|
</dt>
|
|
<dd><pre class="code"><span class='symbol'>:info</span></pre></dd>
|
|
|
|
<dt id="LOG_WARN-constant" class="">LOG_WARN =
|
|
|
|
</dt>
|
|
<dd><pre class="code"><span class='symbol'>:warn</span></pre></dd>
|
|
|
|
<dt id="LOG_RAW-constant" class="">LOG_RAW =
|
|
|
|
</dt>
|
|
<dd><pre class="code"><span class='symbol'>:raw</span></pre></dd>
|
|
|
|
<dt id="LEV_0-constant" class="">LEV_0 =
|
|
<div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>LEV_0 - Default</p>
|
|
|
|
<p>This log level is the default log level if none is specified. It should be used when a log message should always be displayed when logging is enabled. Very few log messages should occur at this level aside from necessary information logging and error/warning logging. Debug logging at level zero is not advised.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div>
|
|
</dt>
|
|
<dd><pre class="code"><span class='int'>0</span></pre></dd>
|
|
|
|
<dt id="LEV_1-constant" class="">LEV_1 =
|
|
<div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>LEV_1 - Extra</p>
|
|
|
|
<p>This log level should be used when extra information may be needed to understand the cause of an error or warning message or to get debugging information that might give clues as to why something is happening. This log level should be used only when information may be useful to understanding the behavior of something at a basic level. This log level should not be used in an exhaustively verbose fashion.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div>
|
|
</dt>
|
|
<dd><pre class="code"><span class='int'>1</span></pre></dd>
|
|
|
|
<dt id="LEV_2-constant" class="">LEV_2 =
|
|
<div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>LEV_2 - Verbose</p>
|
|
|
|
<p>This log level should be used when verbose information may be needed to analyze the behavior of the framework. This should be the default log level for all detailed information not falling into LEV_0 or LEV_1. It is recommended that this log level be used by default if you are unsure.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div>
|
|
</dt>
|
|
<dd><pre class="code"><span class='int'>2</span></pre></dd>
|
|
|
|
<dt id="LEV_3-constant" class="">LEV_3 =
|
|
<div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>LEV_3 - Insanity</p>
|
|
|
|
<p>This log level should contain very verbose information about the behavior of the framework, such as detailed information about variable states at certain phases including, but not limited to, loop iterations, function calls, and so on. This log level will rarely be displayed, but when it is the information provided should make it easy to analyze any problem.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div>
|
|
</dt>
|
|
<dd><pre class="code"><span class='int'>3</span></pre></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
Generated on Fri May 8 17:03:08 2026 by
|
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.9.37 (ruby-3.1.5).
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html> |