Stay organized with collectionsSave and categorize content based on your preferences.
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
This predefined role contains
the permissions required to view a connector. To see the exact permissions that are
required, expand theRequired 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
At the bottom of the Google Cloud console, aCloud Shellsession 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# View a connector\n\n| **Preview**\n|\n|\n| This product or feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products and features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nViewing a connector's details lets you inspect its configuration,\noperational state, task restart policy, and monitor its performance metrics.\n\nTo view the details of a connector in a Connect cluster, you can use the Google Cloud console,\nthe gcloud CLI, the Managed Service for Apache Kafka\nclient library, or the Managed Kafka API. You can't use the open\nsource Apache Kafka API to view the connectors.\n\nRequired roles and permissions to view a connector\n--------------------------------------------------\n\n\nTo get the permissions that\nyou need to view a connector,\n\nask your administrator to grant you the\n\n\n[Managed Kafka Viewer](/iam/docs/roles-permissions/managedkafka#managedkafka.viewer) (`roles/managedkafka.viewer`)\nIAM role on your project.\n\n\nFor more information about granting roles, see [Manage access to projects, folders, and organizations](/iam/docs/granting-changing-revoking-access).\n\n\nThis predefined role contains\n\nthe permissions required to view a connector. To see the exact permissions that are\nrequired, expand the **Required permissions** section:\n\n\n#### Required permissions\n\nThe following permissions are required to view a connector:\n\n- Grant the list connectors permission on the parent Connect cluster: ` ``managedkafka.connectors.list`\n- Grant the get connector details permission on the parent Connect cluster: ` ``managedkafka.connectors.get`\n\n\nYou might also be able to get\nthese permissions\nwith [custom roles](/iam/docs/creating-custom-roles) or\nother [predefined roles](/iam/docs/roles-overview#predefined).\n\nFor more information about the **Managed Kafka Viewer role** , see\n[Managed Service for Apache Kafka predefined roles](/managed-service-for-apache-kafka/docs/access-control#predefined-roles).\n\nView connector details\n----------------------\n\n### Console\n\n1. In the Google Cloud console, go to the **Connect clusters** page.\n\n [Go to Connect clusters](https://console.cloud.google.com/managedkafka/connectClusters)\n2. Click the Connect cluster that hosts the connector you want to view.\n\n The **Connect cluster details** page is displayed.\n3. On the **Resources** tab, find the connector in the list and click its\n name. You are redirected to the **Connector details** page.\n\n4. The **Connector details** page displays the following tabs:\n\n - **Configuration**: Shows the connector's configuration, including:\n\n - **Name**: The name of the connector.\n - **State**: The operational state of the connector. For example, Running.\n - **Task restart policy**: The policy for restarting failed tasks. For example, whether to restart failed tasks or not, and with which backoff settings.\n - **Configuration properties**: A list of key-value pairs defining the connector's configuration.\n - **Monitoring**: Provides graphs for monitoring the connector, such as:\n\n - **Task error count**: The number of tasks that have encountered errors.\n - **Active task count**: The number of tasks that are currently active.\n\nThis page also includes buttons to **edit** , **delete** , **pause** ,\n**stop** , and **restart** the connector.\n\n### gcloud\n\n1. In the Google Cloud console, activate Cloud Shell.\n\n [Activate Cloud Shell](https://console.cloud.google.com/?cloudshell=true)\n\n\n At the bottom of the Google Cloud console, a\n [Cloud Shell](/shell/docs/how-cloud-shell-works)\n session starts and displays a command-line prompt. Cloud Shell is a shell environment\n with the Google Cloud CLI\n already installed and with values already set for\n your current project. It can take a few seconds for the session to initialize.\n2. Use the [`gcloud alpha managed-kafka connectors describe`](/sdk/gcloud/reference/alpha/managed-kafka/connectors/describe) command to describe a connector:\n\n \u003cbr /\u003e\n\n ```bash\n gcloud alpha managed-kafka connectors describe CONNECTOR_ID \\\n --location=LOCATION \\\n --connect_cluster=CONNECT_CLUSTER_ID\n ```\n\n Replace the following:\n - \u003cvar translate=\"no\"\u003eCONNECTOR_ID\u003c/var\u003e: Required. The ID of the connector you want to describe.\n\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: Required. The location of the Connect cluster containing the connector.\n\n - \u003cvar translate=\"no\"\u003eCONNECT_CLUSTER_ID\u003c/var\u003e: Required. The ID of the Connect cluster containing the connector.\n\n \u003cbr /\u003e\n\nExample command:\n\n\u003cbr /\u003e\n\n```bash\ngcloud alpha managed-kafka connectors describe test-connector \\\n --location=us-central1 \\\n --connect_cluster=test-connect-cluster\n```\n\nExample output: \n\n```\nconfig:\n connector.class: com.google.cloud.kafka.connect.pubsub.PubsubSinkConnector\n kafka.topic.regex: .*\n key.converter: org.apache.kafka.connect.storage.StringConverter\n project: test-project\n tasks.max: '1'\n topic: test-pubsub-topic\n value.converter: org.apache.kafka.connect.json.JsonConverter\n value.converter.schemas.enable: 'false'\ncreateTime: '2024-03-13T05:17:34.123456Z'\nlabels:\n test-label-key: test-label-value\nname: projects/test-project/locations/us-central1/connectClusters/test-connect-cluster/connectors/test-connector\nstate: RUNNING\ntaskRestartPolicy: RESTART_WITH_EXPONENTIAL_BACKOFF\nupdateTime: '2024-03-13T05:18:15.987654Z'\n```\n\n\u003cbr /\u003e\n\n*Apache Kafka® is a registered\ntrademark of The Apache Software Foundation or its affiliates in the United\nStates and/or other countries.*"]]
