Visualizzare un cluster Google Cloud Managed Service per Apache Kafka

Per visualizzare un cluster, puoi utilizzare la console Google Cloud , Google Cloud CLI, la libreria client o l'API Managed Kafka. Non puoi utilizzare l'API Apache Kafka open source per visualizzare un cluster.

Ruoli e autorizzazioni richiesti per visualizzare un cluster

Per ottenere le autorizzazioni necessarie per visualizzare un cluster, chiedi all'amministratore di concederti il ruolo IAM Visualizzatore Kafka gestito (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 visualizzare un cluster. Per vedere quali sono esattamente le autorizzazioni richieste, espandi la sezione Autorizzazioni obbligatorie:

Autorizzazioni obbligatorie

Per visualizzare un cluster sono necessarie le seguenti autorizzazioni:

• Elenco dei cluster: managedkafka.clusters.list
• Recupera i dettagli del cluster: managedkafka.clusters.get

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

Per saperne di più sul ruolo Visualizzatore Kafka gestito, consulta Ruoli predefiniti di Managed Service per Apache Kafka.

Visualizzare un cluster

Per visualizzare un cluster:

Console

1. Nella console Google Cloud , vai alla pagina Cluster.

   Vai a Cluster

   Viene visualizzato l'elenco dei cluster che hai creato in un progetto.

2. Per visualizzare un cluster specifico, fai clic sul nome del cluster.

3. Viene visualizzata la pagina dei dettagli del cluster. Questa pagina contiene le seguenti schede:

   • Risorse: mostra l'elenco di argomenti e gruppi di consumatori associati al cluster.
   • Configurazioni: mostra la configurazione del cluster, incluso l'elenco delle subnet associate al cluster.
   • Monitoraggio: mostra gli avvisi di monitoraggio associati al cluster.
   • Log: mostra i log relativi ai cluster di Esplora log.

gcloud

1. 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.

2. Esegui il comando gcloud managed-kafka clusters describe:

   gcloud managed-kafka clusters describe CLUSTER_ID \
       --location=LOCATION \
       --full
   

   Sostituisci quanto segue:

   • CLUSTER_ID: l'ID o il nome del cluster.
   • LOCATION: la posizione del cluster.

   Il flag --full è facoltativo. Se includi questo flag, il comando restituisce informazioni aggiuntive, incluse quelle sui broker del cluster e sul numero di versione di Kafka in esecuzione nel cluster.

REST

Prima di utilizzare i dati della richiesta, apporta le sostituzioni seguenti:

• PROJECT_ID: il tuo Google Cloud ID progetto
• LOCATION: la posizione del cluster
• CLUSTER_ID: l'ID del cluster

• CLUSTER_VIEW: la quantità di metadati da restituire. Specifica uno dei seguenti valori:

  • CLUSTER_VIEW_BASIC: Restituisce i metadati di base per il cluster.
  • CLUSTER_VIEW_FULL: restituisce tutti i metadati del cluster, incluse le informazioni sui broker del cluster e il numero di versione di Kafka in esecuzione sul cluster.

  Se non specificato, il metodo predefinito è CLUSTER_VIEW_BASIC.

Metodo HTTP e URL:

GET https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID?view=CLUSTER_VIEW

Per inviare la richiesta, espandi una di queste opzioni:

curl (Linux, macOS o Cloud Shell)

Nota: il seguente comando presuppone che tu abbia eseguito l'accesso all'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login oppure utilizzando Cloud Shell, che consente di accedere automaticamente all'interfaccia a riga di comando gcloud. Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Esegui questo comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID?view=CLUSTER_VIEW"

PowerShell (Windows)

Nota: il comando seguente presuppone che tu abbia eseguito l'accesso all'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login . Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Esegui questo comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID?view=CLUSTER_VIEW" | Select-Object -Expand Content

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID",
  "createTime": "CREATE_TIME",
  "updateTime": "UPDATE_TIME",
  "capacityConfig": {
    "vcpuCount": "CPU_COUNT",
    "memoryBytes": "MEMORY"
  },
  "rebalanceConfig": {},
  "gcpConfig": {
    "accessConfig": {
      "networkConfigs": [
        {
          "subnet": "projects/PROJECT_ID/locations/LOCATION/subnetworks/SUBNET_ID"
        }
      ]
    }
  },
  "state": "ACTIVE",
  "satisfiesPzi": false,
  "satisfiesPzs": false,
  "tlsConfig": {
    "trustConfig": {}
  },
  "updateOptions": {}
}

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/option"

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

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

	clusterPath := fmt.Sprintf("projects/%s/locations/%s/clusters/%s", projectID, region, clusterID)
	req := &managedkafkapb.GetClusterRequest{
		Name: clusterPath,
	}
	cluster, err := client.GetCluster(ctx, req)
	if err != nil {
		return fmt.Errorf("client.GetCluster got err: %w", err)
	}
	fmt.Fprintf(w, "Got cluster: %#v\n", cluster)
	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.Cluster;
import com.google.cloud.managedkafka.v1.ClusterName;
import com.google.cloud.managedkafka.v1.ManagedKafkaClient;
import java.io.IOException;

public class GetCluster {

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

  public static void getCluster(String projectId, String region, String clusterId)
      throws Exception {
    try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
      // This operation is being handled synchronously.
      Cluster cluster = managedKafkaClient.getCluster(ClusterName.of(projectId, region, clusterId));
      System.out.println(cluster.getAllFields());
    } catch (IOException | ApiException e) {
      System.err.printf("managedKafkaClient.getCluster got err: %s", 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.

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.

from google.api_core.exceptions import NotFound
from google.cloud import managedkafka_v1

# TODO(developer)
# project_id = "my-project-id"
# region = "us-central1"
# cluster_id = "my-cluster"

client = managedkafka_v1.ManagedKafkaClient()

cluster_path = client.cluster_path(project_id, region, cluster_id)
request = managedkafka_v1.GetClusterRequest(
    name=cluster_path,
)

try:
    cluster = client.get_cluster(request=request)
    print("Got cluster:", cluster)
except NotFound as e:
    print(f"Failed to get cluster {cluster_id} with error: {e.message}")

Visualizzare le proprietà e le risorse del cluster

Le seguenti sezioni descrivono come ottenere dettagli su varie proprietà e risorse associate a un cluster Managed Service per Apache Kafka.

Indirizzo di bootstrap

I client Kafka utilizzano l'indirizzo di bootstrap del cluster per stabilire una connessione con il cluster. Per ottenere l'indirizzo di bootstrap, segui questi passaggi:

Console

1. Vai alla pagina Managed Service per Apache Kafka > Cluster.

   Vai a Cluster

2. Fai clic sul nome del cluster.

3. Seleziona la scheda Configurazioni.

4. Se utilizzi SASL per l'autenticazione, l'URL di bootstrap è elencato nella sezione URL di bootstrap mTLS.

   Se utilizzi mutual TLS (mTLS) per l'autenticazione, l'URL di bootstrap è elencato in URL di bootstrap mTLS.

   Fai clic su Copia per copiare il valore.

gcloud

Per ottenere l'URL di bootstrap, utilizza il comando managed-kafka clusters describe.

Se utilizzi SASL per l'autenticazione, esegui questo comando:

gcloud managed-kafka clusters describe CLUSTER_ID \
  --location=LOCATION \
  --format="value(bootstrapAddress)"

Se utilizzi mutual TLS (mTLS) per l'autenticazione, esegui questo comando:

gcloud managed-kafka clusters describe CLUSTER_ID \
  --location=LOCATION \
  --format="value(bootstrapAddressMTLS)"

Sostituisci quanto segue:

• CLUSTER_ID: l'ID o il nome del cluster.
• LOCATION: la posizione del cluster.

Per saperne di più sull'autenticazione SASL e mTLS, consulta Tipi di autenticazione per i broker Kafka.

Intermediari

Managed Service per Apache Kafka esegue automaticamente il provisioning dei broker per un cluster. Un broker ha le seguenti proprietà:

• brokerIndex: l'indice in base zero del broker.
• nodeId: l'ID nodo del broker.
• rack: la zona in cui viene eseguito il provisioning del broker, ad esempio us-central1-a.

Per visualizzare i broker per un cluster, segui questi passaggi.

Console

1. Vai alla pagina Managed Service per Apache Kafka > Cluster.

   Vai a Cluster

2. Fai clic sul nome del cluster.

3. Seleziona la scheda Configurazioni. I broker del cluster sono elencati in Active Brokers.

gcloud

Per ottenere un elenco dei broker del cluster, utilizza il comando managed-kafka clusters describe con il flag --full.

gcloud managed-kafka clusters describe CLUSTER_ID \
  --location=LOCATION \
  --full \
  --format="yaml(brokerDetails)"

Sostituisci quanto segue:

• CLUSTER_ID: l'ID o il nome del cluster.
• LOCATION: la posizione del cluster.

L'output è simile al seguente:

brokerDetails:
- brokerIndex: '0'
  nodeId: '10'
  rack: us-central1-c
- brokerIndex: '1'
  nodeId: '11'
  rack: us-central1-f
- brokerIndex: '2'
  nodeId: '12'
  rack: us-central1-b

Interfaccia a riga di comando Kafka

Prima di eseguire questo comando, installa gli strumenti a riga di comando Kafka su una VM Compute Engine. La VM deve essere in grado di raggiungere una subnet connessa al cluster Managed Service per Apache Kafka. Segui le istruzioni riportate in Produci e utilizza messaggi con gli strumenti a riga di comando Kafka.

Per ottenere un elenco dei broker del cluster, utilizza il comando kafka-configs.sh --describe con il flag --entity-type=brokers.

kafka-configs.sh --describe --entity-type brokers \
  --bootstrap-server=BOOTSTRAP_ADDRESS \
  --command-config client.properties

Sostituisci BOOTSTRAP_ADDRESS con l'indirizzo di bootstrap del cluster.

Questo comando restituisce un elenco di ID broker, insieme alle impostazioni di configurazione dinamica, se presenti. Non restituisce la proprietà rack.

Gruppi di consumer

Un gruppo di consumatori è un insieme di consumatori che collaborano per consumare dati di vari argomenti. Per visualizzare i gruppi di consumatori per un cluster, consulta le seguenti pagine:

• Elencare i gruppi di consumatori
• Visualizzare un gruppo di consumer

Subnet

Per visualizzare le subnet connesse al cluster, segui questi passaggi:

Console

1. Nella console Google Cloud , vai alla pagina Cluster.

   Vai a Cluster

2. Fai clic sul nome del cluster.

3. Nella pagina dei dettagli del cluster, fai clic sulla scheda Configurazioni. Le subnet connesse sono elencate nella sezione Subnet.

gcloud

1. Esegui il comando gcloud managed-kafka clusters describe:

   gcloud managed-kafka clusters describe CLUSTER_ID \
       --location=LOCATION \
       --format="yaml(gcpConfig.accessConfig.networkConfigs)"
   

   Sostituisci quanto segue:

   • CLUSTER_ID: l'ID o il nome del cluster.
   • LOCATION: la posizione del cluster.

Per maggiori informazioni, vedi Configura il networking per Managed Service per Apache Kafka.

Argomenti

Per visualizzare gli argomenti in un cluster, consulta le seguenti pagine:

• Elencare gli argomenti
• Visualizzare un argomento

Passaggi successivi

• Monitora il cluster.

• Crea un argomento all'interno del cluster.

• Modificare un cluster.

• Elimina il cluster.

Apache Kafka® è un marchio registrato di Apache Software Foundation o delle sue affiliate negli Stati Uniti e/o in altri paesi.