How to crawl Microsoft Azure Event Hubs

Updated July 24, 2023 12:15

Once you have configured the Microsoft Azure Event Hubs permissions, you can establish a connection between Atlan and Microsoft Azure Event Hubs.

To crawl metadata from Microsoft Azure Event Hubs, complete the following steps.

Select the source

To select Microsoft Azure Event Hubs as your source:

In the top right of any screen in Atlan, navigate to +New and click New workflow.
From the Marketplace page, click Azure Event Hubs Assets.
In the right panel, click Setup Workflow.

To enter your Microsoft Azure Event Hubs credentials:

For Extraction method, Direct is the default selection.
For Bootstrap servers, enter the event hub namespace you copied from Microsoft Azure Event Hubs in the following format — <your event hub namespace>.servicebus.windows.net:9093.
For Connection string-primary key, enter the connection string-primary key you copied from Microsoft Azure Event Hubs.
For Security protocol, SSL is the default selection for connecting via a Secure Sockets Layer (SSL) channel.
Click the Test Authentication button to confirm connectivity to Microsoft Azure Event Hubs.
Once authentication is successful, navigate to the bottom of the screen and click Next.

To complete the Microsoft Azure Event Hubs connection configuration:

Provide a Connection Name that represents your source environment. For example, you might use values like production,development,gold, or analytics.
(Optional) To change the users who are able to manage this connection, change the users or groups listed under Connection Admins.
🚨 Careful! If you do not specify any user or group, no one will be able to manage the connection — not even admins.
Navigate to the bottom of the screen and click Next to proceed.

Before running the Microsoft Azure Event Hubs crawler, you can further configure it.

On the Metadata page, you can override the defaults for any of these options:

For Skip internal topics, keep the default option Yes to skip internal event hubs or click No to enable crawling them.
To select the assets you want to exclude from crawling, click Exclude topics regex. (This will default to no assets, if none specified.)
To select the assets you want to include in crawling, click Include topics regex. (This will default to all assets, if none are specified.)

💪 Did you know? If an asset appears in both the include and exclude filters, the exclude filter takes precedence.

To run the Microsoft Azure Event Hubs crawler, after completing the steps above:

To run the crawler once, immediately, at the bottom of the screen, click the Run button.
To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule & Run button.

Once the crawler has completed running, you will see the assets on Atlan's asset page! 🎉