Observability Metrics - SEG
Observability Metrics for Secure Email Gateway provide real-time insight into inbound and outbound email processing, filtering behavior, and delivery performance.
📌 Observability Metrics overview
This tutorial describes how to set up Observability Metrics and how to integrate them into your observability platform. For a general explanation of Observability Metrics, including data format and access model, refer to Observability Metrics Overview.
Setup overview
Setting up Observability Metrics for Secure Email Gateway consists of three steps.
Endpoint and authentication
Endpoint
https://api.retarus.com/stable/retarus/metrics/1.0/[your_customer_number]
Authentication
Access requires Basic authentication.
Requirements
Host
You must run a Prometheus server in your environment.Connectivity
Your system must be able to reach the Retarus Observability Metrics endpoint over a public HTTPS connection.Configuration
Yourprometheus.ymlconfiguration file must include aremote_readsection.Scrape interval
Observability Metrics use a pull-based model. You define the scrape interval in your Prometheus configuration. The minimum supported scrape interval is 1 minute. Shorter intervals do not provide fresher data.
Available metrics
Secure Email Gateway exposes the following metrics for email processing and security filtering:
Metric name | Type | Description |
|---|---|---|
| Counter | Total number of inbound mails in the whole system. |
| Counter | Total number of outbound mails in the whole system. |
| Summary | Sum of the processing times that inbound mails took in the system (only when they are actually sent to you). |
| Counter | Total number of inbound mails that are actually sent to you. |
| Summary | Sum of the processing times that outbound mails took in the system (only when they are actually sent to the internet). |
| Counter | Total number of outbound mails that are actually sent to the internet. |
Metrics labels
Secure Email Gateway metrics include the following labels:
Name | Type | Description | Values / Examples |
|---|---|---|---|
| Enum | Indicates which Retarus datacenter processed the message. | DE1 (Frankfurt), DE2 (Munich) |
| Enum | Shows the phase in which the message reached its final processing status. | FILTER (email analysis), DELIVER (Postfix delivery) |
| Enum | Status of the email. | OK, ERROR, REJECT, QUARANTINE |
| Integer | Status code corresponding to status and substatus. | e.g. 200, 500, 505 |
| Enum | Substatus of the email. | e.g. DirFilter, DNS, Virus, SenderRestriction, SpamProbabilityLimit, NDR Spam, AntiSpam, Phishing, Blocklist, Attachment-Type |
Usage
Use the provided endpoint (compatible with Prometheus) to retrieve metrics data. You can filter metrics, create dashboards, define alert thresholds, and analyze inbound and outbound traffic patterns within your observability platform. You control how long metrics are retained in your own environment.