summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLuke Kanies <luke@madstop.com>2008-03-31 21:02:52 -0500
committerLuke Kanies <luke@madstop.com>2008-03-31 21:02:52 -0500
commit6f32e95ce25fb6de40836cb7c7678f39c5e77879 (patch)
treebb68daabffe410ce54c8bc0ecb6e5b7a3903b616
parenteae5cee12df708de5cebfbed2fff42a1890070f5 (diff)
downloadpuppet-6f32e95ce25fb6de40836cb7c7678f39c5e77879.tar.gz
puppet-6f32e95ce25fb6de40836cb7c7678f39c5e77879.tar.xz
puppet-6f32e95ce25fb6de40836cb7c7678f39c5e77879.zip
Adding the report reference back; I don't really know
why I removed it, since the information in it isn't anywhere else.
-rw-r--r--lib/puppet/reference/report.rb23
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:
+"