Skip to content

Commit 1e8a6b2

Browse files
author
Ed Schouten
committed
Check in an initial copy of our Postfix metrics exporter.
0 parents  commit 1e8a6b2

File tree

3 files changed

+369
-0
lines changed

3 files changed

+369
-0
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
postfix_exporter

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎postfix_exporter.go

+167
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
// Copyright 2017 Kumina, https://kumina.nl/
2+
// Licensed under the Apache License, Version 2.0 (the "License");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
//
6+
// http://www.apache.org/licenses/LICENSE-2.0
7+
//
8+
// Unless required by applicable law or agreed to in writing, software
9+
// distributed under the License is distributed on an "AS IS" BASIS,
10+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11+
// See the License for the specific language governing permissions and
12+
// limitations under the License.
13+
14+
package main
15+
16+
import (
17+
"bufio"
18+
"flag"
19+
"io"
20+
"log"
21+
"net"
22+
"net/http"
23+
"os"
24+
"regexp"
25+
"strconv"
26+
"time"
27+
28+
"github.com/prometheus/client_golang/prometheus"
29+
)
30+
31+
var (
32+
postfixUpDesc = prometheus.NewDesc(
33+
prometheus.BuildFQName("unbound", "", "up"),
34+
"Whether scraping Postfix's metrics was successful.",
35+
nil, nil)
36+
)
37+
38+
func CollectShowqFromReader(file io.Reader, ch chan<- prometheus.Metric) error {
39+
scanner := bufio.NewScanner(file)
40+
scanner.Split(bufio.ScanLines)
41+
42+
// Regular expression for matching postqueue's output. Example:
43+
// "A07A81514 5156 Tue Feb 14 13:13:54 MAILER-DAEMON"
44+
messageLine := regexp.MustCompile("^[0-9A-F]+ +(\\d+) (\\w{3} \\w{3} +\\d+ +\\d+:\\d{2}:\\d{2}) +")
45+
46+
// Histograms tracking the messages by size and age.
47+
sizeHistogram := prometheus.NewHistogram(
48+
prometheus.HistogramOpts{
49+
Namespace: "unbound",
50+
Name: "queue_message_size_bytes",
51+
Help: "Size of messages in Postfix's message queue, in bytes",
52+
Buckets: []float64{1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9},
53+
})
54+
ageHistogram := prometheus.NewHistogram(
55+
prometheus.HistogramOpts{
56+
Namespace: "unbound",
57+
Name: "queue_message_age_seconds",
58+
Help: "Age of messages in Postfix's message queue, in seconds",
59+
Buckets: []float64{1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8},
60+
})
61+
62+
now := time.Now()
63+
for scanner.Scan() {
64+
matches := messageLine.FindStringSubmatch(scanner.Text())
65+
if matches != nil {
66+
// Parse the message size.
67+
size, err := strconv.ParseFloat(matches[1], 64)
68+
if err != nil {
69+
return err
70+
}
71+
72+
// Parse the message date. Unfortunately, the
73+
// output contains no year number. Assume it
74+
// applies to the last year for which the
75+
// message date doesn't exceed time.Now().
76+
date, err := time.Parse("Mon Jan 2 15:04:05", matches[2])
77+
if err != nil {
78+
return err
79+
}
80+
date = date.AddDate(now.Year(), 0, 0)
81+
if date.After(now) {
82+
date.AddDate(-1, 0, 0)
83+
}
84+
85+
sizeHistogram.Observe(size)
86+
ageHistogram.Observe(now.Sub(date).Seconds())
87+
}
88+
}
89+
90+
ch <- sizeHistogram
91+
ch <- ageHistogram
92+
return scanner.Err()
93+
}
94+
95+
func CollectShowqFromFile(path string, ch chan<- prometheus.Metric) error {
96+
conn, err := os.Open(path)
97+
if err != nil {
98+
return err
99+
}
100+
return CollectShowqFromReader(conn, ch)
101+
}
102+
103+
func CollectShowqFromSocket(path string, ch chan<- prometheus.Metric) error {
104+
conn, err := net.Dial("unix", path)
105+
if err != nil {
106+
return err
107+
}
108+
return CollectShowqFromReader(conn, ch)
109+
}
110+
111+
type PostfixExporter struct {
112+
showqPath string
113+
}
114+
115+
func NewPostfixExporter(showqPath string) (*PostfixExporter, error) {
116+
return &PostfixExporter{
117+
showqPath: showqPath,
118+
}, nil
119+
}
120+
121+
func (e *PostfixExporter) Describe(ch chan<- *prometheus.Desc) {
122+
ch <- postfixUpDesc
123+
}
124+
125+
func (e *PostfixExporter) Collect(ch chan<- prometheus.Metric) {
126+
err := CollectShowqFromSocket(e.showqPath, ch)
127+
if err == nil {
128+
ch <- prometheus.MustNewConstMetric(
129+
postfixUpDesc,
130+
prometheus.GaugeValue,
131+
1.0)
132+
} else {
133+
log.Printf("Failed to scrape showq socket: %s", err)
134+
ch <- prometheus.MustNewConstMetric(
135+
postfixUpDesc,
136+
prometheus.GaugeValue,
137+
0.0)
138+
}
139+
}
140+
141+
func main() {
142+
var (
143+
listenAddress = flag.String("web.listen-address", ":12345", "Address to listen on for web interface and telemetry.")
144+
metricsPath = flag.String("web.telemetry-path", "/metrics", "Path under which to expose metrics.")
145+
postfixShowqPath = flag.String("postfix.showq_path", "/var/spool/postfix/public/showq", "Path at which Postfix places its showq socket.")
146+
)
147+
flag.Parse()
148+
149+
exporter, err := NewPostfixExporter(*postfixShowqPath)
150+
if err != nil {
151+
panic(err)
152+
}
153+
prometheus.MustRegister(exporter)
154+
155+
http.Handle(*metricsPath, prometheus.Handler())
156+
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
157+
w.Write([]byte(`
158+
<html>
159+
<head><title>Postfix Exporter</title></head>
160+
<body>
161+
<h1>Postfix Exporter</h1>
162+
<p><a href='` + *metricsPath + `'>Metrics</a></p>
163+
</body>
164+
</html>`))
165+
})
166+
log.Fatal(http.ListenAndServe(*listenAddress, nil))
167+
}

0 commit comments

Comments
 (0)