Guides: Отчёты по электронной почте

Mon, 01 Jan 0001 00:00:00 +0000

На этой странице:

Введение
Как открыть
Список отчётов
Создание отчёта
Отчётный период
Переменные дашборда
Отправка вручную
История запусков
Настройка почтового сервера
Права доступа
Типичные сценарии

Введение

Отчёты — механизм регулярной рассылки состояния системы тем, кто не заходит в интерфейс платформы каждый день: руководителям, владельцам сервисов, смежным командам, заказчику по договору обслуживания.

Отчёт собирается из существующего дашборда: платформа отрисовывает дашборд за завершившийся отчётный период, сохраняет его в PDF и отправляет письмом списку получателей. Отдельный конструктор отчётов не нужен — если дашборд уже настроен, его можно поставить на рассылку.

Версия

Данный функционал доступен начиная с версии 202.

Как открыть

Главное меню → Дашборды и отчёты → вкладка Отчёты.

Вкладка отображается только пользователям с правами администратора на ресурс reports (см. Права доступа).

Список отчётов

Таблица со всеми настроенными отчётами:

Колонка	Описание
Имя	Название отчёта; используется в теме письма по умолчанию и в имени файла вложения
Дашборд	Дашборд-источник. Если дашборд удалён, показывается «Дашборд недоступен»
Расписание	Человекочитаемая сводка: «Ежедневно в 09:00», «Еженедельно, Пн в 09:00», «Ежемесячно, 1-го в 09:00»
Получатели	Адреса, на которые уходит письмо
Вкл.	Переключатель. Выключенный отчёт сохраняется, но не отправляется по расписанию
Последний запуск	Время и результат последней отправки

Действия по строке: Отправить сейчас, История, Изменить, Удалить.

Создание отчёта

Кнопка Создать отчёт открывает форму.

Поле	Описание
Имя	Обязательно. Отображается в списке и в теме письма по умолчанию
Дашборд	Обязательно. Выбор из пользовательских дашбордов, поиск по имени
Периодичность	Ежедневно, Еженедельно или Ежемесячно
Время отправки	Время суток в выбранном часовом поясе
День недели	Только для еженедельной периодичности
День месяца	Только для ежемесячной периодичности, значения 1–28
Часовой пояс	Обязательно. Расписание считается в нём, а не в UTC и не в поясе браузера
Получатели	Один или несколько email; адрес вводится и подтверждается клавишей `Enter`
Тема письма	Необязательно. По умолчанию — `Отчёт ProtoOBP: <имя отчёта> за <период>`
Переменные дашборда	Необязательно, JSON-объект. См. Переменные дашборда

День месяца

Диапазон ограничен 1–28, чтобы ежемесячный отчёт уходил в одну и ту же дату в любом месяце, включая февраль.

Отчётный период

Отдельно задавать период не требуется — он однозначно определяется периодичностью и всегда охватывает завершившийся интервал, а не текущий:

Периодичность	Период отчёта
Ежедневно	Предыдущие календарные сутки (00:00–24:00)
Еженедельно	Предыдущая календарная неделя, с понедельника по воскресенье
Ежемесячно	Предыдущий календарный месяц

Границы периода считаются в часовом поясе отчёта. Период печатается в теле письма и в футере PDF-документа, поэтому у получателя не остаётся сомнений, за какой интервал собраны данные.

Переменные дашборда

Если дашборд использует переменные, их значения задаются в поле Переменные дашборда JSON-объектом:

{"serviceId": "cGF5bWVudC1zZXJ2aWNl"}

Важно

Для дашбордов уровня сервиса (и любых других, где виджеты опираются на переменную) переменные обязательны — без них отчёт придёт пустым.

Отправка вручную

Действие Отправить сейчас ставит внеочередной запуск в очередь — расписание при этом не меняется. Используйте его, чтобы проверить вёрстку отчёта и доставку письма сразу после настройки, не дожидаясь планового времени.

История запусков

Действие История открывает панель со всеми запусками отчёта.

Поле	Описание
Статус	Выполняется, Успех или Ошибка
Запуск	По расписанию или Вручную
Запланирован	Плановое время запуска
Начат	Фактическое время начала
Задержка	Разница между плановым и фактическим временем
Длительность	Время сборки и отправки
Размер	Размер PDF-вложения

У неуспешных запусков доступна кнопка Показать ошибку с текстом сбоя и копированием в буфер обмена — это первое, что стоит приложить к обращению в поддержку. Отдельно помечаются запуски с предупреждениями: письмо ушло, но часть виджетов дашборда не отрисовалась (например, источник данных не ответил).

Повторные отправки

Ошибки отрисовки повторяются один раз автоматически. Ошибки отправки письма не повторяются — иначе получатели рисковали бы получить дубликаты одного отчёта.

Настройка почтового сервера

Отчёты отправляет отдельный сервис платформы, у него собственные параметры SMTP — они не берутся из настроек канала оповещения по электронной почте.

Минимальный набор переменных в файле .env инсталляции:

POBP_REPORT_RUNNER_SMTP_HOST= # адрес почтового сервера
POBP_REPORT_RUNNER_SMTP_USER= # учётная запись отправителя
POBP_REPORT_RUNNER_SMTP_PASSWORD= # пароль отправителя, секрет

Порт (587), режим TLS, адрес отправителя, таймауты и интервалы имеют рабочие значения по умолчанию. Без параметров почтового сервера платформа запускается штатно, но отчёты отправляться не будут — запуски завершатся с ошибкой, видимой в истории.

Служебная учётная запись отчётности заводится автоматически при старте и её пароль одинаков во всех инсталляциях. В промышленной эксплуатации его следует перевыпустить и указать новое значение в переменной POBP_REPORT_RUNNER_KEYCLOAK_CLIENT_SECRET.

Подробности — в инструкции по установке.

Права доступа

Раздел Отчёты доступен при включённом RBAC пользователям с правом admin на ресурс reports. Пользователи без этого права вкладку не видят; на список дашбордов это не влияет.

Все действия с отчётами (создание, изменение, удаление, ручной запуск) фиксируются в журнале аудита.

Типичные сценарии

Еженедельная сводка для руководства. Дашборд с ключевыми показателями сервиса → отчёт «Еженедельно, Пн 09:00» → получатели: руководитель направления и владелец сервиса. В понедельник утром сводка за прошлую неделю уже в почте.
Ежемесячный отчёт по договору обслуживания. Дашборд с SLO и доступностью → отчёт «Ежемесячно, 1-го» → получатели со стороны заказчика. PDF пригоден для приложения к акту.
Ежедневный контроль критичного бизнес-процесса. Дашборд бизнес-процесса → ежедневный отчёт дежурной смене, чтобы утренняя проверка начиналась с фактов, а не с ручного обхода экранов.

См. также

Дашборды — создание дашбордов и переменных, которые становятся источником отчёта.
Экспорт данных — разовая выгрузка дашборда в PDF, изображений и таблиц виджетов.
Управление SLO — отчёт о соответствии SLO за произвольный период.

Документация Proto Observability Platform – отчёты