Project

General

Profile

Mail Notifications » History » Version 5

Alexander Rusa, 02/25/2011 08:45 AM
typo

1 1 Ohad Levy
h1. Summarized E-Mail Reports
2
3
h2. Overview
4
5
Starting in version 0-1.3 Foreman can send a hourly / daily email report containing information about your nodes.
6 2 Ohad Levy
7 1 Ohad Levy
this information will include: List of hosts that had errors or that have performed any action through puppet.
8
additionally, it would include a list of all of your hosts which didn't run Puppet recently (defaults to 30 minutes).
9
10
h2. Configuration
11
12 2 Ohad Levy
First, make sure that you enable emails in Foreman - at the [[Email configuration]] page.
13
14
Secondly, you would need to setup a cron job:
15 1 Ohad Levy
16
Available options:
17
 * days     => number of days to scan backwards (defaults to 1)
18
 * hours    => number of hours to scan backwards (defaults to disabled)
19
20
Example:
21
<pre>
22
  rake reports:summarize days=3 RAILS_ENV="production" # Sends out a summary email for the last 3 days.
23
</pre>
24
or
25
<pre>
26
  rake reports:summarize hours=12 RAILS_ENV="production" # Sends out a summary email for the last 12 hours.
27
</pre>
28
29
h3. Recipients 
30
31
If you are using LDAP authentication, Foreman will send the reports directly to all registered users, if that's not what you would like, add the following line to your *config/settings.yaml* file:
32
<pre>
33 3 Ohad Levy
#Foreman host, required for http links inside emails
34
:foreman_url: foreman.domain
35 1 Ohad Levy
# where do send out daily report emails, comment out if you want to send to registered Foreman users instead.
36
:administrator: ohadlevy@gmail.com
37
</pre>
38 4 Ohad Levy
39
h1. Emails on Report errors
40
41
Similar to tagmail, foreman can send you notifications once a report which contains an error has been received.
42
43 5 Alexander Rusa
at this point of time, the report would be sent to a mailbox predefined in config/settings.yaml, however in future versions, the report would be sent only to the relevant user (or user group) which manage the host.
44 4 Ohad Levy
45 5 Alexander Rusa
in order to enable please make sure the following two lines exists in your '''config/settings.yaml''' file:
46 4 Ohad Levy
<pre>
47
:administrator: <email address of recipient> 
48
:failed_report_email_notification: true
49
</pre>