Elenca tutti i connettori

L'elenco di tutti i connettori in esecuzione in un cluster di connessione fornisce una panoramica delle integrazioni di dati configurate. Puoi monitorare lo stato e l'integrità dei tuoi connettori, identificare potenziali problemi e gestire i flussi di dati in modo efficace.

Per elencare tutti i connettori in un cluster Connect, puoi utilizzare la console Google Cloud , gcloud CLI, la libreria client Managed Service per Apache Kafka o l'API Managed Kafka. Non puoi utilizzare l'API Apache Kafka open source per elencare i connettori.

Ruoli e autorizzazioni richiesti per elencare tutti i connettori

Per ottenere le autorizzazioni necessarie per elencare tutti i connettori, chiedi all'amministratore di concederti il ruolo IAM Managed Kafka Viewer (roles/managedkafka.viewer) nel progetto. Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Questo ruolo predefinito contiene le autorizzazioni necessarie per elencare tutti i connettori. Per vedere quali sono esattamente le autorizzazioni richieste, espandi la sezione Autorizzazioni obbligatorie:

Autorizzazioni obbligatorie

Per elencare tutti i connettori sono necessarie le seguenti autorizzazioni:

Concedi l'autorizzazione per elencare i connettori nel cluster di connessione principale: managedkafka.connectors.list
Concedi l'autorizzazione per ottenere i dettagli del connettore sul cluster Connect padre: managedkafka.connectors.get

Potresti anche ottenere queste autorizzazioni con ruoli personalizzati o altri ruoli predefiniti.

Per maggiori informazioni sul ruolo Visualizzatore Kafka gestito, consulta Ruoli predefiniti di Managed Service per Apache Kafka.

Visualizza tutti i connettori

Questa visualizzazione offre un modo rapido per monitorare lo stato dei connettori e identificare quelli che richiedono attenzione. Puoi quindi visualizzare in dettaglio i singoli connettori per visualizzarne i dettagli e le configurazioni, se necessario.

Console

Nella console Google Cloud , vai alla pagina Connetti cluster.

Vai a Connetti cluster
Fai clic sul cluster di connessione per cui vuoi elencare i connettori.

Viene visualizzata la pagina Dettagli cluster di connessione.
La scheda Risorse mostra un elenco di tutti i connettori in esecuzione nel cluster. L'elenco include le seguenti informazioni per ogni connettore:
- Nome: il nome del connettore.
- Stato: lo stato operativo del connettore. Ad esempio, Running, Failed.
- Tipo di connettore: il tipo di plug-in del connettore.
Puoi utilizzare l'opzione Filtra per cercare connettori specifici in base al nome.

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.

Utilizza il comando gcloud managed-kafka connectors list per elencare i connettori:

gcloud managed-kafka connectors list CONNECT_CLUSTER_ID \
    --location=LOCATION

Per perfezionare ulteriormente l'elenco dei connettori, puoi utilizzare flag aggiuntivi:
```
gcloud managed-kafka connectors list CONNECT_CLUSTER_ID \
    --location=LOCATION \
    [--filter=EXPRESSION] \
    [--limit=LIMIT] \
    [--page-size=PAGE_SIZE] \
    [--sort-by=SORT_BY]
```
Sostituisci quanto segue:
- CONNECT_CLUSTER_ID: obbligatorio. L'ID del cluster di connessione contenente i connettori che vuoi elencare.
- LOCATION: obbligatorio. La posizione del cluster di connessione contenente i connettori che vuoi elencare.
- EXPRESSION: (facoltativo) un'espressione di filtro booleano da applicare all'elenco. Se l'espressione restituisce True, l'elemento viene incluso nell'elenco. Per maggiori dettagli ed esempi, esegui gcloud topic filters.
  
  Esempi:
  - Per elencare solo i connettori in stato "IN ESECUZIONE":
```
--filter="state=RUNNING"
```
  - Per elencare solo i connettori "Sink Pub/Sub":
```
--filter="connector_plugin='Pub/Sub Sink'"
```
  - Per elencare i connettori con un nome contenente "prod":
```
--filter="name ~ 'prod'"
```
  - Per elencare i connettori con stato "FAILED" o i plug-in "Pub/Sub Source":
```
--filter="state=FAILED OR connector_plugin='Pub/Sub Source'"
```
- LIMIT: (facoltativo) il numero massimo di connettori da visualizzare. Se non specificato, vengono elencati tutti i connettori.
- PAGE_SIZE: (facoltativo) il numero di risultati da mostrare per pagina. Se non specificato, il servizio determina una dimensione della pagina adatta.
- SORT_BY: (facoltativo) un elenco separato da virgole di campi in base a cui eseguire l'ordinamento. L'ordine di ordinamento predefinito è crescente. Per ordinare in ordine decrescente, anteponi ~ al campo. I campi supportati sono probabilmente name e state.

Esempio di comando con ordinamento:

gcloud managed-kafka connectors list test-connect-cluster \
    --location=us-central1 \
    --sort-by=~state,name

Esempio di comando con filtri e limiti:

gcloud managed-kafka connectors list test-connect-cluster \
    --location=us-central1 \
    --filter="state=RUNNING AND connector_plugin='Pub/Sub Sink'" \
    --limit=5

Output di esempio:

NAME                                    STATE     CONNECTOR_PLUGIN
pubsub-sink-connector                   RUNNING   Pub/Sub Sink
another-pubsub-sink                     RUNNING   Pub/Sub Sink
prod-pubsub-sink                        RUNNING   Pub/Sub Sink

Go

Prima di provare questo esempio, segui le istruzioni di configurazione di Go in Installare le librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Go di Managed Service per Apache Kafka.

Per eseguire l'autenticazione in Managed Service per Apache Kafka, configura le Credenziali predefinite dell'applicazione(ADC). Per saperne di più, vedi Configura ADC per un ambiente di sviluppo locale.

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/managedkafka/apiv1/managedkafkapb"
	"google.golang.org/api/iterator"
	"google.golang.org/api/option"

	managedkafka "cloud.google.com/go/managedkafka/apiv1"
)

func listConnectors(w io.Writer, projectID, region, connectClusterID string, opts ...option.ClientOption) error {
	// projectID := "my-project-id"
	// region := "us-central1"
	// connectClusterID := "my-connect-cluster"
	ctx := context.Background()
	client, err := managedkafka.NewManagedKafkaConnectClient(ctx, opts...)
	if err != nil {
		return fmt.Errorf("managedkafka.NewManagedKafkaConnectClient got err: %w", err)
	}
	defer client.Close()

	parent := fmt.Sprintf("projects/%s/locations/%s/connectClusters/%s", projectID, region, connectClusterID)
	req := &managedkafkapb.ListConnectorsRequest{
		Parent: parent,
	}
	connectorIter := client.ListConnectors(ctx, req)
	for {
		connector, err := connectorIter.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return fmt.Errorf("connectorIter.Next() got err: %w", err)
		}
		fmt.Fprintf(w, "Got connector: %v", connector)
	}
	return nil
}

Java

Prima di provare questo esempio, segui le istruzioni di configurazione di Java in Installare le librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Java di Managed Service per Apache Kafka.

Per eseguire l'autenticazione in Managed Service per Apache Kafka, configura le Credenziali predefinite dell'applicazione. Per saperne di più, vedi Configura ADC per un ambiente di sviluppo locale.

import com.google.api.gax.rpc.ApiException;
import com.google.cloud.managedkafka.v1.ConnectClusterName;
import com.google.cloud.managedkafka.v1.Connector;
import com.google.cloud.managedkafka.v1.ManagedKafkaConnectClient;
import java.io.IOException;

public class ListConnectors {

  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";
    listConnectors(projectId, region, clusterId);
  }

  public static void listConnectors(String projectId, String region, String clusterId)
      throws IOException {
    try (ManagedKafkaConnectClient managedKafkaConnectClient = ManagedKafkaConnectClient.create()) {
      ConnectClusterName parent = ConnectClusterName.of(projectId, region, clusterId);
      // This operation is handled synchronously.
      for (Connector connector : managedKafkaConnectClient.listConnectors(parent).iterateAll()) {
        System.out.println(connector.getAllFields());
      }
    } catch (IOException | ApiException e) {
      System.err.printf("managedKafkaConnectClient.listConnectors got err: %s\n", e.getMessage());
    }
  }
}

Python

Prima di provare questo esempio, segui le istruzioni di configurazione di Python in Installare le librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API Python di Managed Service per Apache Kafka.