1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
8 <title>Class: MCollective::Logger::Console_logger</title>
10 <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
12 <script src="../../js/jquery.js" type="text/javascript"
13 charset="utf-8"></script>
14 <script src="../../js/thickbox-compressed.js" type="text/javascript"
15 charset="utf-8"></script>
16 <script src="../../js/quicksearch.js" type="text/javascript"
17 charset="utf-8"></script>
18 <script src="../../js/darkfish.js" type="text/javascript"
19 charset="utf-8"></script>
25 <div id="file-metadata">
26 <div id="file-list-section" class="section">
27 <h3 class="section-header">In Files</h3>
28 <div class="section-body">
31 <li><a href="../../lib/mcollective/logger/console_logger_rb.html?TB_iframe=true&height=550&width=785"
32 class="thickbox" title="lib/mcollective/logger/console_logger.rb">lib/mcollective/logger/console_logger.rb</a></li>
41 <div id="class-metadata">
45 <div id="parent-class-section" class="section">
46 <h3 class="section-header">Parent</h3>
48 <p class="link">Base</p>
53 <!-- Namespace Contents -->
56 <!-- Method Quickref -->
58 <div id="method-list-section" class="section">
59 <h3 class="section-header">Methods</h3>
60 <ul class="link-list">
62 <li><a href="#M000164">#color</a></li>
64 <li><a href="#M000165">#colorize</a></li>
66 <li><a href="#M000163">#log</a></li>
68 <li><a href="#M000161">#set_logging_level</a></li>
70 <li><a href="#M000160">#start</a></li>
72 <li><a href="#M000162">#valid_levels</a></li>
78 <!-- Included Modules -->
82 <div id="project-metadata">
85 <div id="fileindex-section" class="section project-section">
86 <h3 class="section-header">Files</h3>
89 <li class="file"><a href="../../COPYING.html">COPYING</a></li>
91 <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
93 <li class="file"><a href="../../README.html">README</a></li>
95 <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
97 <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
99 <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
101 <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
103 <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
105 <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
107 <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
109 <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
111 <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
113 <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
115 <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
117 <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
119 <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
121 <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
123 <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
125 <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
127 <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
133 <div id="classindex-section" class="section project-section">
134 <h3 class="section-header">Class Index
135 <span class="search-toggle"><img src="../../images/find.png"
136 height="16" width="16" alt="[+]"
137 title="show/hide quicksearch" /></span></h3>
138 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
140 <legend>Quicksearch</legend>
141 <input type="text" name="quicksearch" value=""
142 class="quicksearch-field" />
146 <ul class="link-list">
148 <li><a href="../../MCollective.html">MCollective</a></li>
150 <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
152 <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
154 <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
156 <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
158 <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
160 <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
162 <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
164 <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
166 <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
168 <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
170 <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
172 <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
174 <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
176 <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
178 <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
180 <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
182 <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
184 <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
186 <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
188 <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
190 <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
192 <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
194 <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
196 <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
198 <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
200 <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
202 <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
204 <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
206 <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
208 <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
210 <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
212 <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
214 <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
216 <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
218 <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
220 <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
222 <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
224 <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
226 <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
228 <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
230 <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
232 <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
234 <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
236 <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
238 <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
240 <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
242 <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
244 <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
246 <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
248 <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
250 <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
252 <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
254 <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
256 <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
258 <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
260 <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
262 <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
264 <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
266 <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
268 <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
270 <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
272 <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
274 <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
276 <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
278 <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
280 <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
282 <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
284 <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
286 <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
288 <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
290 <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
292 <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
294 <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
296 <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
298 <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
300 <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
302 <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
304 <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
306 <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
308 <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
310 <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
312 <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
314 <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
316 <li><a href="../../Array.html">Array</a></li>
318 <li><a href="../../Dir.html">Dir</a></li>
320 <li><a href="../../Object.html">Object</a></li>
322 <li><a href="../../String.html">String</a></li>
324 <li><a href="../../Symbol.html">Symbol</a></li>
327 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
334 <div id="documentation">
335 <h1 class="class">MCollective::Logger::Console_logger</h1>
337 <div id="description">
339 Implements a syslog based logger using the standard ruby syslog class
352 <div id="public-instance-method-details" class="method-section section">
353 <h3 class="section-header">Public Instance Methods</h3>
356 <div id="color-method" class="method-detail ">
357 <a name="M000164"></a>
359 <div class="method-heading">
361 <span class="method-name">color</span><span
362 class="method-args">(level)</span>
363 <span class="method-click-advice">click to toggle source</span>
367 <div class="method-description">
370 Set some colors for various logging levels, will honor the color
371 configuration option and return nothing if its configured not to
376 <div class="method-source-code"
379 <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 37</span>
380 37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">color</span>(<span class="ruby-identifier">level</span>)
381 38: <span class="ruby-identifier">colorize</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">color</span>
383 40: <span class="ruby-identifier">colors</span> = {<span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:red</span>),
384 41: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:red</span>),
385 42: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:yellow</span>),
386 43: <span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:green</span>),
387 44: <span class="ruby-identifier">:reset</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">:reset</span>)}
389 46: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">colorize</span>
390 47: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">colors</span>[<span class="ruby-identifier">level</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">""</span>
391 48: <span class="ruby-keyword kw">else</span>
392 49: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span>
393 50: <span class="ruby-keyword kw">end</span>
394 51: <span class="ruby-keyword kw">end</span></pre>
403 <div id="colorize-method" class="method-detail ">
404 <a name="M000165"></a>
406 <div class="method-heading">
408 <span class="method-name">colorize</span><span
409 class="method-args">(level, msg)</span>
410 <span class="method-click-advice">click to toggle source</span>
414 <div class="method-description">
417 Helper to return a string in specific color
422 <div class="method-source-code"
423 id="colorize-source">
425 <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 54</span>
426 54: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">msg</span>)
427 55: <span class="ruby-value str">"%s%s%s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">color</span>(<span class="ruby-identifier">level</span>), <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">color</span>(<span class="ruby-identifier">:reset</span>) ]
428 56: <span class="ruby-keyword kw">end</span></pre>
437 <div id="log-method" class="method-detail ">
438 <a name="M000163"></a>
440 <div class="method-heading">
442 <span class="method-name">log</span><span
443 class="method-args">(level, from, msg, normal_output=STDERR, last_resort_output=STDERR)</span>
444 <span class="method-click-advice">click to toggle source</span>
448 <div class="method-description">
450 <p class="missing-docs">(Not documented)</p>
454 <div class="method-source-code"
457 <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 24</span>
458 24: <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>, <span class="ruby-identifier">normal_output</span>=<span class="ruby-constant">STDERR</span>, <span class="ruby-identifier">last_resort_output</span>=<span class="ruby-constant">STDERR</span>)
459 25: <span class="ruby-identifier">time</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-value str">"%Y/%m/%d %H:%M:%S"</span>)
461 27: <span class="ruby-identifier">normal_output</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-value str">"%s %s: %s %s"</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">level</span>), <span class="ruby-identifier">time</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">msg</span>])
462 28: <span class="ruby-keyword kw">rescue</span>
463 29: <span class="ruby-comment cmt"># if this fails we probably cant show the user output at all,</span>
464 30: <span class="ruby-comment cmt"># STDERR it as last resort</span>
465 31: <span class="ruby-identifier">last_resort_output</span>.<span class="ruby-identifier">puts</span>(<span class="ruby-node">"#{level}: #{msg}"</span>)
466 32: <span class="ruby-keyword kw">end</span></pre>
475 <div id="set-logging-level-method" class="method-detail ">
476 <a name="M000161"></a>
478 <div class="method-heading">
480 <span class="method-name">set_logging_level</span><span
481 class="method-args">(level)</span>
482 <span class="method-click-advice">click to toggle source</span>
486 <div class="method-description">
488 <p class="missing-docs">(Not documented)</p>
492 <div class="method-source-code"
493 id="set-logging-level-source">
495 <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 12</span>
496 12: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_logging_level</span>(<span class="ruby-identifier">level</span>)
497 13: <span class="ruby-comment cmt"># nothing to do here, we ignore high levels when we log</span>
498 14: <span class="ruby-keyword kw">end</span></pre>
507 <div id="start-method" class="method-detail ">
508 <a name="M000160"></a>
510 <div class="method-heading">
512 <span class="method-name">start</span><span
513 class="method-args">()</span>
514 <span class="method-click-advice">click to toggle source</span>
518 <div class="method-description">
520 <p class="missing-docs">(Not documented)</p>
524 <div class="method-source-code"
527 <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 5</span>
528 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
529 6: <span class="ruby-identifier">set_level</span>(<span class="ruby-identifier">:info</span>)
531 8: <span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>
532 9: <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>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">configured</span>
533 10: <span class="ruby-keyword kw">end</span></pre>
542 <div id="valid-levels-method" class="method-detail ">
543 <a name="M000162"></a>
545 <div class="method-heading">
547 <span class="method-name">valid_levels</span><span
548 class="method-args">()</span>
549 <span class="method-click-advice">click to toggle source</span>
553 <div class="method-description">
555 <p class="missing-docs">(Not documented)</p>
559 <div class="method-source-code"
560 id="valid-levels-source">
562 <span class="ruby-comment cmt"># File lib/mcollective/logger/console_logger.rb, line 16</span>
563 16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_levels</span>
564 17: {<span class="ruby-identifier">:info</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:info</span>,
565 18: <span class="ruby-identifier">:warn</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:warning</span>,
566 19: <span class="ruby-identifier">:debug</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:debug</span>,
567 20: <span class="ruby-identifier">:fatal</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:crit</span>,
568 21: <span class="ruby-identifier">:error</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:err</span>}
569 22: <span class="ruby-keyword kw">end</span></pre>
584 <div id="rdoc-debugging-section-dump" class="debugging-section">
586 <p>Disabled; run with --debug to generate this.</p>
590 <div id="validator-badges">
591 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
592 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
593 Rdoc Generator</a> 1.1.6</small>.</p>