如何为dbt测试设置自定义名称以提升日志可读性？

dbt默认生成的测试名称常因过长被哈希截断，导致日志可读性差。你可以通过以下几种方式为测试设置自定义名称，让失败日志清晰体现测试作用：

1. 内置测试（如unique、not_null等） #

在模型的.yml配置文件中定义测试时，直接添加name字段：

models:
  - name: orders
    columns:
      - name: order_id
        tests:
          - unique:
              name: 订单ID唯一性校验
          - not_null:
              name: 订单ID非空校验

2. dbt-expectations等第三方包测试 #

对于第三方包提供的测试，同样在配置中加入name参数替换默认冗长名称：

sources:
  - name: exponea
    tables:
      - name: purchase
        tests:
          - dbt_expectations.expect_table_row_count_to_equal_other_table:
              name: 采购表与订单表昨日行数一致性校验
              compare_model: ref('test_exponea_sdv_orders_v')
              filter_condition: "eventoccuredtime between '{{ yesterday() }}' and '{{ today() }}'"
              compare_filter_condition: "timestamp between '{{ yesterday() }}' and '{{ today() }}'"

3. 自定义SQL测试 #

如果是tests/目录下的自定义SQL测试文件，可在文件顶部配置块中指定name：

{{ config(
    name='订单金额合理性校验'
) }}

select *
from {{ ref('orders') }}
where amount < 0 or amount is null

注意事项 #

• 自定义名称要简洁明确，直接点明测试核心作用，比如“订单ID唯一性校验”比模糊命名更直观
• 名称避免使用特殊字符（空格除外），防止dbt解析出错
• 设置后，测试失败时日志会显示你指定的自定义名称，替代默认的冗长哈希名称

内容的提问来源于stack exchange，提问作者Sander van den Oord