+++ /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::Logger::File_logger</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::Logger::File_logger</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/logger/file_logger_rb.html">
- lib/mcollective/logger/file_logger.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- <a href="Base.html">
- Base
- </a>
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
- <div id="description">
- <p>
-Impliments a file based logger using the standard ruby logger class
-</p>
-<p>
-To configure you should set:
-</p>
-<pre>
- - config.logfile
- - config.keeplogs defaults to 2097152
- - config.max_log_size defaults to 5
-</pre>
-
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000215">log</a>
- <a href="#M000213">set_logging_level</a>
- <a href="#M000212">start</a>
- <a href="#M000214">valid_levels</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000215" class="method-detail">
- <a name="M000215"></a>
-
- <div class="method-heading">
- <a href="#M000215" class="method-signature">
- <span class="method-name">log</span><span class="method-args">(level, from, msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000215-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000215-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 37</span>
-37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>)
-38: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>)) { <span class="ruby-node">"#{from} #{msg}"</span> }
-39: <span class="ruby-keyword kw">rescue</span>
-40: <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
-41: <span class="ruby-comment cmt"># STDERR it as last resort</span>
-42: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">"#{level}: #{msg}"</span>)
-43: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000213" class="method-detail">
- <a name="M000213"></a>
-
- <div class="method-heading">
- <a href="#M000213" class="method-signature">
- <span class="method-name">set_logging_level</span><span class="method-args">(level)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000213-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000213-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 22</span>
-22: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
-23: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">level</span> = <span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>)
-24: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-25: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">level</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>
-26: <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:error</span>, <span class="ruby-value str">""</span>, <span class="ruby-node">"Could not set logging to #{level} using debug instead: #{e.class} #{e}"</span>)
-27: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000212" class="method-detail">
- <a name="M000212"></a>
-
- <div class="method-heading">
- <a href="#M000212" class="method-signature">
- <span class="method-name">start</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000212-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000212-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 13</span>
-13: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
-14: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
-15:
-16: <span class="ruby-ivar">@logger</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logfile</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">keeplogs</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">max_log_size</span>)
-17: <span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">formatter</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">Formatter</span>.<span class="ruby-identifier">new</span>
-18:
-19: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">loglevel</span>.<span class="ruby-identifier">to_sym</span>)
-20: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000214" class="method-detail">
- <a name="M000214"></a>
-
- <div class="method-heading">
- <a href="#M000214" class="method-signature">
- <span class="method-name">valid_levels</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000214-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000214-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 29</span>
-29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
-30: {<span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">INFO</span>,
-31: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">WARN</span>,
-32: <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>,
-33: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">FATAL</span>,
-34: <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">ERROR</span>}
-35: <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