+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Log</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Log</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/log_rb.html">
- lib/mcollective/log.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-A simple class that allows logging at various levels.
-</p>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000440">check_level</a>
- <a href="#M000439">config_and_check_level</a>
- <a href="#M000447">configure</a>
- <a href="#M000438">cycle_level</a>
- <a href="#M000434">debug</a>
- <a href="#M000436">error</a>
- <a href="#M000450">execution_stack</a>
- <a href="#M000435">fatal</a>
- <a href="#M000449">from</a>
- <a href="#M000432">info</a>
- <a href="#M000437">instance</a>
- <a href="#M000445">log</a>
- <a href="#M000443">logexception</a>
- <a href="#M000431">logger</a>
- <a href="#M000444">logmsg</a>
- <a href="#M000442">message_for</a>
- <a href="#M000446">set_logger</a>
- <a href="#M000448">unconfigure</a>
- <a href="#M000441">valid_level?</a>
- <a href="#M000433">warn</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
- <div id="constants-list">
- <h3 class="section-bar">Constants</h3>
-
- <div class="name-list">
- <table summary="Constants">
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">VALID_LEVELS</td>
- <td>=</td>
- <td class="context-item-value">[:error, :fatal, :debug, :warn, :info]</td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000440" class="method-detail">
- <a name="M000440"></a>
-
- <div class="method-heading">
- <a href="#M000440" class="method-signature">
- <span class="method-name">check_level</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000440-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000440-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 55</span>
-55: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check_level</span>(<span class="ruby-identifier">level</span>)
-56: <span class="ruby-identifier">raise</span> <span class="ruby-value str">"Unknown log level"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_level?</span>(<span class="ruby-identifier">level</span>)
-57: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000439" class="method-detail">
- <a name="M000439"></a>
-
- <div class="method-heading">
- <a href="#M000439" class="method-signature">
- <span class="method-name">config_and_check_level</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000439-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000439-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 49</span>
-49: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
-50: <span class="ruby-identifier">configure</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@configured</span>
-51: <span class="ruby-identifier">check_level</span>(<span class="ruby-identifier">level</span>)
-52: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">should_log?</span>(<span class="ruby-identifier">level</span>)
-53: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000447" class="method-detail">
- <a name="M000447"></a>
-
- <div class="method-heading">
- <a href="#M000447" class="method-signature">
- <span class="method-name">configure</span><span class="method-args">(logger=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-configures the <a href="Log.html#M000431">logger</a> class, if the config
-has not yet been loaded we default to the console logging class and do not
-set @configured so that future calls to the <a
-href="Log.html#M000445">log</a> method will keep attempting to <a
-href="Log.html#M000447">configure</a> the <a
-href="Log.html#M000431">logger</a> till we eventually get a logging
-preference <a href="Log.html#M000449">from</a> the config module
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000447-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000447-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 130</span>
-130: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">configure</span>(<span class="ruby-identifier">logger</span>=<span class="ruby-keyword kw">nil</span>)
-131: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">logger</span>
-132: <span class="ruby-identifier">logger_type</span> = <span class="ruby-value str">"console"</span>
-133:
-134: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-135:
-136: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">configured</span>
-137: <span class="ruby-identifier">logger_type</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">logger_type</span>
-138: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">true</span>
-139: <span class="ruby-keyword kw">end</span>
-140:
-141: <span class="ruby-identifier">require</span> <span class="ruby-value str">"mcollective/logger/%s_logger"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">logger_type</span>.<span class="ruby-identifier">downcase</span>
-142:
-143: <span class="ruby-identifier">logger_class</span> = <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">"%s_logger"</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">logger_type</span>.<span class="ruby-identifier">capitalize</span>)
-144:
-145: <span class="ruby-identifier">set_logger</span>(<span class="ruby-identifier">logger_class</span>.<span class="ruby-identifier">new</span>)
-146: <span class="ruby-keyword kw">else</span>
-147: <span class="ruby-identifier">set_logger</span>(<span class="ruby-identifier">logger</span>)
-148: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">true</span>
-149: <span class="ruby-keyword kw">end</span>
-150:
-151:
-152: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">start</span>
-153: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-154: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">false</span>
-155: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"Could not start logger: #{e.class} #{e}"</span>
-156: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000438" class="method-detail">
- <a name="M000438"></a>
-
- <div class="method-heading">
- <a href="#M000438" class="method-signature">
- <span class="method-name">cycle_level</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-increments the active <a href="Log.html#M000445">log</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000438-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000438-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 45</span>
-45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">cycle_level</span>
-46: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">cycle_level</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@configured</span>
-47: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000434" class="method-detail">
- <a name="M000434"></a>
-
- <div class="method-heading">
- <a href="#M000434" class="method-signature">
- <span class="method-name">debug</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000434">debug</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000434-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000434-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 25</span>
-25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug</span>(<span class="ruby-identifier">msg</span>)
-26: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">msg</span>)
-27: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000436" class="method-detail">
- <a name="M000436"></a>
-
- <div class="method-heading">
- <a href="#M000436" class="method-signature">
- <span class="method-name">error</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000436">error</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000436-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000436-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 35</span>
-35: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">msg</span>)
-36: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:error</span>, <span class="ruby-identifier">msg</span>)
-37: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000450" class="method-detail">
- <a name="M000450"></a>
-
- <div class="method-heading">
- <a href="#M000450" class="method-signature">
- <span class="method-name">execution_stack</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-this method is here to facilitate testing
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000450-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000450-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 170</span>
-170: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execution_stack</span>
-171: <span class="ruby-identifier">caller</span>
-172: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000435" class="method-detail">
- <a name="M000435"></a>
-
- <div class="method-heading">
- <a href="#M000435" class="method-signature">
- <span class="method-name">fatal</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000435">fatal</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000435-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000435-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 30</span>
-30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fatal</span>(<span class="ruby-identifier">msg</span>)
-31: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:fatal</span>, <span class="ruby-identifier">msg</span>)
-32: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000449" class="method-detail">
- <a name="M000449"></a>
-
- <div class="method-heading">
- <a href="#M000449" class="method-signature">
- <span class="method-name">from</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-figures out the filename that called us
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000449-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000449-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 164</span>
-164: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">from</span>
-165: <span class="ruby-identifier">path</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span> = <span class="ruby-identifier">execution_stack</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/:(\d+)/</span>)
-166: <span class="ruby-value str">"%s:%s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span>]
-167: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000432" class="method-detail">
- <a name="M000432"></a>
-
- <div class="method-heading">
- <a href="#M000432" class="method-signature">
- <span class="method-name">info</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000432">info</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000432-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000432-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 15</span>
-15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">info</span>(<span class="ruby-identifier">msg</span>)
-16: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:info</span>, <span class="ruby-identifier">msg</span>)
-17: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000437" class="method-detail">
- <a name="M000437"></a>
-
- <div class="method-heading">
- <a href="#M000437" class="method-signature">
- <span class="method-name">instance</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-handle old code that relied on this class being a singleton
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000437-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000437-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 40</span>
-40: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">instance</span>
-41: <span class="ruby-keyword kw">self</span>
-42: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000445" class="method-detail">
- <a name="M000445"></a>
-
- <div class="method-heading">
- <a href="#M000445" class="method-signature">
- <span class="method-name">log</span><span class="method-args">(level, msg, origin=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-logs a message at a certain level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000445-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000445-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 106</span>
-106: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">origin</span>=<span class="ruby-keyword kw">nil</span>)
-107: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
-108:
-109: <span class="ruby-identifier">origin</span> = <span class="ruby-identifier">from</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">origin</span>
-110:
-111: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@logger</span>
-112: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">origin</span>, <span class="ruby-identifier">msg</span>)
-113: <span class="ruby-keyword kw">else</span>
-114: <span class="ruby-identifier">t</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">"%H:%M:%S"</span>)
-115:
-116: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"#{t}: #{level}: #{origin}: #{msg}"</span>
-117: <span class="ruby-keyword kw">end</span>
-118: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000443" class="method-detail">
- <a name="M000443"></a>
-
- <div class="method-heading">
- <a href="#M000443" class="method-signature">
- <span class="method-name">logexception</span><span class="method-args">(msgid, level, e, backtrace=false, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000443-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000443-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 67</span>
-67: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logexception</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">e</span>, <span class="ruby-identifier">backtrace</span>=<span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">args</span>={})
-68: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
-69:
-70: <span class="ruby-identifier">path</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span> = <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/:(\d+)/</span>)
-71: <span class="ruby-identifier">origin</span> = <span class="ruby-value str">"%s:%s%s"</span> <span class="ruby-operator">%</span> [<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">line</span>, <span class="ruby-identifier">method</span>]
-72:
-73: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">CodedError</span>)
-74: <span class="ruby-identifier">msg</span> = <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">code</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>]
-75: <span class="ruby-keyword kw">else</span>
-76: <span class="ruby-identifier">error_string</span> = <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">e</span>.<span class="ruby-identifier">class</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>]
-77: <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">message_for</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">error_string</span>))
-78: <span class="ruby-keyword kw">end</span>
-79:
-80: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">origin</span>)
-81:
-82: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">backtrace</span>
-83: <span class="ruby-identifier">e</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
-84: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">line</span>], <span class="ruby-identifier">origin</span>)
-85: <span class="ruby-keyword kw">end</span>
-86: <span class="ruby-keyword kw">end</span>
-87: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000431" class="method-detail">
- <a name="M000431"></a>
-
- <div class="method-heading">
- <a href="#M000431" class="method-signature">
- <span class="method-name">logger</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Obtain the class name of the currently configured <a
-href="Log.html#M000431">logger</a>
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000431-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000431-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 10</span>
-10: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logger</span>
-11: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">class</span>
-12: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000444" class="method-detail">
- <a name="M000444"></a>
-
- <div class="method-heading">
- <a href="#M000444" class="method-signature">
- <span class="method-name">logmsg</span><span class="method-args">(msgid, default, level, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs a message at a certain level, the message must be a token that will be
-looked up <a href="Log.html#M000449">from</a> the i18n localization
-database
-</p>
-<p>
-Messages can interprolate strings <a href="Log.html#M000449">from</a> the
-args hash, a message with "foo %{bar}" in the localization
-database will use args[:bar] for the value there, the interprolation is
-handled by the i18n library itself
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000444-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000444-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 97</span>
- 97: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">logmsg</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>, <span class="ruby-identifier">args</span>={})
- 98: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">config_and_check_level</span>(<span class="ruby-identifier">level</span>)
- 99:
-100: <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">message_for</span>(<span class="ruby-identifier">msgid</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">args</span>))
-101:
-102: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>)
-103: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000442" class="method-detail">
- <a name="M000442"></a>
-
- <div class="method-heading">
- <a href="#M000442" class="method-signature">
- <span class="method-name">message_for</span><span class="method-args">(msgid, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000442-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000442-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 63</span>
-63: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">message_for</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>={})
-64: <span class="ruby-value str">"%s: %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">msgid</span>, <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>)]
-65: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000446" class="method-detail">
- <a name="M000446"></a>
-
- <div class="method-heading">
- <a href="#M000446" class="method-signature">
- <span class="method-name">set_logger</span><span class="method-args">(logger)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-sets the <a href="Log.html#M000431">logger</a> class to use
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000446-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000446-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 121</span>
-121: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logger</span>(<span class="ruby-identifier">logger</span>)
-122: <span class="ruby-ivar">@logger</span> = <span class="ruby-identifier">logger</span>
-123: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000448" class="method-detail">
- <a name="M000448"></a>
-
- <div class="method-heading">
- <a href="#M000448" class="method-signature">
- <span class="method-name">unconfigure</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000448-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000448-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 158</span>
-158: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unconfigure</span>
-159: <span class="ruby-ivar">@configured</span> = <span class="ruby-keyword kw">false</span>
-160: <span class="ruby-identifier">set_logger</span>(<span class="ruby-keyword kw">nil</span>)
-161: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000441" class="method-detail">
- <a name="M000441"></a>
-
- <div class="method-heading">
- <a href="#M000441" class="method-signature">
- <span class="method-name">valid_level?</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000441-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000441-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 59</span>
-59: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_level?</span>(<span class="ruby-identifier">level</span>)
-60: <span class="ruby-constant">VALID_LEVELS</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">level</span>)
-61: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000433" class="method-detail">
- <a name="M000433"></a>
-
- <div class="method-heading">
- <a href="#M000433" class="method-signature">
- <span class="method-name">warn</span><span class="method-args">(msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Logs at <a href="Log.html#M000433">warn</a> level
-</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000433-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000433-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/log.rb, line 20</span>
-20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">warn</span>(<span class="ruby-identifier">msg</span>)
-21: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:warn</span>, <span class="ruby-identifier">msg</span>)
-22: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file
Code Review / packages / precise / mcollective.git / blobdiff