From 4ccddd0c65a1ba827e64d179538cbbbef19a4d5e Mon Sep 17 00:00:00 2001
From: Aki Tuomi <aki.tuomi@open-xchange.com>
Date: Tue, 16 Feb 2021 13:39:02 +0200
Subject: [PATCH] doc/example: 10-metrics.conf - Add metrics related settings

---
 doc/example-config/conf.d/10-metrics.conf | 74 +++++++++++++++++++++++
 doc/example-config/conf.d/Makefile.am     |  1 +
 2 files changed, 75 insertions(+)
 create mode 100644 doc/example-config/conf.d/10-metrics.conf

diff --git a/doc/example-config/conf.d/10-metrics.conf b/doc/example-config/conf.d/10-metrics.conf
new file mode 100644
index 0000000000..f7a758f404
--- /dev/null
+++ b/doc/example-config/conf.d/10-metrics.conf
@@ -0,0 +1,74 @@
+##
+## Statistics and metrics
+##
+
+# Dovecot supports gathering statistics from events.
+# Currently there are no statistics logged by default, and therefore they must
+# be explicitly added using the metric configuration blocks.
+#
+# Unlike old stats, the new statistics do not require any plugins loaded.
+#
+# See https://doc.dovecot.org/configuration_manual/stats/ for more details.
+
+##
+## Example metrics
+##
+
+#metric auth_success {
+#  filter = event=auth_request_finished AND success=yes
+#}
+#
+#metric auth_failures {
+#  filter = event=auth_request_finished AND NOT success=yes
+#}
+#
+#metric imap_command {
+#  filter = event=imap_command_finished
+#  group_by = cmd_name tagged_reply_state
+#}
+#
+#metric smtp_command {
+#  filter = event=smtp_server_command_finished
+#  group_by = cmd_name status_code duration:exponential:1:5:10
+#}
+#
+#metric mail_delivery {
+#  filter = event=mail_delivery_finished
+#  group_by = duration:exponential:1:5:10
+#}
+
+##
+## Prometheus
+##
+
+# To allow access to statistics with Prometheus, enable http listener
+# on stats process. Stats will be available on /metrics path.
+#
+# See https://doc.dovecot.org/configuration_manual/stats/openmetrics/ for more
+# details.
+
+#service stats {
+#  inet_listener http {
+#    port = 9900
+#  }
+#}
+
+##
+## Event exporting
+##
+
+# You can also export individual events.
+#
+# See https://doc.dovecot.org/configuration_manual/event_export/ for more
+# details.
+
+#event_exporter log {
+#  format = json
+#  format_args = time-rfc3339
+#  transport = log
+#}
+#
+#metric imap_commands {
+#  exporter = log
+#  filter = event=imap_command_finished
+#}
diff --git a/doc/example-config/conf.d/Makefile.am b/doc/example-config/conf.d/Makefile.am
index d5d509deff..1950fd518b 100644
--- a/doc/example-config/conf.d/Makefile.am
+++ b/doc/example-config/conf.d/Makefile.am
@@ -16,6 +16,7 @@ example_DATA = \
 	10-logging.conf \
 	10-mail.conf \
 	10-master.conf \
+	10-metrics.conf \
 	10-ssl.conf \
 	15-lda.conf \
 	15-mailboxes.conf \
-- 
2.47.3