Свойства метрик
Метрики определяют измеримые величины, которые можно запрашивать через Semantic Layer. Место их определения зависит от версии dbt:
- В модели с использованием новейшей спецификации YAML. Список
metrics:верхнего уровня в модели с включённым семантическим моделированием, наряду сsemantic_model:иcolumns:. Доступно в канале выпусков v1 Latest dbt platform и в dbt v2. - В отдельном файле с использованием устаревшей спецификации YAML. Подробнее см. в разделе Создание метрик.
Последняя версия спецификации YAML поддерживается в следующих средах:
- dbt platform (v1, канал обновлений Latest)
- dbt v2
- dbt v1.12
Подробнее см. в разделе Переход на последнюю версию спецификации YAML.
Новейшая спецификация (YAML модели)
В новейшей спецификации YAML метрики можно определять в модели с включённым семантическим моделированием. Добавьте список metrics верхнего уровня наряду с semantic_model и columns (метрики не вкладываются в semantic_model). Настройки, зависящие от типа, задаются ключами верхнего уровня в каждой метрике.
Доступные свойства метрик (новейшая спецификация)
| Свойство | Тип | Обязательное | Описание |
|---|---|---|---|
| name | string | Да | Уникальное имя метрики. Используйте строчные латинские буквы, цифры и символы подчёркивания. |
| type | string | Да | Одно из значений: simple, cumulative, ratio, derived, conversion. |
| description | string | Нет | Документация метрики. |
| label | string | Нет | Отображаемое имя в инструментах, использующих метрику. |
| filter | string | Нет | Выражение фильтра MetricFlow (измерения, сущности или другие метрики). |
| config | object | Нет | Поддерживает meta, group, tags, enabled. |
Свойства по типам метрик (новейшая спецификация)
| Тип метрики | Основные свойства |
|---|---|
| Все | name, type, description, label, hidden, filter, config |
| Простая | agg, expr, time_granularity, agg_time_dimension, join_to_timespine, fill_nulls_with; необязательное свойство non_additive_dimension |
| Производная | expr, input_metrics (для каждой метрики необязательные alias, filter, offset_window) |
| Отношение | numerator, denominator (каждое значение — имя метрики или словарь с name, filter, alias) |
| Конверсионная | entity, calculation, base_metric, conversion_metric, window; необязательное свойство constant_properties |
| Накопительная | input_metric, window, grain_to_date, period_agg |
Метрики, использующие несколько моделей: Метрики в списке metrics: модели могут ссылаться только на эту семантическую модель. Метрики, зависящие от других семантических моделей (например, накопительные, отношения, производные или конверсионные метрики, использующие несколько моделей), размещаются в блоке metrics: верхнего уровня (вне models:). Этот блок может находиться в том же файле YAML или в отдельном файле.
Примечание: В устаревшей спецификации все метрики определялись в отдельных файлах YAML; списка metrics: на уровне модели не было.
Подробнее о новейшей спецификации см. в разделе Семантические модели. О типах метрик, type_params и дополнительных примерах см. в разделе Создание метрик.
