dbt-snowflake-query-tags

From the SELECT team, a dbt package to automatically tag dbt-issued queries with informative metadata. This package uses both query comments and query tagging.

An example query comment contains:

{
    "dbt_snowflake_query_tags_version": "2.3.2",
    "app": "dbt",
    "dbt_version": "1.4.0",
    "project_name": "my_project",
    "target_name": "dev",
    "target_database": "dev",
    "target_schema": "dev",
    "invocation_id": "4ffa20a1-5d90-4a27-a58a-553bb6890f25",
    "node_refs": [
        "model_b",
        "model_c"
    ],
    "node_name": "model_a",
    "node_alias": "model_a",
    "node_package_name": "my_project",
    "node_original_file_path": "models/model_a.sql",
    "node_database": "dev",
    "node_schema": "dev",
    "node_id": "model.my_project.model_a",
    "node_resource_type": "model",
    "node_tags": ["tag_1", "tag_2"],
    "node_meta": {"owner": "@alice", "model_maturity": "in dev"},
    "materialized": "incremental",
    "full_refresh": false,
    "which": "run"

    -- dbt Cloud only
    "dbt_cloud_project_id": "146126",
    "dbt_cloud_job_id": "184124",
    "dbt_cloud_run_id": "107122910",
    "dbt_cloud_run_reason_category": "other",
    "dbt_cloud_run_reason": "Kicked off from UI by [email protected]",
}

Query tags are used solely for attaching the is_incremental flag, as this isn't available to the query comment:

{
    "dbt_snowflake_query_tags_version": "2.3.2",
    "app": "dbt",
    "is_incremental": true
}

Quickstart

1. Add this package to your packages.yml file, then install it with dbt deps.

packages:
  - package: get-select/dbt_snowflake_query_tags
    version: [">=2.0.0", "<3.0.0"]

2. Adding the query tags

Option 1: If running dbt < 1.2, create a folder named macros in your dbt project's top level directory (if it doesn't exist). Inside, make a new file called query_tags.sql with the following content:

{% macro set_query_tag() -%}
{% do return(dbt_snowflake_query_tags.set_query_tag()) %}
{% endmacro %}

{% macro unset_query_tag(original_query_tag) -%}
{% do return(dbt_snowflake_query_tags.unset_query_tag(original_query_tag)) %}
{% endmacro %}

Option 2: If running dbt >= 1.2, simply configure the dispatch search order in dbt_project.yml.

dispatch:
  - macro_namespace: dbt
    search_order:
      - <YOUR_PROJECT_NAME>
      - dbt_snowflake_query_tags
      - dbt

3. To configure the query comments, add the following config to dbt_project.yml.

query-comment:
  comment: '{{ dbt_snowflake_query_tags.get_query_comment(node) }}'
  append: true # Snowflake removes prefixed comments.

That's it! All dbt-issued queries will now be tagged.

Adding additional metadata

Query comments

Meta and tag model configs

Both meta and tag configs are automatically added to the query comments.

'extra' kwarg

To add arbitrary keys and values to the comments, you can use the extra kwarg when calling dbt_snowflake_query_tags.get_query_comment. For example, to add a run_started_at key and value to the comment, we can do:

query-comment:
  comment: '{{ dbt_snowflake_query_tags.get_query_comment(node, extra={"run_started_at": builtins.run_started_at | string }) }}'
  append: true # Snowflake removes prefixed comments.

Adding env vars to query comments

Here's an example of how you can add environment variables into the query comment:

query-comment:
  comment: >
    {{ dbt_snowflake_query_tags.get_query_comment(
      node,
      extra={
        'CI_PIPELINE_ID': env_var('CI_PIPELINE_ID'),
        'CI_JOB_NAME': env_var('CI_JOB_NAME'),
        'CI_COMMIT_REF_NAME': env_var('CI_COMMIT_REF_NAME'),
        'CI_RUNNER_TAGS': env_var('CI_RUNNER_TAGS')
      }
    ) }}
  append: true # Snowflake removes prefixed comments.

Query tags

To extend the information added in the query tags, there are a few options:

Model config

Set the query_tag config value to a mapping type. Example:

Model

{{ config(
    query_tag = {'team': 'data'}
) }}

select ...

Results in the following query tag. The additional information is added by this package.

'{"team": "data", "app": "dbt", "dbt_snowflake_query_tags_version": "2.3.2", "is_incremental": true}'

Note that using a non-mapping type in the query_tag config will result in a warning, and the config being ignored.

Model

{{ config(
    query_tag = 'data team'
) }}

select ...

Warning:

dbt-snowflake-query-tags warning: the query_tag config value of 'data team' is not a mapping type, so is being ignored. If you'd like to add additional query tag information, use a mapping type instead, or remove it to avoid this message.

Profiles.yml

Additionally, you can set the query_tag value in the profiles.yml. This must be a valid json object.

profiles.yml

default:
  outputs:
    dev:
      query_tag: '{"team": "data"}'
      ...
  target: dev

Environment variables

Another option is to use the optional project variable env_vars_to_query_tag_list to provide a list of environment variables to pull query tag values from.

Example:

dbt_project.yml:

  vars:
    env_vars_to_query_tag_list: ['TEAM','JOB_NAME']

Results in a final query tag of

'{"team": "data", "job_name": "daily", "app": "dbt", "dbt_snowflake_query_tags_version": "2.3.2", "is_incremental": true}'

'extra' kwarg

Like the query comment macro, the query tag macro also supports an 'extra' kwarg. To make use of it, you'll need to configure this package following the dbt < 1.2 instructions. Then you can add any logic you like for additional query tag metadata in query_tags.sql.

{% macro set_query_tag() -%}
    {% do return(dbt_snowflake_query_tags.set_query_tag(
        extra={
            'custom_config_property': config.get('custom_config_property'),
        }
    )) %}
{% endmacro %}

{% macro unset_query_tag(original_query_tag) -%}
    {% do return(dbt_snowflake_query_tags.unset_query_tag(original_query_tag)) %}
{% endmacro %}

Contributing

Adding a CHANGELOG Entry

We use changie to generate CHANGELOG entries. Note: Do not edit the CHANGELOG.md directly. Your modifications will be lost.

Follow the steps to install changie for your system.

Once changie is installed and your PR is created, simply run changie new and changie will walk you through the process of creating a changelog entry. Commit the file that's created and your changelog entry is complete!