Для чего нужен раздел
В этом разделе можно задать формулу по доступным переменным и выбрать формат результата. Шаблоны объединяют метрики, графики, таблицы и текст. В текущей версии отчёты запускаются вручную; поля расписания и получателей сохраняются, но не запускают рассылку.
Когда использовать
- Когда нужный команде показатель можно рассчитать из доступных данных, но готовой карточки для него нет.
- Когда нужен повторно используемый макет отчёта для ручного запуска.
- Когда одну метрику нужно считать одинаково в нескольких командах.
Первые шаги
- 1Создайте метрику, выберите тип данных и единицу, напишите формулу.
- 2Смотрите на предпросмотр — он считает по тестовым данным и подсказывает, если скобки не сходятся или переменной не существует.
- 3Соберите шаблон отчёта, добавьте разделы (метрики, график, таблица, свободный текст) и выберите тип графика там, где он помогает.
- 4Запустите шаблон вручную и проверьте его статус в истории запусков.
Настройки
| Настройка | Что делает | Как настроить | Типичная ошибка |
|---|---|---|---|
| Формула | Определяет, как метрика считается из доступных переменных. | Дайте формуле понятное название и опишите, что означает результат. Проверьте её на простом примере. | Не учесть, что знаменатель может быть нулём в период без активности. |
| Тип данных и единица | Управляет форматированием значения и его отображением на графиках. | Укажите единицу измерения, чтобы было понятно, что означает число: часы, количество или процент. | Пометить отношение как число, и в отчёте появится 0,87 там, где все ждали 87%. |
| Период по умолчанию | Задаёт даты расчёта, когда пользователь не выбрал другой период. | Согласуйте его с периодом, который обычно используется при ручном запуске. | Недельный период по умолчанию у метрики, которая попадает в месячный отчёт: под одним названием получаются два разных числа. |
| Расписание и получатели | Хранит поля расписания и получателей в шаблоне; автоматическая отправка пока не выполняется. | Запускайте отчёты вручную и самостоятельно передавайте выгрузку получателям. | Ожидать, что сохранённое расписание запустит фоновый отчёт или отправит письмо в текущей версии. |
Пример использования
Ситуация: Команде нужна повторно используемая метрика доли смёрдженных пулл-реквестов.
- 1Создайте процентную метрику по числу открытых и смёрдженных пулл-реквестов с проверкой деления на ноль.
- 2Проверьте предпросмотр и единицу измерения.
- 3Добавьте метрику в шаблон и запустите отчёт вручную.
Что станет понятно: Одна и та же формула и структура используются при каждом ручном запуске.
Частые вопросы
Почему предпросмотр показывает ошибку?
Проверьте парность скобок, названия переменных и деление на ноль. Список доступных переменных находится рядом с редактором.
Расписание и получатели запускают автоматическую рассылку?
Нет. Эти поля сохраняются в шаблоне, но формирование и доставка отчётов в текущей версии выполняются вручную.
Чем это отличается от «Отчётов»?
«Отчёты» создают фиксированную сводку по спринту. «Пользовательские метрики» позволяют управлять формулами и макетами для ручного запуска.
Практические советы
- Расчёт использует данные выбранных команды, дат, репозитория и пользователя. Отсутствующее значение и деление на ноль показываются как ошибка, а не нулевой результат.
- Завершённый запуск сохраняет формулы и полученные значения. Скачайте JSON или CSV либо используйте печать с сохранением в PDF. Графики пока экспортируются таблицами значений.
- Старый запуск без сохранённых результатов нужно повторить. При изменении формулы запишите, что изменилось, чтобы не сравнивать разные расчёты как один показатель.