Azure Blob Storage Sink Connector for Confluent Cloud

Note

If you are installing the connector locally for Confluent Platform, see Azure Blob Storage Sink Connector for Confluent Platform.

You can use the Azure Blob Storage connector to export data from Apache Kafka® topics to Azure Blob Storage objects in either Avro, JSON, or Bytes formats. Depending on your environment, the Azure Blob Storage connector can export data by guaranteeing exactly-once delivery semantics to consumers of the Azure Blob Storage objects it produces.

The Azure Blob Storage sink connector periodically polls data from Kafka and then uploads the data to Azure Blob Storage. A partitioner is used to split the data of every Kafka partition into chunks. Each chunk of data is represented as an Azure Blob Storage object. The key name encodes the topic, the Kafka partition, and the start offset of this data chunk.

If no partitioner is specified in the configuration, the default partitioner which preserves Kafka partitioning is used. The size of each data chunk is determined by the number of records written to Azure Blob Storage and by schema compatibility.

Features

The Confluent Cloud Azure Blob Storage sink connector provides the following features:

  • Exactly Once Delivery: Records that are exported using a deterministic partitioner are delivered with exactly-once semantics regardless of the eventual consistency of Azure Blob Storage.
  • Data Format with or without Schema: Out of the box, the connector supports writing data to Azure Blob Storage in JSON and Bytes. Schema validation is disabled for JSON.
  • Schema Evolution: schema.compatibility is set to NONE.
  • Partitioner: The connector supports the TimeBasedPartitioner class based on the Kafka class TimeStamp.
  • Flush size: flush.size defaults to 1000. For example, if you use the default setting of 1000 and your topic has six partitions, files start to be created in the storage bucket after more than 1000 records exist in each partition. Note that the default value of 1000 can be increased if needed.

Refer to Cloud connector limitations for additional information.

Important

Preview connectors are not currently supported and are not recommended for production use. For specific connector limitations, see Cloud connector limitations.

Quick Start

Use this quick start to get up and running with the Confluent Cloud Azure Blob Storage sink connector. The quick start provides the basics of selecting the connector and configuring it to stream events to Azure storage.

Prerequisites
  • Authorized access to a Confluent Cloud cluster on Microsoft Azure.
  • The Confluent Cloud CLI installed and configured for the cluster. See Install and Configure the Confluent Cloud CLI.
  • An Azure Blob Storage Container should be in the same region as your Confluent Cloud cluster. If you need to use a different region, please contact Confluent Support.
  • An Azure block blob storage account.
  • An Azure storage account access key.
  • Either one of the following to use for the Kafka cluster credentials fields:
    • A Confluent Cloud API key and secret. After you have created your cluster, go to Cluster settings > API access > Create Key.
    • A Confluent Cloud service account.

Step 1: Launch your Confluent Cloud cluster.

See the Confluent Cloud Quick Start for installation instructions.

Step 2: Add a connector.

Click Connectors > Add connector.

../../_images/ccloud-add-connector.png

Step 3: Select your connector.

Click the Azure Blob Storage Sink connector icon.

Step 4: Set up the connection.

Complete the following and click Continue.

Note

Make sure you have all your prerequisites completed.

  1. Select one or more topics.
  2. Enter a Connector Name.
  3. Enter your Kafka Cluster credentials. The credentials are either the API key and secret or the service account API key and secret.
  4. Select the message format.
  5. Add the storage account name, account key, and container name.
  6. Select the Time interval that sets how you want your messages grouped in the Azure container. For example, if you select Hourly, messages are grouped into folders for each hour data is streamed to the bucket.
  7. Enter the Flush size. This value defaults to 1000. For example, if you use the default setting of 1000 and your topic has six partitions, files start to be created in the storage bucket after more than 1000 records exist in each partition. Note that the default value of 1000 can be increased if needed.
  8. Enter the number of tasks in use by the connector. See Azure Blob Storage Sink Connector for additional task information.

Step 5: Launch the connector.

Verify the connection details and click Launch.

../../_images/ccloud-azure-blob-launch-connector.png

Step 6: Check the connector status.

The status for the connector should go from Provisioning to Running.

../../_images/ccloud-azure-blob-status.png

Step 7: Check the Azure storage container.

  1. From the Azure portal, go to the container in your Azure storage account.

  2. Open each folder until you see your messages displayed.

    ../../_images/ccloud-azure-blob-container-details.png

For additional information about this connector see Azure Blob Storage Sink Connector for Confluent Platform. Note that not all Confluent Platform connector features are provided in the Confluent Cloud connector.

Next Steps

Try out a Confluent Cloud demo. Use the Azure Blob Storage connector and an Azure container to store data.