adam/metasploit-gs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
c3f5bd3de2d1affa01e2f6c2066c6bb0fc6413bc
metasploit-gs/api/Msf/Logging.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

903 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Msf::Logging
&mdash; 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 = "Msf::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> &raquo;
<span class='title'><span class='object_link'><a href="../Msf.html" title="Msf (module)">Msf</a></span></span>
&raquo;
<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>Class: Msf::Logging
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Msf::Logging</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/msf/base/logging.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This module provides an initialization interface for logging.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="initialized-classvariable" class="">@@initialized =
<div class="docstring">
<div class="discussion">
<p>Is logging initialized</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='kw'>false</span></pre></dd>
<dt id="session_logging-classvariable" class="">@@session_logging =
<div class="docstring">
<div class="discussion">
<p>Is session logging enabled</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='kw'>false</span></pre></dd>
</dl>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#disable_log_source-class_method" title="disable_log_source (class method)">.<strong>disable_log_source</strong>(src) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Stops logging for a given log source.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enable_log_source-class_method" title="enable_log_source (class method)">.<strong>enable_log_source</strong>(src, level = 0) &#x21d2; void </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Enables a log source of name src.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#enable_session_logging-class_method" title="enable_session_logging (class method)">.<strong>enable_session_logging</strong>(tf) &#x21d2; void </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Sets whether or not session logging is to be enabled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#init-class_method" title="init (class method)">.<strong>init</strong>(log_sink_name = nil) &#x21d2; void </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Initialize logging.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#session_logging_enabled%3F-class_method" title="session_logging_enabled? (class method)">.<strong>session_logging_enabled?</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns whether or not session logging is enabled.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#start_session_log-class_method" title="start_session_log (class method)">.<strong>start_session_log</strong>(session) &#x21d2; void </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Starts logging for a given session.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stop_session_log-class_method" title="stop_session_log (class method)">.<strong>stop_session_log</strong>(session) &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Stops logging for a given session.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="disable_log_source-class_method">
.<strong>disable_log_source</strong>(src) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Stops logging for a given log source.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>src</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>the log source to disable.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>true if successful. false if not.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/base/logging.rb', line 60</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_disable_log_source'>disable_log_source</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='rparen'>)</span>
<span class='id identifier rubyid_deregister_log_source'><span class='object_link'><a href="../top-level-namespace.html#deregister_log_source-instance_method" title="#deregister_log_source (method)">deregister_log_source</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enable_log_source-class_method">
.<strong>enable_log_source</strong>(src, level = 0) &#x21d2; <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
<p>Enables a log source of name src. Creates the .log file in the configured directory if logging is not already enabled for this source.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>src</span>
<span class='type'>(<tt>String</tt>)</span>
&mdash;
<div class='inline'>
<p>log source name.</p>
</div>
</li>
<li>
<span class='name'>level</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>0</tt>)</em>
&mdash;
<div class='inline'>
<p>logging level.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49
50
51
52
53
54</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/base/logging.rb', line 47</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enable_log_source'>enable_log_source</span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_level'>level</span> <span class='op'>=</span> <span class='int'>0</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_log_source_registered?'><span class='object_link'><a href="../top-level-namespace.html#log_source_registered%3F-instance_method" title="#log_source_registered? (method)">log_source_registered?</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rex/Logging.html" title="Rex::Logging (module)">Logging</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rex/Logging/Sinks.html" title="Rex::Logging::Sinks (module)">Sinks</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rex/Logging/Sinks/Flatfile.html" title="Rex::Logging::Sinks::Flatfile (class)">Flatfile</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Rex/Logging/Sinks/Flatfile.html#initialize-instance_method" title="Rex::Logging::Sinks::Flatfile#initialize (method)">new</a></span></span><span class='lparen'>(</span>
<span class='const'><span class='object_link'><a href="../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Config.html" title="Msf::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_log_directory'><span class='object_link'><a href="Config.html#log_directory-class_method" title="Msf::Config.log_directory (method)">log_directory</a></span></span> <span class='op'>+</span> <span class='const'>File</span><span class='op'>::</span><span class='const'>SEPARATOR</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_src'>src</span><span class='embexpr_end'>}</span><span class='tstring_content'>.log</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_register_log_source'><span class='object_link'><a href="../top-level-namespace.html#register_log_source-instance_method" title="#register_log_source (method)">register_log_source</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_f'>f</span><span class='comma'>,</span> <span class='id identifier rubyid_level'>level</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="enable_session_logging-class_method">
.<strong>enable_session_logging</strong>(tf) &#x21d2; <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
<p>Sets whether or not session logging is to be enabled.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>tf</span>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>true if enabling. false if disabling.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/base/logging.rb', line 68</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_enable_session_logging'>enable_session_logging</span><span class='lparen'>(</span><span class='id identifier rubyid_tf'>tf</span><span class='rparen'>)</span>
<span class='cvar'>@@session_logging</span> <span class='op'>=</span> <span class='id identifier rubyid_tf'>tf</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="init-class_method">
.<strong>init</strong>(log_sink_name = nil) &#x21d2; <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
<p>Initialize logging.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>log_sink_name</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>Log sink name.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/base/logging.rb', line 19</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_init'>init</span><span class='lparen'>(</span><span class='id identifier rubyid_log_sink_name'>log_sink_name</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='op'>!</span> <span class='cvar'>@@initialized</span><span class='rparen'>)</span>
<span class='cvar'>@@initialized</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='id identifier rubyid_log_sink'>log_sink</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rex/Logging.html" title="Rex::Logging (module)">Logging</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rex/Logging/LogSinkFactory.html" title="Rex::Logging::LogSinkFactory (module)">LogSinkFactory</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Rex/Logging/LogSinkFactory.html#new-class_method" title="Rex::Logging::LogSinkFactory.new (method)">new</a></span></span><span class='lparen'>(</span>
<span class='id identifier rubyid_log_sink_name'>log_sink_name</span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Config.html" title="Msf::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_log_directory'><span class='object_link'><a href="Config.html#log_directory-class_method" title="Msf::Config.log_directory (method)">log_directory</a></span></span> <span class='op'>+</span> <span class='const'>File</span><span class='op'>::</span><span class='const'>SEPARATOR</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>framework.log</span><span class='tstring_end'>&quot;</span></span>
<span class='rparen'>)</span>
<span class='comment'># Register each known log source
</span> <span class='lbracket'>[</span>
<span class='const'><span class='object_link'><a href="../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'>LogSource</span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'>Socket</span><span class='op'>::</span><span class='const'>LogSource</span><span class='comma'>,</span>
<span class='const'><span class='object_link'><a href="../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'>LogSource</span><span class='comma'>,</span>
<span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>base</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
<span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_src'>src</span><span class='op'>|</span>
<span class='id identifier rubyid_register_log_source'><span class='object_link'><a href="../top-level-namespace.html#register_log_source-instance_method" title="#register_log_source (method)">register_log_source</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_src'>src</span><span class='comma'>,</span> <span class='id identifier rubyid_log_sink'>log_sink</span><span class='rparen'>)</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="session_logging_enabled?-class_method">
.<strong>session_logging_enabled?</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns whether or not session logging is enabled.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>true if enabled. false if disabled.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
75
76
77</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/base/logging.rb', line 75</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_session_logging_enabled?'>session_logging_enabled?</span>
<span class='cvar'>@@session_logging</span> <span class='op'>||</span> <span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="start_session_log-class_method">
.<strong>start_session_log</strong>(session) &#x21d2; <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>
<p>Starts logging for a given session.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>session</span>
<span class='type'>(<tt><span class='object_link'><a href="Session.html" title="Msf::Session (module)">Msf::Session</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>the session to start logging on.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
83
84
85
86
87
88
89
90
91
92</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/base/logging.rb', line 83</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_start_session_log'>start_session_log</span><span class='lparen'>(</span><span class='id identifier rubyid_session'>session</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_log_source_registered?'><span class='object_link'><a href="../top-level-namespace.html#log_source_registered%3F-instance_method" title="#log_source_registered? (method)">log_source_registered?</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_log_source'>log_source</span><span class='rparen'>)</span> <span class='op'>==</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rex/Logging.html" title="Rex::Logging (module)">Logging</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rex/Logging/Sinks.html" title="Rex::Logging::Sinks (module)">Sinks</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Rex/Logging/Sinks/TimestampColorlessFlatfile.html" title="Rex::Logging::Sinks::TimestampColorlessFlatfile (class)">TimestampColorlessFlatfile</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Rex/Logging/Sinks/Flatfile.html#initialize-instance_method" title="Rex::Logging::Sinks::Flatfile#initialize (method)">new</a></span></span><span class='lparen'>(</span>
<span class='const'><span class='object_link'><a href="../Msf.html" title="Msf (module)">Msf</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Config.html" title="Msf::Config (class)">Config</a></span></span><span class='period'>.</span><span class='id identifier rubyid_session_log_directory'><span class='object_link'><a href="Config.html#session_log_directory-class_method" title="Msf::Config.session_log_directory (method)">session_log_directory</a></span></span> <span class='op'>+</span> <span class='const'>File</span><span class='op'>::</span><span class='const'>SEPARATOR</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_log_file_name'>log_file_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>.log</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_register_log_source'><span class='object_link'><a href="../top-level-namespace.html#register_log_source-instance_method" title="#register_log_source (method)">register_log_source</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_log_source'>log_source</span><span class='comma'>,</span> <span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span>
<span class='id identifier rubyid_rlog'><span class='object_link'><a href="../top-level-namespace.html#rlog-instance_method" title="#rlog (method)">rlog</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[*] Logging started: </span><span class='embexpr_beg'>#{</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n\n</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_log_source'>log_source</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="stop_session_log-class_method">
.<strong>stop_session_log</strong>(session) &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Stops logging for a given session.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>session</span>
<span class='type'>(<tt><span class='object_link'><a href="Session.html" title="Msf::Session (module)">Msf::Session</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>the session to stop logging.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>true if successful. false if not.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98
99
100
101
102</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/msf/base/logging.rb', line 98</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_stop_session_log'>stop_session_log</span><span class='lparen'>(</span><span class='id identifier rubyid_session'>session</span><span class='rparen'>)</span>
<span class='id identifier rubyid_rlog'><span class='object_link'><a href="../top-level-namespace.html#rlog-instance_method" title="#rlog (method)">rlog</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n[*] Logging stopped: </span><span class='embexpr_beg'>#{</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n\n</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_log_source'>log_source</span><span class='rparen'>)</span>
<span class='id identifier rubyid_deregister_log_source'><span class='object_link'><a href="../top-level-namespace.html#deregister_log_source-instance_method" title="#deregister_log_source (method)">deregister_log_source</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_log_source'>log_source</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:03:15 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>
Reference in New Issue View Git Blame Copy Permalink