diff options
author | James Turnbull <james@lovedthanlost.net> | 2008-04-03 19:11:36 +1100 |
---|---|---|
committer | James Turnbull <james@lovedthanlost.net> | 2008-04-03 19:11:36 +1100 |
commit | f9a907342b3312d599ab6661d6f6ae3619e91734 (patch) | |
tree | 91a1831e2981b67232a51a162900cdd1f490038d /lib/puppet/reference | |
parent | 335972edb68a532a61392ace006b0401e3cca810 (diff) | |
parent | 1ad0ceca6cd06f03279125f1f39f11a0beec310b (diff) | |
download | puppet-f9a907342b3312d599ab6661d6f6ae3619e91734.tar.gz puppet-f9a907342b3312d599ab6661d6f6ae3619e91734.tar.xz puppet-f9a907342b3312d599ab6661d6f6ae3619e91734.zip |
Merge branch '0.24.x' of git://reductivelabs.com/puppet into 0.24.x
Diffstat (limited to 'lib/puppet/reference')
-rw-r--r-- | lib/puppet/reference/report.rb | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/puppet/reference/report.rb b/lib/puppet/reference/report.rb new file mode 100644 index 000000000..be8e64751 --- /dev/null +++ b/lib/puppet/reference/report.rb @@ -0,0 +1,23 @@ +require 'puppet/reports' + +report = Puppet::Util::Reference.newreference :report, :doc => "All available transaction reports" do + Puppet::Reports.reportdocs +end + +report.header = " +Puppet clients can report back to the server after each transaction. This +transaction report is sent as a YAML dump of the +``Puppet::Transaction::Report`` class and includes every log message that was +generated during the transaction along with as many metrics as Puppet knows how +to collect. See `ReportsAndReporting Reports and Reporting`:trac: +for more information on how to use reports. + +Currently, clients default to not sending in reports; you can enable reporting +by setting the ``report`` parameter to true. + +To use a report, set the ``reports`` parameter on the server; multiple +reports must be comma-separated. You can also specify ``none`` to disable +reports entirely. + +Puppet provides multiple report handlers that will process client reports: +" |