doc/classes/MCollective/Logger/File_logger.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8   <title>Class: MCollective::Logger::File_logger</title>
   9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
  11   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
  12   <script type="text/javascript">
  13   // <![CDATA[
  14
  15   function popupCode( url ) {
  16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  17   }
  18
  19   function toggleCode( id ) {
  20     if ( document.getElementById )
  21       elem = document.getElementById( id );
  22     else if ( document.all )
  23       elem = eval( "document.all." + id );
  24     else
  25       return false;
  26
  27     elemStyle = elem.style;
  28
  29     if ( elemStyle.display != "block" ) {
  30       elemStyle.display = "block"
  31     } else {
  32       elemStyle.display = "none"
  33     }
  34
  35     return true;
  36   }
  37
  38   // Make codeblocks hidden by default
  39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  40
  41   // ]]>
  42   </script>
  43
  44 </head>
  45 <body>
  46
  47
  48
  49     <div id="classHeader">
  50         <table class="header-table">
  51         <tr class="top-aligned-row">
  52           <td><strong>Class</strong></td>
  53           <td class="class-name-in-header">MCollective::Logger::File_logger</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../../files/lib/mcollective/logger/file_logger_rb.html">
  59                 lib/mcollective/logger/file_logger.rb
  60                 </a>
  61         <br />
  62             </td>
  63         </tr>
  64
  65         <tr class="top-aligned-row">
  66             <td><strong>Parent:</strong></td>
  67             <td>
  68                 <a href="Base.html">
  69                 Base
  70                </a>
  71             </td>
  72         </tr>
  73         </table>
  74     </div>
  75   <!-- banner header -->
  76
  77   <div id="bodyContent">
  78
  79
  80
  81   <div id="contextContent">
  82
  83     <div id="description">
  84       <p>
  85 Impliments a file based logger using the standard ruby logger class
  86 </p>
  87 <p>
  88 To configure you should set:
  89 </p>
  90 <pre>
  91   - config.logfile
  92   - config.keeplogs defaults to 2097152
  93   - config.max_log_size defaults to 5
  94 </pre>
  95
  96     </div>
  97
  98
  99    </div>
 100
 101     <div id="method-list">
 102       <h3 class="section-bar">Methods</h3>
 103
 104       <div class="name-list">
 105       <a href="#M000215">log</a>&nbsp;&nbsp;
 106       <a href="#M000213">set_logging_level</a>&nbsp;&nbsp;
 107       <a href="#M000212">start</a>&nbsp;&nbsp;
 108       <a href="#M000214">valid_levels</a>&nbsp;&nbsp;
 109       </div>
 110     </div>
 111
 112   </div>
 113
 114
 115     <!-- if includes -->
 116
 117     <div id="section">
 118
 119
 120
 121
 122
 123
 124
 125
 126     <!-- if method_list -->
 127     <div id="methods">
 128       <h3 class="section-bar">Public Instance methods</h3>
 129
 130       <div id="method-M000215" class="method-detail">
 131         <a name="M000215"></a>
 132
 133         <div class="method-heading">
 134           <a href="#M000215" class="method-signature">
 135           <span class="method-name">log</span><span class="method-args">(level, from, msg)</span>
 136           </a>
 137         </div>
 138
 139         <div class="method-description">
 140           <p><a class="source-toggle" href="#"
 141             onclick="toggleCode('M000215-source');return false;">[Source]</a></p>
 142           <div class="method-source-code" id="M000215-source">
 143 <pre>
 144     <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 37</span>
 145 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>)
 146 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">&quot;#{from} #{msg}&quot;</span> }
 147 39:       <span class="ruby-keyword kw">rescue</span>
 148 40:         <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
 149 41:         <span class="ruby-comment cmt"># STDERR it as last resort</span>
 150 42:         <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">&quot;#{level}: #{msg}&quot;</span>)
 151 43:       <span class="ruby-keyword kw">end</span>
 152 </pre>
 153           </div>
 154         </div>
 155       </div>
 156
 157       <div id="method-M000213" class="method-detail">
 158         <a name="M000213"></a>
 159
 160         <div class="method-heading">
 161           <a href="#M000213" class="method-signature">
 162           <span class="method-name">set_logging_level</span><span class="method-args">(level)</span>
 163           </a>
 164         </div>
 165
 166         <div class="method-description">
 167           <p><a class="source-toggle" href="#"
 168             onclick="toggleCode('M000213-source');return false;">[Source]</a></p>
 169           <div class="method-source-code" id="M000213-source">
 170 <pre>
 171     <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 22</span>
 172 22:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
 173 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>)
 174 24:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
 175 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>
 176 26:         <span class="ruby-identifier">log</span>(<span class="ruby-identifier">:error</span>, <span class="ruby-value str">&quot;&quot;</span>, <span class="ruby-node">&quot;Could not set logging to #{level} using debug instead: #{e.class} #{e}&quot;</span>)
 177 27:       <span class="ruby-keyword kw">end</span>
 178 </pre>
 179           </div>
 180         </div>
 181       </div>
 182
 183       <div id="method-M000212" class="method-detail">
 184         <a name="M000212"></a>
 185
 186         <div class="method-heading">
 187           <a href="#M000212" class="method-signature">
 188           <span class="method-name">start</span><span class="method-args">()</span>
 189           </a>
 190         </div>
 191
 192         <div class="method-description">
 193           <p><a class="source-toggle" href="#"
 194             onclick="toggleCode('M000212-source');return false;">[Source]</a></p>
 195           <div class="method-source-code" id="M000212-source">
 196 <pre>
 197     <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 13</span>
 198 13:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
 199 14:         <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
 200 15:
 201 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>)
 202 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>
 203 18:
 204 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>)
 205 20:       <span class="ruby-keyword kw">end</span>
 206 </pre>
 207           </div>
 208         </div>
 209       </div>
 210
 211       <div id="method-M000214" class="method-detail">
 212         <a name="M000214"></a>
 213
 214         <div class="method-heading">
 215           <a href="#M000214" class="method-signature">
 216           <span class="method-name">valid_levels</span><span class="method-args">()</span>
 217           </a>
 218         </div>
 219
 220         <div class="method-description">
 221           <p><a class="source-toggle" href="#"
 222             onclick="toggleCode('M000214-source');return false;">[Source]</a></p>
 223           <div class="method-source-code" id="M000214-source">
 224 <pre>
 225     <span class="ruby-comment cmt"># File lib/mcollective/logger/file_logger.rb, line 29</span>
 226 29:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
 227 30:         {<span class="ruby-identifier">:info</span>  =<span class="ruby-operator">&gt;</span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">INFO</span>,
 228 31:          <span class="ruby-identifier">:warn</span>  =<span class="ruby-operator">&gt;</span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">WARN</span>,
 229 32:          <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">DEBUG</span>,
 230 33:          <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">FATAL</span>,
 231 34:          <span class="ruby-identifier">:error</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-operator">::</span><span class="ruby-constant">Logger</span><span class="ruby-operator">::</span><span class="ruby-constant">ERROR</span>}
 232 35:       <span class="ruby-keyword kw">end</span>
 233 </pre>
 234           </div>
 235         </div>
 236       </div>
 237
 238
 239     </div>
 240
 241
 242   </div>
 243
 244
 245 <div id="validator-badges">
 246   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 247 </div>
 248
 249 </body>
 250 </html>