diff --git a/docs/openmetrics.md b/docs/openmetrics.md index 2e58b40..df77665 100644 --- a/docs/openmetrics.md +++ b/docs/openmetrics.md @@ -1,9 +1,9 @@ -# OpenMetrics/Promethus telemetry +# OpenMetrics/Prometheus telemetry -Various server statistics is provided in OpenMetrics format by "openmetrics" -module. +Various server statistics are provided in OpenMetrics format by the +"openmetrics" module. -To enable it, add following line to the server config: +To enable it, add the following line to the server config: ``` openmetrics tcp://127.0.0.1:9749 { } ``` @@ -19,22 +19,22 @@ maddy_smtp_failed_logins{module} maddy_smtp_failed_commands{module, command, smtp_code, smtp_enchcode} # Messages rejected with 4xx code due to ratelimiting. maddy_smtp_ratelimit_deferred{module} -# Amount of started SMTP trasanactions started. +# Amount of started SMTP transactions started. maddy_smtp_started_transactions{module} -# Amount of aborted SMTP trasanactions started. +# Amount of aborted SMTP transactions started. maddy_smtp_aborted_transactions{module} -# Amount of completed SMTP trasanactions. +# Amount of completed SMTP transactions. maddy_smtp_completed_transactions{module} # Number of times a check returned 'reject' result (may be more than processed -# messages if check does so on per-recipient basis) +# messages if check does so on per-recipient basis). maddy_check_reject{check} # Number of times a check returned 'quarantine' result (may be more than # processed messages if check does so on per-recipient basis). maddy_check_quarantined{check} -# Amount of queued messages +# Amount of queued messages. maddy_queue_length{module, location} -# Outbound connections established with specific TLS security level +# Outbound connections established with specific TLS security level. maddy_remote_conns_tls_level{module, level} -# Outbound connections established with specific MX security level +# Outbound connections established with specific MX security level. maddy_remote_conns_mx_level{module, level} ```