← Cloudflare Email Service / email-service / observability

Метрики и аналитика

Email Service предоставляет аналитику, которая позволяет отслеживать производительность отправки и показатели доставки по всем вашим доменам.

Метрики, отображаемые в Панель управления Cloudflare ↗ графики формируются на основе данных Cloudflare GraphQL Analytics API. Вы можете получить доступ к метрикам программно через GraphQL или HTTP-клиент.

Сейчас Email Service предоставляет следующие метрики:

Метрики можно запрашивать (и они хранятся) за последние 31 день.

Аналитика Email Service по доменам доступна в панели управления Cloudflare. Чтобы посмотреть текущие и исторические метрики:

1. Войдите в Панель управления Cloudflare ↗ и выберите свой аккаунт.
2. Перейдите в Вычисления > Служба электронной почты и выберите Email Sending или Email Routing.
3. Выберите существующий домен или просмотрите общеаккаунтные метрики.
4. Выберите Аналитика на вкладке.

При необходимости можно выбрать временной интервал для запроса. По умолчанию используются последние 24 часа.

Вы можете программно запрашивать аналитику по доменам Email Service через GraphQL Analytics API. Этот API запрашивает те же наборы данных, что и панель управления Cloudflare, и поддерживает GraphQL интроспекция.

Чтобы начать использовать GraphQL Analytics API, следуйте документации по настройке Аутентификация для GraphQL Analytics API. Ваш API-токен должен включать Analytics Read разрешение.

Это на уровне зоны наборы данных. Чтобы выполнять к ним запросы, укажите идентификатор зоны (не идентификатор аккаунта) в качестве zoneTag фильтр. Наборы данных GraphQL для Email Service включают:

• emailSendingAdaptiveGroups : агрегированные показатели отправки писем с группируемыми измерениями
• emailSendingAdaptive : отдельные события отправки писем
• emailRoutingAdaptiveGroups : агрегированные показатели маршрутизации писем с группируемыми измерениями
• emailRoutingAdaptive : отдельные события маршрутизации писем

emailSendingAdaptiveGroups набор данных поддерживает следующие измерения для группировки и фильтрации:

emailSendingAdaptive набор данных включает всё перечисленное выше, а также поля для каждого события: from, to, subject, messageId, sessionId, errorDetail.

emailRoutingAdaptiveGroups набор данных поддерживает следующие измерения для группировки и фильтрации:

emailRoutingAdaptive набор данных включает всё перечисленное выше, а также поля для каждого события: from, to, subject, messageId, sessionId, errorDetail, ruleMatched.

Ниже приведены типичные запросы GraphQL, которые можно использовать для получения данных аналитики Email Service. В этих запросах используется переменная $zoneTag, в качестве значения которого нужно указать Zone ID вашей зоны Cloudflare. Найти его можно в панели управления Cloudflare в разделе Обзор страницу.

{
	"zoneTag": "<YOUR_ZONE_ID>",
	"start": "2024-07-15",
	"end": "2024-07-30"
}

Чтобы запросить количество писем за заданный диапазон дат, сгруппированное по date и status (например, delivered, deliveryFailed):

query EmailSendingByStatus($zoneTag: string!, $start: Date!, $end: Date!) {
	viewer {
		zones(filter: { zoneTag: $zoneTag }) {
			emailSendingAdaptiveGroups(
				filter: { date_geq: $start, date_leq: $end }
				limit: 10000
				orderBy: [date_DESC]
			) {
				count
				dimensions {
					date
					status
				}
			}
		}
	}
}

Чтобы изучить причины сбоев доставки за определённый диапазон дат, сгруппированные по errorCause и sendingDomain:

query EmailDeliveryFailures($zoneTag: string!, $start: Date!, $end: Date!) {
	viewer {
		zones(filter: { zoneTag: $zoneTag }) {
			emailSendingAdaptiveGroups(
				filter: { date_geq: $start, date_leq: $end, status: "deliveryFailed" }
				limit: 10000
				orderBy: [date_DESC]
			) {
				count
				dimensions {
					date
					errorCause
					sendingDomain
				}
			}
		}
	}
}

Чтобы запросить объём отправленных писем с группировкой по часам и выявить закономерности трафика:

query EmailSendingHourlyVolume($zoneTag: string!, $start: Time!, $end: Time!) {
	viewer {
		zones(filter: { zoneTag: $zoneTag }) {
			emailSendingAdaptiveGroups(
				filter: { datetimeHour_geq: $start, datetimeHour_leq: $end }
				limit: 10000
				orderBy: [datetimeHour_ASC]
			) {
				count
				dimensions {
					datetimeHour
					status
				}
			}
		}
	}
}

Чтобы запросить отдельные события писем для устранения конкретных проблем с доставкой. Здесь используется emailSendingAdaptive набор данных и выполняет фильтрацию по datetime (тип Time):

query RecentEmailEvents($zoneTag: string!, $start: Time!, $end: Time!) {
	viewer {
		zones(filter: { zoneTag: $zoneTag }) {
			emailSendingAdaptive(
				filter: { datetime_geq: $start, datetime_leq: $end }
				limit: 50
				orderBy: [datetime_DESC]
			) {
				datetime
				from
				to
				subject
				status
				eventType
				sendingDomain
				messageId
				errorCause
				errorDetail
				dkim
				dmarc
				spf
				isSpam
			}
		}
	}
}

Чтобы запросить количество маршрутизированных писем за заданный диапазон дат, сгруппированное по date и status:

query EmailRoutingByStatus($zoneTag: string!, $start: Date!, $end: Date!) {
	viewer {
		zones(filter: { zoneTag: $zoneTag }) {
			emailRoutingAdaptiveGroups(
				filter: { date_geq: $start, date_leq: $end }
				limit: 10000
				orderBy: [date_DESC]
			) {
				count
				dimensions {
					date
					status
				}
			}
		}
	}
}

Чтобы увидеть, какие правила маршрутизации соответствуют письмам, сгруппированные по ruleMatched и action:

query EmailRoutingRuleActivity($zoneTag: string!, $start: Date!, $end: Date!) {
	viewer {
		zones(filter: { zoneTag: $zoneTag }) {
			emailRoutingAdaptiveGroups(
				filter: { date_geq: $start, date_leq: $end }
				limit: 10000
				orderBy: [date_DESC]
			) {
				count
				dimensions {
					date
					ruleMatched
					action
				}
			}
		}
	}
}

Чтобы запросить отдельные события маршрутизации для устранения неполадок:

query RecentRoutingEvents($zoneTag: string!, $start: Time!, $end: Time!) {
	viewer {
		zones(filter: { zoneTag: $zoneTag }) {
			emailRoutingAdaptive(
				filter: { datetime_geq: $start, datetime_leq: $end }
				limit: 50
				orderBy: [datetime_DESC]
			) {
				datetime
				from
				to
				subject
				status
				action
				ruleMatched
				messageId
				errorDetail
				dkim
				dmarc
				spf
				isSpam
			}
		}
	}
}

• Журналы писем : просматривайте активность по отдельным письмам в панели управления.
• Журналы аудита : отслеживайте изменения конфигурации.
• GraphQL Analytics API : полный справочник по GraphQL API.