View a connector

Viewing a connector's details lets you inspect its configuration, operational state, task restart policy, and monitor its performance metrics.

To view the details of a connector in a Connect cluster, you can use the Google Cloud console, the gcloud CLI, the Managed Service for Apache Kafka client library, or the Managed Kafka API. You can't use the open source Apache Kafka API to view the connectors.

Required roles and permissions to view a connector

To get the permissions that you need to view a connector, 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 view a connector. To see the exact permissions that are required, expand the Required permissionssection:

Required permissions

The following permissions are required to view a connector:

Grant the list connectors permission on the parent Connect cluster: managedkafka.connectors.list
Grant the get connector details permission on the parent Connect cluster: managedkafka.connectors.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 connector details

Console

In the Google Cloud console, go to the Connect Clusterspage.

Go to Connect Clusters
Click the Connect cluster that hosts the connector you want to view.

The Connect cluster detailspage is displayed.
On the Resourcestab, find the connector in the list and click its name. You are redirected to the Connector detailspage.
The Connector detailspage displays the following tabs:
- Configuration: Shows the connector's configuration, including:
  - Name: The name of the connector.
  - State: The operational state of the connector. For example, Running.
  - Task restart policy: The policy for restarting failed tasks. For example, whether to restart failed tasks or not, and with which backoff settings.
  - Configuration properties: A list of key-value pairs defining the connector's configuration.
- Monitoring: Provides graphs for monitoring the connector, such as:
  - Task error count: The number of tasks that have encountered errors.
  - Active task count: The number of tasks that are currently active.
This page also includes buttons to edit, delete, pause, stop, and restartthe connector.

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 managed-kafka connectors describe command to describe a connector:
```
 gcloud  
managed-kafka  
connectors  
describe  
 CONNECTOR_ID 
  
 \ 
  
--location = 
 LOCATION 
  
 \ 
  
--connect-cluster = 
 CONNECT_CLUSTER_ID 
 
```
Replace the following:
- CONNECTOR_ID : Required. The ID of the connector you want to describe.
- LOCATION : Required. The location of the Connect cluster containing the connector.
- CONNECT_CLUSTER_ID : Required. The ID of the Connect cluster containing the connector.

Example command:

 gcloud  
managed-kafka  
connectors  
describe  
test-connector  
 \ 
  
--location = 
us-central1  
 \ 
  
--connect-cluster = 
test-connect-cluster

Example output:

 config:
  connector.class: com.google.cloud.kafka.connect.pubsub.PubsubSinkConnector
  kafka.topic.regex: .*
  key.converter: org.apache.kafka.connect.storage.StringConverter
  project: test-project
  tasks.max: '1'
  topic: test-pubsub-topic
  value.converter: org.apache.kafka.connect.json.JsonConverter
  value.converter.schemas.enable: 'false'
createTime: '2024-03-13T05:17:34.123456Z'
labels:
  test-label-key: test-label-value
name: projects/test-project/locations/us-central1/connectClusters/test-connect-cluster/connectors/test-connector
state: RUNNING
taskRestartPolicy: RESTART_WITH_EXPONENTIAL_BACKOFF
updateTime: '2024-03-13T05:18:15.987654Z'

Go

Before trying this sample, follow the Go setup instructions in Install the client libraries . For more information, see the Managed Service for Apache Kafka Go API reference documentation .

To authenticate to Managed Service for Apache Kafka, set up Application Default Credentials(ADC). For more information, see Set up ADC for a local development environment .

  import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "cloud.google.com/go/managedkafka/apiv1/managedkafkapb" 
  
 "google.golang.org/api/option" 
  
 managedkafka 
  
 "cloud.google.com/go/managedkafka/apiv1" 
 ) 
 func 
  
 getConnector 
 ( 
 w 
  
 io 
 . 
 Writer 
 , 
  
 projectID 
 , 
  
 region 
 , 
  
 connectClusterID 
 , 
  
 connectorID 
  
 string 
 , 
  
 opts 
  
 ... 
 option 
 . 
 ClientOption 
 ) 
  
 error 
  
 { 
  
 // projectID := "my-project-id" 
  
 // region := "us-central1" 
  
 // connectClusterID := "my-connect-cluster" 
  
 // connectorID := "my-connector" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 managedkafka 
 . 
 NewManagedKafkaConnectClient 
 ( 
 ctx 
 , 
  
 opts 
 ... 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "managedkafka.NewManagedKafkaConnectClient got err: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 connectorPath 
  
 := 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/%s/locations/%s/connectClusters/%s/connectors/%s" 
 , 
  
 projectID 
 , 
  
 region 
 , 
  
 connectClusterID 
 , 
  
 connectorID 
 ) 
  
 req 
  
 := 
  
& managedkafkapb 
 . 
 GetConnectorRequest 
 { 
  
 Name 
 : 
  
 connectorPath 
 , 
  
 } 
  
 connector 
 , 
  
 err 
  
 := 
  
 client 
 . 
 GetConnector 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "client.GetConnector got err: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Got connector: %#v\n" 
 , 
  
 connector 
 ) 
  
 return 
  
 nil 
 }

Java

Before trying this sample, follow the Java setup instructions in Install the client libraries . For more information, see the Managed Service for Apache Kafka Java API reference documentation .

To authenticate to Managed Service for Apache Kafka, set up Application Default Credentials. For more information, see Set up ADC for a local development environment .

  import 
  
 com.google.api.gax.rpc. ApiException 
 
 ; 
 import 
  
 com.google.cloud.managedkafka.v1. Connector 
 
 ; 
 import 
  
 com.google.cloud.managedkafka.v1. ConnectorName 
 
 ; 
 import 
  
 com.google.cloud.managedkafka.v1. ManagedKafkaConnectClient 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 GetConnector 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // TODO(developer): Replace these variables before running the example. 
  
 String 
  
 projectId 
  
 = 
  
 "my-project-id" 
 ; 
  
 String 
  
 region 
  
 = 
  
 "my-region" 
 ; 
  
 // e.g. us-east1 
  
 String 
  
 clusterId 
  
 = 
  
 "my-connect-cluster" 
 ; 
  
 String 
  
 connectorId 
  
 = 
  
 "my-connector" 
 ; 
  
 getConnector 
 ( 
 projectId 
 , 
  
 region 
 , 
  
 clusterId 
 , 
  
 connectorId 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 getConnector 
 ( 
  
 String 
  
 projectId 
 , 
  
 String 
  
 region 
 , 
  
 String 
  
 clusterId 
 , 
  
 String 
  
 connectorId 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 try 
  
 ( 
  ManagedKafkaConnectClient 
 
  
 managedKafkaConnectClient 
  
 = 
  
  ManagedKafkaConnectClient 
 
 . 
 create 
 ()) 
  
 { 
  
  ConnectorName 
 
  
 name 
  
 = 
  
  ConnectorName 
 
 . 
 of 
 ( 
 projectId 
 , 
  
 region 
 , 
  
 clusterId 
 , 
  
 connectorId 
 ); 
  
 // This operation is handled synchronously. 
  
  Connector 
 
  
 connector 
  
 = 
  
 managedKafkaConnectClient 
 . 
 getConnector 
 ( 
 name 
 ); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 connector 
 . 
 getAllFields 
 ()); 
  
 } 
  
 catch 
  
 ( 
 IOException 
  
 | 
  
  ApiException 
 
  
 e 
 ) 
  
 { 
  
 System 
 . 
 err 
 . 
 printf 
 ( 
 "managedKafkaConnectClient.getConnector got err: %s\n" 
 , 
  
 e 
 . 
  getMessage 
 
 ()); 
  
 } 
  
 } 
 }

Python

Before trying this sample, follow the Python setup instructions in Install the client libraries . For more information, see the Managed Service for Apache Kafka Python API reference documentation .