View a Connect cluster
Stay organized with collections Save and categorize content based on your preferences.

You can view the details of a Connect cluster to learn more about its configuration details, including the name of the primary Google Cloud Managed Service for Apache Kafka cluster, the Connect cluster's state, resource allocation, network settings, and the connectors hosted by the Connect cluster.

To view your Connect clusters, you can use the Google Cloud console, the gcloud CLI, the client library, or the Managed Kafka API. You can't use the open source Apache Kafka API to list Connect clusters.

Required roles and permissions to view a Connect cluster

To get the permissions that you need to list your Connect clusters, ask your administrator to grant you the Managed Kafka Viewer(roles/managedkafka.viewer) IAM role on your project. For more information about granting roles, see Manage access to projects, folders, and organizations.

This predefined role contains the permissions required to list your Connect clusters. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to list your Connect clusters:

Grant the list clusters permission on the specified location: managedkafka.connectClusters.list
Grant the get cluster details permission on the specified location: managedkafka.connectClusters.get

You might also be able to get these permissions with custom roles or other predefined roles.

For more information about the Managed Kafka Viewer role, see Managed Service for Apache Kafka predefined roles.

View a Connect cluster details

Console

In the Google Cloud console, go to the Connect clusters page.

Go to Connect clusters
Click on the Connect cluster that you want to view.
The Connect cluster page is displayed with four tabs:
- Resources: Provides a focused view of the connectors running on your cluster, including their operational status and type.
- Configurations: Displays the Connect cluster's essential properties and settings, such as the primary Kafka cluster, state, resource allocation, and network settings.
- Logs: Provides a real-time stream of log entries from your Connect cluster for monitoring and troubleshooting.
- Monitoring: Provides metrics to help you monitor the performance and resource utilization of your Connect cluster.

gcloud

In the Google Cloud console, activate Cloud Shell.

Activate Cloud Shell

At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

Use the gcloud alpha managed-kafka connect-clusters describe command to view details of a Connect cluster:

gcloud alpha managed-kafka connect-clusters describe CONNECT_CLUSTER \
    --location=LOCATION

Replace the following:
- CONNECT_CLUSTER: The ID of the Connect cluster you want to view.
- LOCATION: The location of the Connect cluster.
For example, to view details of a Connect cluster named my-connect-cluster in the us-central1 location, you would run:
```
gcloud alpha managed-kafka connect-clusters describe my-connect-cluster \
    --location=us-central1
```

Example output:

capacityConfig:
  memoryBytes: '3221225472'
  vcpuCount: '3'
createTime: '2025-03-05T15:19:17.998009888Z'
gcpConfig:
  accessConfig:
  networkConfigs:
  - primarySubnet: projects/sample-project/regions/us-central1/subnetworks/default
kafkaCluster: projects/sample-project/locations/us-central1/clusters/kafka-test
name: projects/sample-project/locations/us-central1/connectClusters/my-connect-cluster
state: ACTIVE
updateTime: '2025-03-05T15:24:40.861655595Z'

Connect cluster details overview

The Connect cluster page is displayed with four tabs called Resources, Configurations, Monitoring, and Logs.

Resources

The Resources tab on the Connect cluster page summarizes the types of connectors deployed and their operational status. The following information is displayed:

Connectors table: A table listing all connectors on the Connect cluster.
- Name: The assigned name of each connector.
- State: The current operational state of the connector.
- Connector type: Indicates the type of connector, such as MirrorMaker 2.0 Source, BigQuery Sink, Cloud Storage Sink, or Pub/Sub Sink.
Filter: A search bar that you can use to filter connectors by their properties.

To monitor connector health, use the Resources tab.

Configurations

The Configurations tab displays information about the cluster's state, resource allocation, network settings, and DNS configuration.

Primary Kafka cluster: Displays the name of the Managed Service for Apache Kafka cluster associated with this Connect cluster. The Connect cluster stores its configurations and offsets in the Managed Service for Apache Kafka cluster.
State: Shows the current state of the Connect cluster. Possible states include Active, Creating, Deleting, and State_unspecified.
Region: Indicates the Connect cluster's region.
vCPUs: Shows the number of virtual CPUs allocated to the Connect cluster. A higher vCPU count increases cluster processing capacity.
Memory: Shows the Connect cluster's total provisioned memory.
Labels: Shows the labels attached to the Connect cluster.
Secret resources: Lists the secrets associated with the Connect cluster.
Subnetworks: Lists the subnetworks associated with the Connect cluster. The table includes columns for Name, Region, and Project.
DNS names: Displays any custom DNS names configured for the Connect cluster. If no custom DNS names are configured, the table is empty.

Monitoring

The Monitoring tab provides metrics that help you understand the performance and resource utilization of your connectors. Metrics include:

Worker CPU usage: Total CPU usage, in vCPU seconds, for each worker. This metric helps identify resource constraints.
Worker memory usage: Current memory usage, in bytes, for each worker. This metric helps prevent out-of-memory errors.
Connector incoming byte rate: Average incoming byte rate per second, from client connections, for each connector. This metric helps assess data ingestion rates.
Connector outgoing byte rate: Average outgoing byte rate per second, to servers, from client connections, for each connector. This metric helps monitor data delivery rates.

Logs

The Logs tab provides a real-time stream of log entries from your Connect cluster. Use this tab to monitor connector health, activity, and troubleshoot issues. These features help you effectively monitor and debug your Connect cluster:

Filter by Severity: Filter log entries by severity level to quickly pinpoint critical issues.
Search: Search log entries for specific keywords or phrases to find events related to a particular connector or task.
Timestamps: Timestamps on each log entry help track event sequences and identify when actions occurred.
Summary: Log entries provide details about various events, such as connector startup and shutdown, task execution, and data processing.

What's next?

Apache Kafka® is a registered trademark of The Apache Software Foundation or its affiliates in the United States and/or other countries.