Skip to content

Troubleshooting Column Description Propagation #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Troubleshooting Column Description Propagation #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8c98aa
Update docs-propagation.md
Apr 18, 2025
5fcb8f7
Update lineage.md
Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/api/tutorials/lineage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,15 @@ You can now see the lineage between `fct_users_deleted` and `logging_events`.
</TabItem>
</Tabs>

### Troubleshooting Column Description Propagation

To troubleshoot column description propagation issues, follow these steps:

- **Verifying Propagation Settings**: Ensure column-level documentation propagation is enabled in the DataHub settings.
- **Checking Lineage Configuration**: Verify that the lineage between columns is correctly configured in the DataHub UI and through code review.
- **Reviewing Ingestion Logs**: Access and interpret ingestion logs from GMS, ingestion services, and the frontend UI for any errors or warnings.
- **Manual Verification of Column Descriptions**: Manually check that column descriptions are correctly set in the source dataset and verify their presence in the DataHub UI.

### Expected Outcome

You can now see the column-level lineage between datasets. Note that you have to enable `Show Columns` to be able to see the column-level lineage.
Expand Down
11 changes: 11 additions & 0 deletions docs/automations/docs-propagation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,17 @@ and then click "Rollback".

This one-time step will remove all propagated tags and glossary terms from Snowflake. To simply stop propagating new tags, you can disable the automation.

## Troubleshooting Column Description Propagation

To enhance user support for troubleshooting column description propagation issues in DataHub, follow these common troubleshooting steps:

- **Verifying Propagation Settings**: Ensure that column-level documentation propagation is enabled in the DataHub settings.
- **Checking Lineage Configuration**: Verify that the lineage between columns is correctly configured. Use the DataHub UI to visually confirm the lineage and review the code to ensure correct lineage setup.
- **Reviewing Ingestion Logs**: Access and interpret ingestion logs from various components such as GMS, ingestion services, and the frontend UI to identify any errors or warnings.
- **Manual Verification of Column Descriptions**: Manually verify that column descriptions are correctly set in the source dataset and check their presence in the DataHub UI.

Including examples and command snippets for each step will further assist users in diagnosing and resolving propagation issues effectively.

## Viewing Propagated Descriptions

Once the automation is enabled, you'll be able to recognize propagated descriptions as those with the thunderbolt icon next to them:
Expand Down