summaryrefslogtreecommitdiffstats
path: root/documentation/documentation/reference/reports.header
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/documentation/reference/reports.header')
-rw-r--r--documentation/documentation/reference/reports.header19
1 files changed, 19 insertions, 0 deletions
diff --git a/documentation/documentation/reference/reports.header b/documentation/documentation/reference/reports.header
new file mode 100644
index 000000000..f919a1aca
--- /dev/null
+++ b/documentation/documentation/reference/reports.header
@@ -0,0 +1,19 @@
+---
+inMenu: true
+title: Reports Reference
+orderInfo: 40
+---
+
+Puppet clients can report back to the server after each
+transaction. This transaction report is sent as a YAML dump and includes every
+log message that was generated during the transaction along with as many metrics
+as Puppet knows how to collect.
+
+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.
+
+Puppet provides multiple report handlers that will process client reports:
+