The catalog of :telemetry events emitted by Sovite, and the default
handler that turns them into log lines.
Components emit events named [:sovite, component, ...]. Durations are
in :native time units, as with :telemetry.span/3.
| Event | Measurements | Metadata |
|---|---|---|
[:sovite, :listener, :connection, :start] | system_time | listener, remote_ip, remote_port |
[:sovite, :listener, :connection, :stop] | duration | listener, remote_ip, remote_port |
[:sovite, :listener, :connection, :rejected] | listener, remote_ip, reason | |
[:sovite, :smtp, :server, :session, :start] | system_time | session_id, remote_ip |
[:sovite, :smtp, :server, :session, :stop] | duration | session_id, remote_ip |
[:sovite, :smtp, :server, :command, :stop] | duration | session_id, remote_ip, command, argument, reply_code, reply |
[:sovite, :smtp, :server, :tls, :stop] | duration | session_id, remote_ip, protocol, cipher, sni, error |
[:sovite, :auth, :success] | session_id, remote_ip, mechanism, username | |
[:sovite, :auth, :failure] | session_id, remote_ip, mechanism, username, reason | |
[:sovite, :abuse, :penalty, :banned] | failures | penalty, key, ban_time |
[:sovite, :tls, :certificate, :loaded] | cert_file, names, not_after | |
[:sovite, :tls, :certificate, :error] | cert_file, reason | |
[:sovite, :tls, :acme, :issued] | domains, not_after | |
[:sovite, :tls, :acme, :failed] | domains, reason | |
[:sovite, :queue, :message, :enqueued] | size, recipients | queue_id, session_id, sender |
[:sovite, :queue, :message, :removed] | queue_id, reason (delivered, bounced, expired) | |
[:sovite, :queue, :message, :deferred] | attempts, recipients | queue_id, next_attempt |
[:sovite, :queue, :message, :corrupt] | queue_id, reason | |
[:sovite, :queue, :notification, :sent] | recipients | queue_id, kind, to, notification_id |
[:sovite, :queue, :notification, :discarded] | recipients | queue_id, kind, sender |
[:sovite, :smtp, :client, :delivery, :start] | system_time | queue_id, relay |
[:sovite, :smtp, :client, :delivery, :stop] | duration | queue_id, relay, recipient, status, reply |
[:sovite, :smtp, :client, :delivery, :exception] | duration | queue_id, relay, kind, reason |
Delivery :stop events come once per recipient; status is
:delivered, :deferred, or :failed. :notification events are
about the original message: queue_id is its ID, and notification_id
the ID of the queued notification.
Message lifecycle events (:queue, delivery :stop and :exception),
successful logins, certificate loads and ACME issuance, failed TLS
handshakes, and SMTP commands that got a 4xx or 5xx reply are logged at
:info. Corrupt messages, discarded notifications, failed logins, bans,
certificate errors, and failed ACME orders are logged at :warning.
All other events are logged at :debug.
Failed logins are logged as auth.failure: mechanism=PLAIN, reason=invalid_credentials, username=alice with remote_ip in the
metadata, ready for tools such as fail2ban.
Summary
Functions
Attaches the logging handler to every cataloged event. Safe to call repeatedly.
Detaches the logging handler.
Returns every event in the catalog.
Functions
@spec attach_logger() :: :ok
Attaches the logging handler to every cataloged event. Safe to call repeatedly.
@spec detach_logger() :: :ok
Detaches the logging handler.
@spec events() :: [:telemetry.event_name()]
Returns every event in the catalog.