X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=doc%2Fclasses%2FMCollective%2FRPC%2FAudit.html;fp=doc%2Fclasses%2FMCollective%2FRPC%2FAudit.html;h=c3878f763cac434a66da16ae303bb7379f4aac41;hb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;hp=0000000000000000000000000000000000000000;hpb=8a3fe7daeecccf43dd71c59371c5005400d35101;p=packages%2Fprecise%2Fmcollective.git diff --git a/doc/classes/MCollective/RPC/Audit.html b/doc/classes/MCollective/RPC/Audit.html new file mode 100644 index 0000000..c3878f7 --- /dev/null +++ b/doc/classes/MCollective/RPC/Audit.html @@ -0,0 +1,211 @@ + + + + +
+Class | +MCollective::RPC::Audit | +
In: | +
+
+ lib/mcollective/rpc/audit.rb
+
+ + |
+
Parent: | ++ Object + | +
+Auditing of requests is done only for SimpleRPC requests, you provide a +plugin in the MCollective::Audit::* namespace which the SimpleRPC framework +calls for each message +
++We provide a simple one that logs to a logfile in the class +MCollective::Audit::Logfile you can create your own: +
++Create a class in plugins/mcollective/audit/<yourplugin>.rb +
++You must inherit from MCollective::RPC::Audit +which will take care of registering you with the plugin system. +
++Your plugin must provide audit_request(request, connection) the +request parameter will be an instance of MCollective::RPC::Request +
++To enable auditing you should set: +
++rpcaudit = 1 rpcauditprovider = Logfile +
++in the config file this will enable logging using the +MCollective::Audit::Logile class +
++The Audit class acts as a base for audit plugins +and takes care of registering them with the plugin manager +
+ ++ # File lib/mcollective/rpc/audit.rb, line 29 +29: def self.inherited(klass) +30: PluginManager << {:type => "rpcaudit_plugin", :class => klass.to_s} +31: end ++