elementary icon indicating copy to clipboard operation
elementary copied to clipboard

Make source freshness test descriptions configurable

Open waligob opened this issue 9 months ago • 3 comments

Is your feature request related to a problem? Please describe. It appears that the test description for source freshness tests is a hard-coded string.

Describe the solution you'd like It would be helpful if this could be made configurable via a property under the meta block.

Describe alternatives you've considered As a workaround, we're appending metadata to sources[].tables[].description, but that requires navigating from the test results to Elementary's lineage graph, and then selecting "..." > "Node info" in order to view that metadata

Additional context

Image

Would you be willing to contribute this feature? Yes!

This issue is duplicated from https://github.com/elementary-data/dbt-data-reliability/issues/807

waligob avatar Apr 24 '25 21:04 waligob

Hey @waligob ! 🙂 This string is the default in case there's no customized description. Try adding this:

  - elementary.freshness_anomalies:
          meta:
              description: "Your own test description"

Let me know if this helps.

NoyaOffer avatar Apr 27 '25 14:04 NoyaOffer

@NoyaOffer Given the following freshness test configuration, where would your snippet go if I wanted to override the default description?

sources:
  - name: auth0
    loader: Stitch
    tables:
      - name: auth0_export
        description: >
          This table contains an export of our auth0 database.
          auth0 is used for user authentication and is our source for registered users
        loaded_at_field: _sdc_batched_at
        freshness:
          error_after:
            count: 28
            period: hour

waligob avatar Apr 28 '25 19:04 waligob

This issue is stale because it has been open for too long with no activity. If you would like the issue to remain open, please remove the stale label or leave a comment.

github-actions[bot] avatar Nov 12 '25 02:11 github-actions[bot]