X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=doc%2Fclasses%2FMCollective%2FFacts%2FBase.html;fp=doc%2Fclasses%2FMCollective%2FFacts%2FBase.html;h=b7998e9075c70bfc826f15d4397a61783211020c;hb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;hp=0000000000000000000000000000000000000000;hpb=8a3fe7daeecccf43dd71c59371c5005400d35101;p=packages%2Fprecise%2Fmcollective.git diff --git a/doc/classes/MCollective/Facts/Base.html b/doc/classes/MCollective/Facts/Base.html new file mode 100644 index 0000000..b7998e9 --- /dev/null +++ b/doc/classes/MCollective/Facts/Base.html @@ -0,0 +1,343 @@ + + + + + + Class: MCollective::Facts::Base + + + + + + + + + + +
+ + + + + + + + + + + + + + +
ClassMCollective::Facts::Base
In: + + lib/mcollective/facts/base.rb + +
+
Parent: + Object +
+
+ + +
+ + + +
+ +
+

+A base class for fact providers, to make a new fully functional fact provider inherit +from this and simply provide a self.get_facts method that returns a hash +like: +

+
+ {"foo" => "bar",
+  "bar" => "baz"}
+
+ +
+ + +
+ +
+

Methods

+ +
+ force_reload?   + get_fact   + get_facts   + has_fact?   + inherited   + new   +
+
+ +
+ + + + +
+ + + + + + + + + +
+

Public Class methods

+ +
+ + +
+ + inherited(klass) + +
+ +
+

+Registers new fact sources into the plugin +manager +

+

[Source]

+
+
+    # File lib/mcollective/facts/base.rb, line 17
+17:       def self.inherited(klass)
+18:         PluginManager << {:type => "facts_plugin", :class => klass.to_s}
+19:       end
+
+
+
+
+ +
+ + +
+ + new() + +
+ +
+

[Source]

+
+
+    # File lib/mcollective/facts/base.rb, line 10
+10:       def initialize
+11:         @facts = {}
+12:         @last_good_facts = {}
+13:         @last_facts_load = 0
+14:       end
+
+
+
+
+ +

Public Instance methods

+ +
+ + +
+ + force_reload?() + +
+ +
+

+Plugins can override this to provide forced fact invalidation +

+

[Source]

+
+
+    # File lib/mcollective/facts/base.rb, line 81
+81:       def force_reload?
+82:         false
+83:       end
+
+
+
+
+ +
+ + +
+ + get_fact(fact=nil) + +
+ +
+

+Returns the value of a single fact +

+

[Source]

+
+
+    # File lib/mcollective/facts/base.rb, line 22
+22:       def get_fact(fact=nil)
+23:         config = Config.instance
+24: 
+25:         cache_time = config.fact_cache_time || 300
+26: 
+27:         Thread.exclusive do
+28:           begin
+29:             if (Time.now.to_i - @last_facts_load > cache_time.to_i ) || force_reload?
+30:               Log.debug("Resetting facter cache, now: #{Time.now.to_i} last-known-good: #{@last_facts_load}")
+31: 
+32:               tfacts = load_facts_from_source
+33: 
+34:               # Force reset to last known good state on empty facts
+35:               raise "Got empty facts" if tfacts.empty?
+36: 
+37:               @facts.clear
+38: 
+39:               tfacts.each_pair do |key,value|
+40:                 @facts[key.to_s] = value.to_s
+41:               end
+42: 
+43:               @last_good_facts = @facts.clone
+44:               @last_facts_load = Time.now.to_i
+45:             else
+46:               Log.debug("Using cached facts now: #{Time.now.to_i} last-known-good: #{@last_facts_load}")
+47:             end
+48:           rescue Exception => e
+49:             Log.error("Failed to load facts: #{e.class}: #{e}")
+50: 
+51:             # Avoid loops where failing fact loads cause huge CPU
+52:             # loops, this way it only retries once every cache_time
+53:             # seconds
+54:             @last_facts_load = Time.now.to_i
+55: 
+56:             # Revert to last known good state
+57:             @facts = @last_good_facts.clone
+58:           end
+59:         end
+60: 
+61: 
+62:         # If you do not supply a specific fact all facts will be returned
+63:         if fact.nil?
+64:           return @facts
+65:         else
+66:           @facts.include?(fact) ? @facts[fact] : nil
+67:         end
+68:       end
+
+
+
+
+ +
+ + +
+ + get_facts() + +
+ +
+

+Returns all facts +

+

[Source]

+
+
+    # File lib/mcollective/facts/base.rb, line 71
+71:       def get_facts
+72:         get_fact(nil)
+73:       end
+
+
+
+
+ +
+ + +
+ + has_fact?(fact) + +
+ +
+

+Returns true if we know about a specific fact, false otherwise +

+

[Source]

+
+
+    # File lib/mcollective/facts/base.rb, line 76
+76:       def has_fact?(fact)
+77:         get_fact(nil).include?(fact)
+78:       end
+
+
+
+
+ + +
+ + +
+ + +
+

[Validate]

+
+ + + \ No newline at end of file