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, Bytes or Parquet 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: The connector supports writing data to Azure Blob Storage in Avro, 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.

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

Using the Confluent Cloud GUI

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.

Add a connector

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.
  • An asterisk (*) designates a required entry.
  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 to use with the connector. See Azure Blob Storage Sink connector limits for additional task information.

Configuration properties that are not shown in the Confluent Cloud UI use the default values. See Azure Blob Storage Sink Configuration Properties for default values and property definitions.

Step 5: Launch the connector.

Verify the connection details and click Launch.

Verify the connection details

Step 6: Check the connector status.

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

Check the connector status

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.

    Check the storage container

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.

Using the Confluent Cloud CLI

Complete the following steps to set up and run the connector using the Confluent Cloud CLI.

Note

Make sure you have all your prerequisites completed.

Step 1: List the available connectors.

Enter the following command to list available connectors:

ccloud connector-catalog list

Step 2: Show the required connector configuration properties.

Enter the following command to show the required connector properties:

ccloud connector-catalog describe <connector-catalog-name>

For example:

ccloud connector-catalog describe AzureBlobSink

Example output:

Following are the required configs:
connector.class
name
kafka.api.key
kafka.api.secret
topics
data.format
azblob.account.name
azblob.account.key
azblob.container.name
time.interval
tasks.max

Configuration properties that are not listed use the default values. See Azure Blob Storage Sink Configuration Properties for default values and property definitions.

Step 3: Create the connector configuration file.

Create a JSON file that contains the connector configuration properties. The following example shows the required connector properties.

{
    "name" : "confluent-azure-blob-sink",
    "connector.class" : "AzureBlobSink",
    "kafka.api.key" : "<my-kafka-api-key>",
    "kafka.api.secret" : "<my-kafka-api-secret>",
    "topics" : "pageviews",
    "data.format" : "AVRO",
    "azblob.account.name" : "<storage-account-name>",
    "azblob.account.key" : "<storage-account-key>",
    "azblob.container.name" : "<container-name>",
    "time.interval" : "HOURLY",
    "tasks.max" : "1"
}

Note the following property definitions:

  • "name": Sets a name for your new connector.
  • "connector.class": Identifies the connector plugin name.
  • "topics": Identifies the topic name or a comma-separated list of topic names.
  • "data.format": Sets the message format. Valid entries are AVRO, JSON, or BYTES.
  • "time.interval": Sets how your messages grouped in storage. Valid entries are DAILY or HOURLY.

Step 4: Load the properties file and create the connector.

Enter the following command to load the configuration and start the connector:

ccloud connector create --config <file-name>.json

For example:

ccloud connector create --config azure-blob-sink-config.json

Example output:

Created connector confluent-azure-blob-sink jtt-ix4dl

Step 5: Check the connector status.

Enter the following command to check the connector status:

ccloud connector list

Example output:

ID          |       Name                | Status  | Type
+-----------+---------------------------+---------+------+
jtt-ix4dl   | confluent-azure-blob-sink | RUNNING | sink

Step 6: 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.

See also

For an example that shows fully-managed Confluent Cloud connectors in action with Confluent Cloud KSQL, see the Cloud ETL demo. The demo also shows how to use Confluent Cloud CLI to manage your resources in Confluent Cloud.