diff --git a/docs/api/datahub-apis.md b/docs/api/datahub-apis.md index c46aacde3a0cb5..c4915a47780e2a 100644 --- a/docs/api/datahub-apis.md +++ b/docs/api/datahub-apis.md @@ -73,6 +73,24 @@ Here's an overview of what each API can do. | Remove Owner from a Dataset | ✅ [[Guide]](/docs/api/tutorials/owners.md#remove-owners) | ✅ [[Guide]](/docs/api/tutorials/owners.md) | ✅ | | Add Lineage | ✅ [[Guide]](/docs/api/tutorials/lineage.md) | ✅ [[Guide]](/docs/api/tutorials/lineage.md#add-lineage) | ✅ | | Add Column Level (Fine Grained) Lineage | 🚫 | ✅ [[Guide]](docs/api/tutorials/lineage.md#add-column-level-lineage) | ✅ | + +## Troubleshooting Column Description Propagation + +### Verify Propagation Settings +Ensure that column-level documentation propagation is enabled in your DataHub settings. This feature is enabled by default in Open Source DataHub. + +### Check Lineage Configuration +- **DataHub UI**: Navigate to the dataset and check the "Lineage" tab to ensure column-level lineage is correctly configured. +- **Code**: Verify `FineGrainedLineage` objects are correctly defined in your code. + +### Review Ingestion Logs +- **Docker**: Use `docker logs ` to check logs. +- **Kubernetes**: Use `kubectl logs ` to check logs. +- **CLI**: Use `--debug` flag for detailed logs. + +### Manual Verification +- **DataHub UI**: Check the schema details to ensure the column description is set. +- **Python SDK**: Use the SDK to manually emit metadata if necessary. | Add Documentation (Description) to a Column of a Dataset | ✅ [[Guide]](/docs/api/tutorials/descriptions.md#add-description-on-column) | ✅ [[Guide]](/docs/api/tutorials/descriptions.md#add-description-on-column) | ✅ | | Add Documentation (Description) to a Dataset | ✅ [[Guide]](/docs/api/tutorials/descriptions.md#add-description-on-dataset) | ✅ [[Guide]](/docs/api/tutorials/descriptions.md#add-description-on-dataset) | ✅ | | Add / Remove / Replace Custom Properties on a Dataset | 🚫 | ✅ [[Guide]](/docs/api/tutorials/custom-properties.md) | ✅ | diff --git a/docs/api/tutorials/lineage.md b/docs/api/tutorials/lineage.md index daa8f548b2360f..1402dd2b8711d4 100644 --- a/docs/api/tutorials/lineage.md +++ b/docs/api/tutorials/lineage.md @@ -139,6 +139,25 @@ You can now see the column-level lineage between datasets. Note that you have to

+## Troubleshooting Column Description Propagation + +### Verify Propagation Settings +Ensure that column-level documentation propagation is enabled in your DataHub settings. This feature is enabled by default in Open Source DataHub. + +### Check Lineage Configuration +- **DataHub UI**: Navigate to the DataHub UI and locate the dataset. Go to the "Lineage" tab and enable the "Show Columns" option to visualize column-level lineage. +- **Lineage Configuration in Code**: Review your code to ensure that the `FineGrainedLineage` objects are correctly defined. + +### Review Ingestion Logs +- **Docker Logs**: Use `docker logs ` to check for errors or warnings. +- **Kubernetes Logs**: Use `kubectl logs ` to check logs of the DataHub pods. +- **CLI Debug Logs**: Use the `--debug` flag with the DataHub CLI to enable detailed logging. + +### Manual Verification +- **Inspect DBT Artifacts**: Check `manifest.json` and `catalog.json` files for correct descriptions. +- **DataHub UI**: Verify the schema details in the DataHub UI. +- **Manual Metadata Emission**: Use the DataHub Python SDK to manually emit metadata if necessary. + ## Add Lineage to Non-Dataset Entities You can also add lineage to non-dataset entities, such as DataJobs, Charts, and Dashboards. diff --git a/docs/automations/docs-propagation.md b/docs/automations/docs-propagation.md index e8eba08d3640e8..b50d8ca96fbac3 100644 --- a/docs/automations/docs-propagation.md +++ b/docs/automations/docs-propagation.md @@ -116,6 +116,24 @@ 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 + +### Verify Propagation Settings +Ensure that column-level documentation propagation is enabled. In Open Source DataHub, this feature is enabled by default. Navigate to the 'Settings' and 'Features' tab to confirm. + +### Check Lineage Configuration +- **DataHub UI**: Navigate to the dataset and check the 'Lineage' tab with 'Show Columns' enabled to verify column-level lineage. +- **Code Verification**: Ensure `FineGrainedLineage` objects are correctly defined in your code. + +### Review Ingestion Logs +- **Docker**: Use `docker logs ` to check for errors. +- **Kubernetes**: Use `kubectl logs ` for relevant pods like GMS or ingestion. +- **CLI**: Use `--debug` flag for detailed logs during ingestion. + +### Manual Verification +- **DataHub UI**: Check the schema details of the source dataset to ensure the description is set. +- **Python SDK**: Use the SDK to manually emit metadata if necessary. + ## 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: