X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=website%2Fsimplerpc%2Fauditing.md;fp=website%2Fsimplerpc%2Fauditing.md;h=0000000000000000000000000000000000000000;hb=d1f1649ba43c5cbc43c4beb2380096ba051d646a;hp=2981a190b55244b7305508aa2d676eefcea61bc7;hpb=8a3fe7daeecccf43dd71c59371c5005400d35101;p=packages%2Fprecise%2Fmcollective.git diff --git a/website/simplerpc/auditing.md b/website/simplerpc/auditing.md deleted file mode 100644 index 2981a19..0000000 --- a/website/simplerpc/auditing.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -layout: default -title: SimpleRPC Auditing -toc: false ---- -[SimpleRPCIntroduction]: index.html -[AuditCentralRPCLog]: http://projects.puppetlabs.com/projects/mcollective-plugins/wiki/AuditCentralRPC - -# {{page.title}} - -As part of the [SimpleRPC][SimpleRPCIntroduction] framework we've added an auditing system that you can use to log all requests received into a file or even send it over mcollective to a central auditing system. What actually happens with audit data is pluggable and you can provide your own plugins to do what you need. - -The clients will include the _uid_ of the process running the client library in the requests and the audit function will have access to that on the requests. - -## Configuration -To enable logging you should set an option to enable it and also one to configure which plugin to use: - -{% highlight ini %} -rpcaudit = 1 -rpcauditprovider = Logfile -{% endhighlight %} - -This sets it up to use _MCollective::Audit::Logfile_ plugin for logging evens. - -The client will embed a caller id - the Unix UID of the program running it or SSL cert - in requests which you can find in the _request_ object. - -## Logfile plugin - -Auditing is implemented using plugins that you should install in the normal plugin directory under _mcollective/audit/_. We have a sample Logfile plugin that you can see below: - -{% highlight ruby %} -module MCollective - module RPC - class Logfiletrue, :command=>"check_mailq"} -{% endhighlight %} - -Other plugins can be found on the community site like [a centralized logging plugin][AuditCentralRPCLog].