Skip to content

Troubleshooting Column Description Propagation #73

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 #73

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
dfdbf8f
Update docs-propagation.md
Apr 18, 2025
61573fd
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

- **Verification of Propagation Settings**: Ensure that column-level documentation propagation is enabled in your DataHub settings.
- **Lineage Configuration Checks**: Verify that the lineage between columns is correctly configured for propagation.
- **Ingestion Log Review**: Review ingestion logs for errors or warnings related to documentation propagation.
- **Manual Verification of Column Descriptions**: Check that the column descriptions are correctly set before propagation.
- **DataHub Version Compatibility**: Confirm that your DataHub version supports the feature and is compatible.
- **Known Issues**: Refer to the DataHub GitHub repository or community forums for known issues or bugs related to column description propagation.

### 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
20 changes: 20 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 @@ -95,6 +95,26 @@ and then click "Initialize".
This one-time step will kick off the back-filling process for existing descriptions. If you only want to begin propagating
descriptions going forward, you can skip this step.

## Troubleshooting Column Description Propagation

### Verification of Propagation Settings
Ensure that column-level documentation propagation is enabled. In Open Source DataHub, this feature is enabled by default. Navigate to 'Settings' > 'Features' to verify.

### Lineage Configuration Checks
Ensure that the lineage between columns is correctly configured for propagation. Verify that the lineage between the source and target columns is established.

### Ingestion Log Review
Review ingestion logs for any errors or warnings related to documentation propagation. This can provide insights into potential issues.

### Manual Verification of Column Descriptions
Manually verify that the column descriptions are correctly set before propagation. Ensure that the source column has the correct description.

### DataHub Version Compatibility
Check the DataHub version for feature support and compatibility. Ensure you are using a version that supports column description propagation.

### Known Issues
Refer to the DataHub GitHub repository or community forums for known issues or bugs related to column description propagation.

## Rolling Back Propagated Descriptions (DataHub Cloud Only)

In DataHub Cloud, you can rollback all descriptions that have been propagated historically.
Expand Down