Skip to content

Commit 2794b7c

Browse files
committed
[report] updating README.
1 parent 3c572fc commit 2794b7c

1 file changed

Lines changed: 38 additions & 23 deletions

File tree

README.md

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -70,40 +70,55 @@ Reporting
7070
---------
7171
To enable reporting of changes to the Datadog timeline, enable the report
7272
processor on your Puppet master, and enable reporting for your clients.
73-
The clients will send a run report after each check-in back to the master,
74-
and the master will process the reports and send them to the Datadog API.
73+
The clients will send a run report after each check-in back to the master.
7574

75+
Please specify what clients/hosts you'd like to submit puppet run reports
76+
for by setting the puppet_run_reports option to true in the node configuration
77+
manifest.
7678

77-
In your Puppet master `/etc/puppet/puppet.conf`, add these configuration options:
78-
79-
[main]
80-
# No need to modify this section
79+
```ruby
80+
class { "datadog-agent":
81+
api_key => "<your_api_key>",
82+
puppet_run_reports => true
8183
# ...
84+
}
85+
```
8286

83-
[master]
84-
# Enable reporting to datadog
85-
reports=datadog_reports
86-
# If you use other reports already, just add datadog_reports at the end
87-
# reports=store,log,datadog_reports
88-
# ...
87+
In your Puppet master `/etc/puppet/puppet.conf`, add these configuration options:
8988

90-
[agent]
91-
# ...
92-
pluginsync=true
93-
report=true
89+
```ini
90+
[main]
91+
# No need to modify this section
92+
# ...
93+
94+
[master]
95+
# Enable reporting to datadog
96+
reports=datadog_reports
97+
# If you use other reports already, just add datadog_reports at the end
98+
# reports=store,log,datadog_reports
99+
# ...
100+
101+
[agent]
102+
# ...
103+
pluginsync=true
104+
report=true
105+
```
94106

95107
And on all of your Puppet client nodes add:
96108

97-
[agent]
98-
# ...
99-
report=true
100-
109+
```ini
110+
[agent]
111+
# ...
112+
report=true
113+
```
101114

102115
If you get
103116

104-
err: Could not send report:
105-
Error 400 on SERVER: Could not autoload datadog_reports:
106-
Class Datadog_reports is already defined in Puppet::Reports
117+
```
118+
err: Could not send report:
119+
Error 400 on SERVER: Could not autoload datadog_reports:
120+
Class Datadog_reports is already defined in Puppet::Reports
121+
```
107122

108123
Make sure `reports=datadog_reports` is defined in **[master]**, not **[main]**.
109124

0 commit comments

Comments
 (0)