1Smokeping_probes_SendEmail(3)      SmokePing     Smokeping_probes_SendEmail(3)
2
3
4

NAME

6       Smokeping::probes::SendEmail - a Smokeping probe that measure time
7       needed to send an mail
8

SYNOPSIS

10        *** Probes ***
11
12        +SendEmail
13
14        bodysize = 1024
15        forks = 5
16        from = test@test.com # mandatory
17        offset = 50%
18        step = 300
19        subject = Test Smokeping
20        timeout = 15
21        to = test@test.com # mandatory
22
23        # The following variables can be overridden in each target section
24        /^influx_.+/ = influx_location = In the basement
25        pings = 5
26        port = 25
27
28        # [...]
29
30        *** Targets ***
31
32        probe = SendEmail # if this should be the default probe
33
34        # [...]
35
36        + mytarget
37        # probe = SendEmail # if the default probe is something else
38        host = my.host
39        /^influx_.+/ = influx_location = In the basement
40        pings = 5
41        port = 25
42

DESCRIPTION

44       This probe actually send a mail to a MX server and measure time it
45       took. You can choose the sender and recipient address as well as the
46       size of the mail.
47

VARIABLES

49       Supported probe-specific variables:
50
51       bodysize
52           Size of the mail to send in bytes. If set to 0, a default mail
53           content will be set. Note that mail always contain From, To and
54           Subject headers.
55
56           Example value: 1024
57
58           Default value: 0
59
60       forks
61           Run this many concurrent processes at maximum
62
63           Example value: 5
64
65           Default value: 5
66
67       from
68           Mail from address
69
70           Example value: test@test.com
71
72           This setting is mandatory.
73
74       offset
75           If you run many probes concurrently you may want to prevent them
76           from hitting your network all at the same time. Using the probe-
77           specific offset parameter you can change the point in time when
78           each probe will be run. Offset is specified in % of total interval,
79           or alternatively as 'random', and the offset from the 'General'
80           section is used if nothing is specified here. Note that this does
81           NOT influence the rrds itself, it is just a matter of when data
82           acquisition is initiated.  (This variable is only applicable if the
83           variable 'concurrentprobes' is set in the 'General' section.)
84
85           Example value: 50%
86
87       step
88           Duration of the base interval that this probe should use, if
89           different from the one specified in the 'Database' section. Note
90           that the step in the RRD files is fixed when they are originally
91           generated, and if you change the step parameter afterwards, you'll
92           have to delete the old RRD files or somehow convert them. (This
93           variable is only applicable if the variable 'concurrentprobes' is
94           set in the 'General' section.)
95
96           Example value: 300
97
98       subject
99           Subject of the mail
100
101           Example value: Test Smokeping
102
103           Default value: Test
104
105       timeout
106           How long a single 'ping' takes at maximum
107
108           Example value: 15
109
110           Default value: 5
111
112       to  Rcpt to address
113
114           Example value: test@test.com
115
116           This setting is mandatory.
117
118       Supported target-specific variables:
119
120       /^influx_.+/
121           This is a tag that will be sent to influxdb and has no impact on
122           the probe measurement. The tag name will be sent without the
123           "influx_" prefix, which will be replaced with "tag_" instead. Tags
124           can be used for filtering.
125
126           Example value: influx_location = In the basement
127
128       pings
129           How many pings should be sent to each target, if different from the
130           global value specified in the Database section. Note that the
131           number of pings in the RRD files is fixed when they are originally
132           generated, and if you change this parameter afterwards, you'll have
133           to delete the old RRD files or somehow convert them.
134
135           Example value: 5
136
137       port
138           Port of the SMTP server to reach
139
140           Example value: 25
141
142           Default value: 25
143

AUTHORS

145        Florian Coulmier <florian@coulmier.fr>,
146

SEE ALSO

148       smokeping_extend
149
150
151
1522.8.2                             2022-01-22     Smokeping_probes_SendEmail(3)
Impressum