> For the complete documentation index, see [llms.txt](https://docs.lenses.io/latest/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lenses.io/latest/user-guide/using/integrating-data-with-kafka-connect.md).

# Integrating data with Kafka Connect

{% hint style="success" %}
For the available Lenses Apache 2.0 connectors, see the [Stream Reactor documentation](https://docs.lenses.io/kafka-connectors).
{% endhint %}

Lenses connects to Kafka Connect clusters through the Kafka Connect REST API. You can deploy connectors outside Lenses and still use Lenses to inspect and manage them.

Add one or more Kafka Connect clusters to the agent [provisioning file](https://docs.lenses.io/latest/deployment/configuration/agent/automation). Once connected, Lenses discovers the installed connector plugins on each cluster.

To update the provisioning file, open **Environments** from the left navigation, expand the target environment, then open **Configuration**. From there you can edit, test, and apply the configuration through the connected agent.

## Create a Kafka Connector

Open **Apps** from the left navigation. Then open **Kafka Connectors** and select **Create Kafka Connector**. You can also create one from the Kafka Connectors node in the navigation tree.

{% stepper %}
{% step %}

### Add metadata and select the cluster

Enter the connector name, select the environment, then select the Kafka Connect cluster. The editor then becomes active and starts offering auto-complete for the available connector plugins.
{% endstep %}

{% step %}

### Select the Connector

Choose the connector plugin. For sink connectors, the editor then moves to the topics field and offers auto-complete for available topics in the cluster.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Use `Ctrl` + `Space` or `Cmd` + `Space` to open more detail in the editor auto-complete menu.
{% endhint %}

<figure><img src="/files/wq6315AjdfLJuASoBr3A" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
In the editors, use `Ctrl` + `Space` or `Cmd` + `Space` for auto-complete and default snippets.

<img src="/files/aP25fTrx63d0nBTv8VYB" alt="" data-size="original">
{% endhint %}

### Task Max

Enable task max to let the editor calculate `tasks.max` from the selected topic partition counts.

### Initial State at Creation

Set the connector's initial state with the stop, pause, and play icons.

<figure><img src="/files/wbvJrUtK4ZRfYgXRDylD" alt=""><figcaption></figcaption></figure>

### Validation & Deployment

Use **Validate** to test the configuration against the Kafka Connect cluster. Validation errors appear in the editor and problem panel.

Use **Deploy** to create the connector on the Kafka Connect cluster.

{% hint style="info" %}
The connector is deployed with the selected initial state. By default, that state is **stopped**.
{% endhint %}

## View and manage connectors

Open **Apps** from the left navigation, then open **Kafka Connectors**. You can also expand a target environment and open its connector nodes there.

Select a connector from the list or from the navigation tree to open its details.

Each connector has these sections. You can open them from breadcrumbs, from the navigation tree, or from context menus.

1. **Profile** — view metadata, summary metrics, and the topics involved. Topic entries include context actions for deeper inspection.
2. **Configuration** — update the connector configuration. You cannot change the connector plugin type after creation.
3. **Health** — inspect task health, metrics, and stack traces.
4. **Alerts** — view alert events and manage alert rules. See [Alerting & Monitoring](/latest/user-guide/using/alerting-and-monitoring.md).
5. **Activity** — inspect the audit trail for the connector. See [Governance](/latest/user-guide/using/governance.md).

{% columns %}
{% column %}

<figure><img src="/files/M8yoYQM52l6P1vDda41H" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><img src="/files/UJxgJepJDIgFNWsRzPPm" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

### Start, stop, restart, or delete connectors and tasks

Use the connector tab context menu or the connector node in the navigation tree to manage the connector and its tasks.

Common actions include:

1. start a stopped connector
2. pause or stop a running connector
3. restart a connector or an individual task
4. delete a connector

{% hint style="warning" %}
Stopping, restarting, or deleting a connector interrupts active ingestion or delivery. Confirm the target connector and cluster before you proceed.
{% endhint %}

## Related pages

Use these pages next:

1. [Sources](/latest/user-guide/using/integrating-data-with-kafka-connect/sources.md) — available source connectors
2. [Sinks](/latest/user-guide/using/integrating-data-with-kafka-connect/sinks.md) — available sink connectors
3. [Secret Providers](/latest/user-guide/using/integrating-data-with-kafka-connect/secret-providers.md) — manage connector secrets securely

{% columns %}
{% column %}

<figure><img src="/files/sElcXBqgxv0rTH0eZGO4" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}

<figure><img src="/files/Gm2pPYGBXB4q7jFEaGxw" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.lenses.io/latest/user-guide/using/integrating-data-with-kafka-connect.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
