If you just want to use metadata ingestion, check the user-centric guide.
The architecture of this metadata ingestion framework is heavily inspired by Apache Gobblin (also originally a LinkedIn project!). We have a standardized format - the MetadataChangeEvent - and sources and sinks which respectively produce and consume these objects. The sources pull metadata from a variety of data systems, while the sinks are primarily for moving this metadata into DataHub.
- Python 3.6+ must be installed in your host environment.
- On MacOS:
brew install librdkafka
- On Debian/Ubuntu:
sudo apt install librdkafka-dev python3-dev python3-venv
- On Fedora (if using LDAP source integration):
sudo yum install openldap-devel
Common issues (click to expand):
datahub command not found with PyPI install
If you've already run the pip install, but running
datahub in your command line doesn't work, then there is likely an issue with your PATH setup and Python.
The easiest way to circumvent this is to install and run via Python, and use
python3 -m datahub in place of
Wheel issues e.g. "Failed building wheel for avro-python3" or "error: invalid command 'bdist_wheel'"
This means Python's
wheel is not installed. Try running the following commands and then retry.
Failure to install confluent_kafka: "error: command 'x86_64-linux-gnu-gcc' failed with exit status 1"
This sometimes happens if there's a version mismatch between the Kafka's C library and the Python wrapper library. Try running
pip install confluent_kafka==1.5.0 and then retrying.
The syntax for installing plugins is slightly different in development. For example:
- The CLI interface is defined in entrypoints.py.
- The high level interfaces are defined in the API directory.
- The actual sources and sinks have their own directories. The registry files in those directories import the implementations.
- The metadata models are created using code generation, and eventually live in the
./src/datahub/metadatadirectory. However, these files are not checked in and instead are generated at build time. See the codegen script for details.
- Tests live in the
testsdirectory. They're split between smaller unit tests and larger integration tests.
Also take a look at the guide to adding a source.