doc/classes/MCollective/Logger/Syslog_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::Syslog_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::Syslog_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/syslog_logger_rb.html">
  59                 lib/mcollective/logger/syslog_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 Implements a syslog based logger using the standard ruby syslog class
  86 </p>
  87
  88     </div>
  89
  90
  91    </div>
  92
  93     <div id="method-list">
  94       <h3 class="section-bar">Methods</h3>
  95
  96       <div class="name-list">
  97       <a href="#M000201">log</a>&nbsp;&nbsp;
  98       <a href="#M000199">set_logging_level</a>&nbsp;&nbsp;
  99       <a href="#M000197">start</a>&nbsp;&nbsp;
 100       <a href="#M000198">syslog_facility</a>&nbsp;&nbsp;
 101       <a href="#M000200">valid_levels</a>&nbsp;&nbsp;
 102       </div>
 103     </div>
 104
 105   </div>
 106
 107
 108     <!-- if includes -->
 109     <div id="includes">
 110       <h3 class="section-bar">Included Modules</h3>
 111
 112       <div id="includes-list">
 113         <span class="include-name">Syslog::Constants</span>
 114       </div>
 115     </div>
 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-M000201" class="method-detail">
 131         <a name="M000201"></a>
 132
 133         <div class="method-heading">
 134           <a href="#M000201" 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('M000201-source');return false;">[Source]</a></p>
 142           <div class="method-source-code" id="M000201-source">
 143 <pre>
 144     <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 42</span>
 145 42:       <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 43:         <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">map_level</span>(<span class="ruby-identifier">level</span>), <span class="ruby-node">&quot;#{from} #{msg}&quot;</span>)
 147 44:       <span class="ruby-keyword kw">rescue</span>
 148 45:         <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
 149 46:         <span class="ruby-comment cmt"># STDERR it as last resort</span>
 150 47:         <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">&quot;#{level}: #{msg}&quot;</span>)
 151 48:       <span class="ruby-keyword kw">end</span>
 152 </pre>
 153           </div>
 154         </div>
 155       </div>
 156
 157       <div id="method-M000199" class="method-detail">
 158         <a name="M000199"></a>
 159
 160         <div class="method-heading">
 161           <a href="#M000199" 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('M000199-source');return false;">[Source]</a></p>
 169           <div class="method-source-code" id="M000199-source">
 170 <pre>
 171     <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 30</span>
 172 30:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
 173 31:         <span class="ruby-comment cmt"># noop</span>
 174 32:       <span class="ruby-keyword kw">end</span>
 175 </pre>
 176           </div>
 177         </div>
 178       </div>
 179
 180       <div id="method-M000197" class="method-detail">
 181         <a name="M000197"></a>
 182
 183         <div class="method-heading">
 184           <a href="#M000197" class="method-signature">
 185           <span class="method-name">start</span><span class="method-args">()</span>
 186           </a>
 187         </div>
 188
 189         <div class="method-description">
 190           <p><a class="source-toggle" href="#"
 191             onclick="toggleCode('M000197-source');return false;">[Source]</a></p>
 192           <div class="method-source-code" id="M000197-source">
 193 <pre>
 194     <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 9</span>
 195  9:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
 196 10:         <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
 197 11:
 198 12:         <span class="ruby-identifier">facility</span> = <span class="ruby-identifier">syslog_facility</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">logfacility</span>)
 199 13:         <span class="ruby-identifier">level</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">loglevel</span>.<span class="ruby-identifier">to_sym</span>
 200 14:
 201 15:         <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">opened?</span>
 202 16:         <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">$0</span>), <span class="ruby-value">3</span>, <span class="ruby-identifier">facility</span>)
 203 17:
 204 18:         <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">level</span>)
 205 19:       <span class="ruby-keyword kw">end</span>
 206 </pre>
 207           </div>
 208         </div>
 209       </div>
 210
 211       <div id="method-M000198" class="method-detail">
 212         <a name="M000198"></a>
 213
 214         <div class="method-heading">
 215           <a href="#M000198" class="method-signature">
 216           <span class="method-name">syslog_facility</span><span class="method-args">(facility)</span>
 217           </a>
 218         </div>
 219
 220         <div class="method-description">
 221           <p><a class="source-toggle" href="#"
 222             onclick="toggleCode('M000198-source');return false;">[Source]</a></p>
 223           <div class="method-source-code" id="M000198-source">
 224 <pre>
 225     <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 21</span>
 226 21:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">syslog_facility</span>(<span class="ruby-identifier">facility</span>)
 227 22:         <span class="ruby-keyword kw">begin</span>
 228 23:           <span class="ruby-constant">Syslog</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-node">&quot;LOG_#{facility.upcase}&quot;</span>)
 229 24:         <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NameError</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
 230 25:           <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Invalid syslog facility #{facility} supplied, reverting to USER&quot;</span>
 231 26:           <span class="ruby-constant">Syslog</span><span class="ruby-operator">::</span><span class="ruby-constant">LOG_USER</span>
 232 27:         <span class="ruby-keyword kw">end</span>
 233 28:       <span class="ruby-keyword kw">end</span>
 234 </pre>
 235           </div>
 236         </div>
 237       </div>
 238
 239       <div id="method-M000200" class="method-detail">
 240         <a name="M000200"></a>
 241
 242         <div class="method-heading">
 243           <a href="#M000200" class="method-signature">
 244           <span class="method-name">valid_levels</span><span class="method-args">()</span>
 245           </a>
 246         </div>
 247
 248         <div class="method-description">
 249           <p><a class="source-toggle" href="#"
 250             onclick="toggleCode('M000200-source');return false;">[Source]</a></p>
 251           <div class="method-source-code" id="M000200-source">
 252 <pre>
 253     <span class="ruby-comment cmt"># File lib/mcollective/logger/syslog_logger.rb, line 34</span>
 254 34:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
 255 35:         {<span class="ruby-identifier">:info</span>  =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:info</span>,
 256 36:          <span class="ruby-identifier">:warn</span>  =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:warning</span>,
 257 37:          <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:debug</span>,
 258 38:          <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:crit</span>,
 259 39:          <span class="ruby-identifier">:error</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:err</span>}
 260 40:       <span class="ruby-keyword kw">end</span>
 261 </pre>
 262           </div>
 263         </div>
 264       </div>
 265
 266
 267     </div>
 268
 269
 270   </div>
 271
 272
 273 <div id="validator-badges">
 274   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 275 </div>
 276
 277 </body>
 278 </html>