├── .gitignore ├── CHANGELOG.md ├── Dockerfile ├── README.md ├── dovecot_exporter.go └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /dovecot_exporter 2 | .idea/ 3 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 0.1.3 / 2018-09-12 2 | 3 | * [BUGFIX] Use versioned image in build static 4 | * [BUGFIX] Handling row with empty user 5 | 6 | ## 0.1.1 / 2018-02-23 7 | 8 | * [BUGFIX] Add changelog 9 | 10 | ## 0.1.0 / 2018-02-23 11 | 12 | * [ENHANCEMENT] Initial release 13 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM golang:1.8-alpine 2 | ADD . /go/src/github.com/kumina/dovecot_exporter 3 | WORKDIR /go/src/github.com/kumina/dovecot_exporter 4 | RUN apk add --no-cache git && \ 5 | go get -v ./... && \ 6 | go build 7 | 8 | FROM alpine:latest 9 | EXPOSE 9166 10 | WORKDIR / 11 | COPY --from=0 /go/src/github.com/kumina/dovecot_exporter/dovecot_exporter . 12 | ENTRYPOINT ["/dovecot_exporter"] 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Dovecot exporter 2 | 3 | This repository provides a `dovecot_exporter` utility that can be used 4 | to scrape statistics from Dovecot and export them as Prometheus metrics. 5 | It extracts the metrics that are exposed by 6 | [Dovecot's stats module](https://wiki2.dovecot.org/Statistics/Old) by 7 | connecting to UNIX socket `/var/run/dovecot/stats` and serves them as 8 | Prometheus metrics over TCP port 9166. 9 | 10 | A list of command line flags supported by this utility can be obtained 11 | by looking at this exporter's `main()` function. Do note that all 12 | command line flags require two leading dashes (e.g., 13 | `--dovecot.scopes`). 14 | 15 | The metrics provided by this exporter look like this: 16 | 17 | ``` 18 | dovecot_up{scope="user"} 1 19 | dovecot_user_last_update{user="foo@example.com"} 1.482243627730987e+09 20 | dovecot_user_mail_cache_hits{user="foo@example.com"} 298 21 | dovecot_user_mail_lookup_attr{user="foo@example.com"} 4 22 | dovecot_user_mail_lookup_path{user="foo@example.com"} 87 23 | dovecot_user_mail_read_bytes{user="foo@example.com"} 176544 24 | dovecot_user_mail_read_count{user="foo@example.com"} 83 25 | dovecot_user_maj_faults{user="foo@example.com"} 0 26 | dovecot_user_min_faults{user="foo@example.com"} 156053 27 | dovecot_user_num_cmds{user="foo@example.com"} 565 28 | dovecot_user_num_logins{user="foo@example.com"} 80 29 | dovecot_user_read_bytes{user="foo@example.com"} 2.63032577e+08 30 | dovecot_user_read_count{user="foo@example.com"} 73992 31 | dovecot_user_reset_timestamp{user="foo@example.com"} 1.482239247e+09 32 | dovecot_user_sys_cpu{user="foo@example.com"} 2.236 33 | dovecot_user_user_cpu{user="foo@example.com"} 11.944 34 | dovecot_user_vol_cs{user="foo@example.com"} 2981 35 | dovecot_user_write_bytes{user="foo@example.com"} 961822 36 | dovecot_user_write_count{user="foo@example.com"} 4906 37 | ``` 38 | 39 | The interpretation of these metrics is described on 40 | [the Dovecot wiki](https://wiki2.dovecot.org/Statistics/Old#Statistics_gathered). 41 | -------------------------------------------------------------------------------- /dovecot_exporter.go: -------------------------------------------------------------------------------- 1 | // Copyright 2016 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 | "fmt" 19 | "io" 20 | "log" 21 | "net" 22 | "net/http" 23 | "os" 24 | "strconv" 25 | "strings" 26 | 27 | "github.com/prometheus/client_golang/prometheus" 28 | "github.com/prometheus/client_golang/prometheus/promhttp" 29 | "gopkg.in/alecthomas/kingpin.v2" 30 | ) 31 | 32 | var dovecotUpDesc = prometheus.NewDesc( 33 | prometheus.BuildFQName("dovecot", "", "up"), 34 | "Whether scraping Dovecot's metrics was successful.", 35 | []string{"scope"}, 36 | nil) 37 | 38 | // CollectFromReader converts the output of Dovecot's EXPORT command to metrics. 39 | func CollectFromReader(file io.Reader, scope string, ch chan<- prometheus.Metric) error { 40 | if scope == "global" { 41 | return collectGlobalMetricsFromReader(file, scope, ch) 42 | } 43 | return collectDetailMetricsFromReader(file, scope, ch) 44 | } 45 | 46 | // CollectFromFile collects dovecot statistics from the given file 47 | func CollectFromFile(path string, scope string, ch chan<- prometheus.Metric) error { 48 | conn, err := os.Open(path) 49 | if err != nil { 50 | return err 51 | } 52 | return CollectFromReader(conn, scope, ch) 53 | } 54 | 55 | // CollectFromSocket collects statistics from dovecot's stats socket. 56 | func CollectFromSocket(path string, scope string, ch chan<- prometheus.Metric) error { 57 | conn, err := net.Dial("unix", path) 58 | if err != nil { 59 | return err 60 | } 61 | _, err = conn.Write([]byte("EXPORT\t" + scope + "\n")) 62 | if err != nil { 63 | return err 64 | } 65 | return CollectFromReader(conn, scope, ch) 66 | } 67 | 68 | // collectGlobalMetricsFromReader collects dovecot "global" scope metrics from 69 | // the supplied reader. 70 | func collectGlobalMetricsFromReader(reader io.Reader, scope string, ch chan<- prometheus.Metric) error { 71 | scanner := bufio.NewScanner(reader) 72 | scanner.Split(bufio.ScanLines) 73 | 74 | // Read first line of input, containing the aggregation and column names. 75 | if !scanner.Scan() { 76 | return fmt.Errorf("Failed to extract columns from input") 77 | } 78 | columnNames := strings.Fields(scanner.Text()) 79 | if len(columnNames) < 1 { 80 | return fmt.Errorf("Input does not provide any columns") 81 | } 82 | 83 | columns := []*prometheus.Desc{} 84 | for _, columnName := range columnNames { 85 | columns = append(columns, prometheus.NewDesc( 86 | prometheus.BuildFQName("dovecot", scope, columnName), 87 | "Help text not provided by this exporter.", 88 | []string{}, 89 | nil)) 90 | } 91 | 92 | // Global metrics only have a single row containing values following the 93 | // line with column names 94 | if !scanner.Scan() { 95 | return scanner.Err() 96 | } 97 | values := strings.Fields(scanner.Text()) 98 | 99 | if len(values) != len(columns) { 100 | return fmt.Errorf("error while parsing row: value count does not match column count") 101 | } 102 | 103 | for i, value := range values { 104 | f, err := strconv.ParseFloat(value, 64) 105 | if err != nil { 106 | return err 107 | } 108 | ch <- prometheus.MustNewConstMetric( 109 | columns[i], 110 | prometheus.UntypedValue, 111 | f, 112 | ) 113 | } 114 | return scanner.Err() 115 | } 116 | 117 | // collectGlobalMetricsFromReader collects dovecot "non-global" scope metrics 118 | // from the supplied reader. 119 | func collectDetailMetricsFromReader(reader io.Reader, scope string, ch chan<- prometheus.Metric) error { 120 | scanner := bufio.NewScanner(reader) 121 | scanner.Split(bufio.ScanLines) 122 | 123 | // Read first line of input, containing the aggregation and column names. 124 | if !scanner.Scan() { 125 | return fmt.Errorf("Failed to extract columns from input") 126 | } 127 | columnNames := strings.Split(scanner.Text(), "\t") 128 | if len(columnNames) < 2 { 129 | return fmt.Errorf("Input does not provide any columns") 130 | } 131 | 132 | columns := []*prometheus.Desc{} 133 | for _, columnName := range columnNames[1:] { 134 | columns = append(columns, prometheus.NewDesc( 135 | prometheus.BuildFQName("dovecot", columnNames[0], columnName), 136 | "Help text not provided by this exporter.", 137 | []string{columnNames[0]}, 138 | nil)) 139 | } 140 | 141 | // Read successive lines, containing the values. 142 | for scanner.Scan() { 143 | row := scanner.Text() 144 | if strings.TrimSpace(row) == "" { 145 | break 146 | } 147 | 148 | values := strings.Split(row, "\t") 149 | if len(values) != len(columns)+1 { 150 | return fmt.Errorf("error while parsing rows: value count does not match column count") 151 | } 152 | if values[0] == "" { 153 | values[0] = "empty_user" 154 | } 155 | 156 | for i, value := range values[1:] { 157 | f, err := strconv.ParseFloat(value, 64) 158 | if err != nil { 159 | return err 160 | } 161 | ch <- prometheus.MustNewConstMetric( 162 | columns[i], 163 | prometheus.UntypedValue, 164 | f, 165 | values[0]) 166 | } 167 | } 168 | return scanner.Err() 169 | } 170 | 171 | type DovecotExporter struct { 172 | scopes []string 173 | socketPath string 174 | } 175 | 176 | func NewDovecotExporter(socketPath string, scopes []string) *DovecotExporter { 177 | return &DovecotExporter{ 178 | scopes: scopes, 179 | socketPath: socketPath, 180 | } 181 | } 182 | 183 | func (e *DovecotExporter) Describe(ch chan<- *prometheus.Desc) { 184 | ch <- dovecotUpDesc 185 | } 186 | 187 | func (e *DovecotExporter) Collect(ch chan<- prometheus.Metric) { 188 | for _, scope := range e.scopes { 189 | err := CollectFromSocket(e.socketPath, scope, ch) 190 | if err == nil { 191 | ch <- prometheus.MustNewConstMetric( 192 | dovecotUpDesc, 193 | prometheus.GaugeValue, 194 | 1.0, 195 | scope) 196 | } else { 197 | log.Printf("Failed to scrape socket: %s", err) 198 | ch <- prometheus.MustNewConstMetric( 199 | dovecotUpDesc, 200 | prometheus.GaugeValue, 201 | 0.0, 202 | scope) 203 | } 204 | } 205 | } 206 | 207 | func main() { 208 | var ( 209 | app = kingpin.New("dovecot_exporter", "Prometheus metrics exporter for Dovecot") 210 | listenAddress = app.Flag("web.listen-address", "Address to listen on for web interface and telemetry.").Default(":9166").String() 211 | metricsPath = app.Flag("web.telemetry-path", "Path under which to expose metrics.").Default("/metrics").String() 212 | socketPath = app.Flag("dovecot.socket-path", "Path under which to expose metrics.").Default("/var/run/dovecot/stats").String() 213 | dovecotScopes = app.Flag("dovecot.scopes", "Stats scopes to query (comma separated)").Default("user").String() 214 | ) 215 | kingpin.MustParse(app.Parse(os.Args[1:])) 216 | 217 | exporter := NewDovecotExporter(*socketPath, strings.Split(*dovecotScopes, ",")) 218 | prometheus.MustRegister(exporter) 219 | 220 | http.Handle(*metricsPath, promhttp.Handler()) 221 | http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { 222 | w.Write([]byte(` 223 | 224 | Dovecot Exporter 225 | 226 |

Dovecot Exporter

227 |

Metrics

228 | 229 | `)) 230 | }) 231 | log.Fatal(http.ListenAndServe(*listenAddress, nil)) 232 | } 233 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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. 202 | --------------------------------------------------------------------------------