-
-
-
-
-
-
-
-
- + +
+ +
+
+
+
+
+
+
+
+
+
+ In Files
+
+
+ -
+
+
- lib/mcollective/rpc/stats.rb + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parent
+ + + +
+
+
+
+
+
+ Methods
+-
+
+
- ::new + +
- #[] + +
- #client_stats= + +
- #discovered_agents + +
- #fail + +
- #finish_request + +
- #no_response_report + +
- #node_responded + +
- #ok + +
- #report + +
- #reset + +
- #text_for_aggregates + +
- #time_block_execution + +
- #time_discovery + +
- #to_hash + +
+
+
+
+
+
+
+
+ Files
+-
+
+
- COPYING + +
- Gemfile + +
- README + +
- Rakefile + +
- client.cfg.dist + +
- data-help.erb + +
- discovery-help.erb + +
- facts.yaml.dist + +
- metadata-help.erb + +
- msg-help.erb + +
- rpc-help.erb + +
- server.cfg.dist + +
- PLACEHOLDER + +
- PLACEHOLDER + +
- action_snippet.erb + +
- data_input_snippet.erb + +
- ddl.erb + +
- plugin.erb + +
- en.yml + +
- mcollective.init + +
+ Class Index
+
+
+
+
+
+
+ Class Index
+ ![[+]](../../images/find.png "show/hide quicksearch")
+
+
+ -
+
+
- MCollective + +
- MCollective::Agent + +
- MCollective::Agents + +
- MCollective::Aggregate + +
- MCollective::Aggregate::Base + +
- MCollective::Aggregate::Result + +
- MCollective::Aggregate::Result::Base + +
- MCollective::Aggregate::Result::CollectionResult + +
- MCollective::Aggregate::Result::NumericResult + +
- MCollective::Application + +
- MCollective::Applications + +
- MCollective::Cache + +
- MCollective::Client + +
- MCollective::CodedError + +
- MCollective::Config + +
- MCollective::Connector + +
- MCollective::Connector::Base + +
- MCollective::DDL + +
- MCollective::DDL::AgentDDL + +
- MCollective::DDL::Base + +
- MCollective::DDL::DataDDL + +
- MCollective::DDL::DiscoveryDDL + +
- MCollective::DDL::ValidatorDDL + +
- MCollective::DDLValidationError + +
- MCollective::Data + +
- MCollective::Data::Base + +
- MCollective::Data::Result + +
- MCollective::Discovery + +
- MCollective::Facts + +
- MCollective::Facts::Base + +
- MCollective::Generators + +
- MCollective::Generators::AgentGenerator + +
- MCollective::Generators::Base + +
- MCollective::Generators::DataGenerator + +
- MCollective::InvalidRPCData + +
- MCollective::Log + +
- MCollective::Logger + +
- MCollective::Logger::Base + +
- MCollective::Logger::Console_logger + +
- MCollective::Logger::File_logger + +
- MCollective::Logger::Syslog_logger + +
- MCollective::Matcher + +
- MCollective::Matcher::Parser + +
- MCollective::Matcher::Scanner + +
- MCollective::Message + +
- MCollective::MissingRPCData + +
- MCollective::MsgDoesNotMatchRequestID + +
- MCollective::MsgTTLExpired + +
- MCollective::NotTargettedAtUs + +
- MCollective::Optionparser + +
- MCollective::PluginManager + +
- MCollective::PluginPackager + +
- MCollective::PluginPackager::AgentDefinition + +
- MCollective::PluginPackager::StandardDefinition + +
- MCollective::RPC + +
- MCollective::RPC::ActionRunner + +
- MCollective::RPC::Agent + +
- MCollective::RPC::Audit + +
- MCollective::RPC::Client + +
- MCollective::RPC::Helpers + +
- MCollective::RPC::Progress + +
- MCollective::RPC::Reply + +
- MCollective::RPC::Request + +
- MCollective::RPC::Result + +
- MCollective::RPC::Stats + +
- MCollective::RPCAborted + +
- MCollective::RPCError + +
- MCollective::Registration + +
- MCollective::Registration::Base + +
- MCollective::Runner + +
- MCollective::RunnerStats + +
- MCollective::SSL + +
- MCollective::Security + +
- MCollective::Security::Base + +
- MCollective::SecurityValidationFailed + +
- MCollective::Shell + +
- MCollective::Translatable + +
- MCollective::UnixDaemon + +
- MCollective::UnknownRPCAction + +
- MCollective::UnknownRPCError + +
- MCollective::Util + +
- MCollective::Validator + +
- MCollective::ValidatorError + +
- MCollective::WindowsDaemon + +
- Array + +
- Dir + +
- Object + +
- String + +
- Symbol + +
+
-
- MCollective::RPC::Stats
+ +
+
-
-
- Class to wrap all the stats and to keep track of some timings
-
-
-
- Methods
- -
- []
- client_stats=
- discovered_agents
- fail
- finish_request
- new
- no_response_report
- node_responded
- ok
- report
- reset
- text_for_aggregates
- time_block_execution
- time_discovery
- to_hash
-
-
-
-
-
-
-
-
+
+
-
-
-
-
-
- Attributes
- -
-
-
-
- | aggregate_failures | -[RW] | -- |
| aggregate_summary | -[RW] | -- |
| blocktime | -[RW] | -- |
| ddl | -[RW] | -- |
| discovered | -[RW] | -- |
| discovered_nodes | -[RW] | -- |
| discoverytime | -[RW] | -- |
| failcount | -[RW] | -- |
| noresponsefrom | -[RW] | -- |
| noresponsefrom | -[RW] | -- |
| okcount | -[RW] | -- |
| requestid | -[RW] | -- |
| responses | -[RW] | -- |
| responsesfrom | -[RW] | -- |
| starttime | -[RW] | -- |
| totaltime | -[RW] | -- |
-
+
+ Public Class methods
- -
-
-
-
-
-
- new()
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Attributes
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ Public Instance Methods
+ + +
+
+
+
+
+
+
+
+ [](key)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Fake hash access to keep things backward compatible
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 51
51: def [](key)
52: to_hash[key]
53: rescue
54: nil
-55: end
-
-
+
+
+
+
+
+
+
+ client_stats=(stats)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Re-initializes the object with stats from the basic client
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 72
72: def client_stats=(stats)
@@ -295,83 +754,109 @@ Re-initializes the object with stats from the basic client
77: @totaltime = stats[:totaltime]
78: @requestid = stats[:requestid]
79: @discoverytime = stats[:discoverytime] if @discoverytime == 0
-80: end
-
-
+
+
+
+
+
+
+
+ discovered_agents(agents)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ +Update discovered and discovered_nodes based on discovery +results
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 110
110: def discovered_agents(agents)
111: @discovered_nodes = agents
112: @discovered = agents.size
-113: end
-
-
+
+
+
+
+
+
+
+ fail()
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ increment the count of failed hosts
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 65
65: def fail
66: @failcount += 1
67: rescue
68: @failcount = 1
-69: end
-
-
+
+
+
+
+
+
+
+ finish_request()
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Helper to calculate total time etc
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 116
116: def finish_request
@@ -384,28 +869,36 @@ Helper to calculate total time etc
123: rescue
124: @totaltime = 0
125: @noresponsefrom = []
-126: end
-
-
+
+
+
+
+
+
+
+ no_response_report()
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Returns a blob of text indicating what nodes did not respond
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 237
237: def no_response_report
@@ -424,85 +917,109 @@ Returns a blob of text indicating what nodes did not respond
250: end
251:
252: result_text.string
-253: end
-
-
+
+
+
+
+
+
+
+ node_responded(node)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Helper to keep track of who we received responses from
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 129
129: def node_responded(node)
130: @responsesfrom << node
131: rescue
132: @responsesfrom = [node]
-133: end
-
-
+
+
+
+
+
+
+
+ ok()
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ +increment the count of ok hosts
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 58
58: def ok
59: @okcount += 1
60: rescue
61: @okcount = 1
-62: end
-
-
+
+
+
+
+
+
+
+ report(caption = "rpc stats", summarize = true, verbose = false)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Returns a blob of text representing the request status based on the stats contained in this class
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 187
187: def report(caption = "rpc stats", summarize = true, verbose = false)
@@ -552,28 +1069,36 @@ contained in this class
231: end
232:
233: result_text.join("\n")
-234: end
-
-
+
+
+
+
+
+
+
+ reset()
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Resets stats, if discovery time is set we keep it as it was
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 14
14: def reset
@@ -592,25 +1117,34 @@ Resets stats, if discovery time is set we keep it as it was
27: @requestid = nil
28: @aggregate_summary = []
29: @aggregate_failures = []
-30: end
-
-
+
+
+
-
-
+
+
+
+
+ text_for_aggregates()
+ click to toggle source
+
+
+
+
+
+
-
- (Not documented)
+ + + +
# File lib/mcollective/rpc/stats.rb, line 135
135: def text_for_aggregates
@@ -661,28 +1195,36 @@ Resets stats, if discovery time is set we keep it as it was
180: end
181:
182: result.string
-183: end
-
-
+
+
+
+
+
+
+
+ time_block_execution(action)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ helper to time block execution time
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 96
96: def time_block_execution(action)
@@ -695,28 +1237,36 @@ helper to time block execution time
103: end
104: rescue
105: @blocktime = 0
-106: end
-
-
+
+
+
+
+
+
+
+ time_discovery(action)
+ click to toggle source
+
+
+
+
+
+
-
-
+
+
+ Utility to time discovery from :start to :end
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 83
83: def time_discovery(action)
@@ -729,28 +1279,36 @@ Utility to time discovery from :start to :end
90: end
91: rescue
92: @discoverytime = 0
-93: end
-
-
+
+
+
+
+
+
+ to_hash()
+ click to toggle source
+
+
+
+
+
+
+48: end
+ returns a hash of our stats
- -
+
+
+
+
-
-
# File lib/mcollective/rpc/stats.rb, line 33
33: def to_hash
@@ -768,22 +1326,33 @@ returns a hash of our stats
45: :failcount => @failcount,
46: :aggregate_summary => @aggregate_summary,
47: :aggregate_failures => @aggregate_failures}
-48: end
-
-