6.8 KiB
| title | slug |
|---|---|
| Kafka | /connectors/messaging/kafka |
Kafka
In this section, we provide guides and references to use the Kafka connector.
Configure and schedule Kafka metadata and profiler workflows from the OpenMetadata UI:
If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to connect using Airflow SDK or with the CLI.
Requirements
To deploy OpenMetadata, check the Deployment guides.To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.
Metadata Ingestion
1. Visit the Services Page
The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.
To visit the Services page, select Services from the Settings menu.
2. Create a New Service
Click on the Add New Service button to start the Service creation.
3. Select the Service Type
Select Kafka as the service type and click Next.
4. Name and Describe your Service
Provide a name and description for your service as illustrated below.
Service Name
OpenMetadata uniquely identifies services by their Service Name. Provide a name that distinguishes your deployment from other services, including the other {connector} services that you might be ingesting metadata from.
5. Configure the Service Connection
In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your kafka service as desired.
Once the credentials have been added, click on Test Connection and Save
the changes.
Connection Options
- Bootstrap Servers: Kafka bootstrap servers. Add them in comma separated values ex: host1:9092,host2:9092.
- Schema Registry URL: Confluent Kafka Schema Registry URL. URI format.
- Consumer Config: Confluent Kafka Consumer Config.
- Schema Registry Config:Confluent Kafka Schema Registry Config.
To ingest the topic schema Schema Registry URL must be passed
6. Configure Metadata Ingestion
In this step we will configure the metadata ingestion pipeline, Please follow the instructions below
Metadata Ingestion Options
- Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
- Topic Filter Pattern (Optional): Use to pipeline filter patterns to control whether or not to include topics as part of metadata ingestion.
- Include: Explicitly include topics by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all topics with names matching one or more of the supplied regular expressions. All other topics will be excluded.
- Exclude: Explicitly exclude topics by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all topics with names matching one or more of the supplied regular expressions. All other topics will be included.
- Ingest Sample Data (toggle): To ingest sample data from the topics.
- Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug, these logs can be viewed later in Airflow.
7. Schedule the Ingestion and Deploy
Scheduling can be set up at an hourly, daily, or weekly cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.
Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.
If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.
After configuring the workflow, you can click on Deploy to create the pipeline.
8. View the Ingestion Pipeline
Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.
9. Workflow Deployment Error
If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.
You can then edit the Ingestion Pipeline and Deploy it again.
From the Connection tab, you can also Edit the Service if needed.