Apache Kafka용 Google Cloud 관리형 서비스 주제 보기

단일 주제에 관한 세부정보를 보려면Google Cloud 콘솔, Google Cloud CLI, 클라이언트 라이브러리, 관리형 Kafka API 또는 오픈소스 Apache Kafka API를 사용하면 됩니다.

주제를 볼 수 있는 필수 역할 및 권한

주제를 보는 데 필요한 권한을 얻으려면 관리자에게 프로젝트에 대한 관리형 Kafka 뷰어 (roles/managedkafka.viewer) IAM 역할을 부여해 달라고 요청하세요. 역할 부여에 대한 자세한 내용은 프로젝트, 폴더, 조직에 대한 액세스 관리를 참조하세요.

이 사전 정의된 역할에는 주제를 보는 데 필요한 권한이 포함되어 있습니다. 필요한 정확한 권한을 보려면 필수 권한 섹션을 펼치세요.

필수 권한

주제를 보려면 다음 권한이 필요합니다.

주제 나열: managedkafka.topics.list
주제 가져오기: managedkafka.topics.get

커스텀 역할이나 다른 사전 정의된 역할을 사용하여 이 권한을 부여받을 수도 있습니다.

관리형 Kafka 뷰어 (roles/managedkafka.viewer) IAM 역할에 대한 자세한 내용은 Apache Kafka용 관리형 서비스 사전 정의된 역할을 참고하세요.

콘솔의 주제 속성

콘솔에서 다음 주제 속성을 확인할 수 있습니다.

구성: 이 탭에서는 다음을 비롯한 주제에 관한 일반 구성 세부정보를 제공합니다.
- 이름: 클러스터 내 주제의 고유 식별자입니다.
- 파티션: 주제의 파티션 수입니다. 파티션은 확장성과 병렬 처리를 위해 주제의 데이터를 세그먼트로 나눕니다.
- 복제본: 데이터 중복 및 가용성을 보장하기 위해 각 파티션에 유지되는 사본 (복제본) 수입니다.
- 클러스터: 주제가 속한 Apache Kafka용 관리형 서비스 클러스터의 이름입니다.
- 리전: 클러스터와 주제가 있는 Google Cloud 리전입니다.
- 기본값이 아닌 주제 매개변수: 클러스터 전체 기본값과 다른 주제에 설정된 주제 수준 구성 재정의입니다.
모니터링: 이 탭에는 주제의 활동 및 실적과 관련된 주요 측정항목을 표시하는 시각적 차트가 제공됩니다. 이러한 차트에는 다음이 포함됩니다.
- 바이트 수: 바이트가 생성되거나 주제로 전송되는 비율을 보여주는 시계열 차트입니다. 시간 경과에 따라 주제에 게시된 데이터의 양을 나타냅니다. 해당 측정항목은 managedkafka.googleapis.com/byte_in_count입니다.
- 요청 수: 주제에 대한 요청 비율을 나타내는 시계열 차트입니다. 주제의 전반적인 활동과 사용량을 반영합니다. 관련 측정항목은 managedkafka.googleapis.com/topic_request_count입니다.
- 파티션별 로그 세그먼트: 이 차트는 주제 내 각 파티션의 활성 로그 세그먼트 수를 표시합니다. 로그 세그먼트는 Kafka가 주제 데이터를 저장하는 디스크의 실제 파일입니다. 관련 측정항목은 managedkafka.googleapis.com/log_segments입니다.
소비자 그룹: 이 섹션에는 주제를 구독하는 소비자 그룹이 나열됩니다. 소비자 그룹은 주제에서 메시지를 읽기 위해 함께 작동하는 소비자 집합입니다.

주제 보기

콘솔

Google Cloud 콘솔에서 클러스터 페이지로 이동합니다.

클러스터로 이동

프로젝트에서 생성한 클러스터가 나열됩니다.
주제를 확인하려는 클러스터를 클릭합니다.

클러스터 세부정보 페이지가 표시됩니다. 클러스터 세부정보 페이지의 리소스 탭에 주제가 나열됩니다.
특정 주제를 보려면 주제 이름을 클릭합니다.

주제 세부정보 페이지가 표시됩니다.

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.
gcloud managed-kafka topics describe 명령어를 실행합니다.
```
gcloud managed-kafka topics describe TOPIC_ID \
  --cluster=CLUSTER_ID --location=LOCATION_ID
```
이 명령어는 지정된 주제에 관한 포괄적인 세부정보를 가져와서 표시합니다. 이 정보에는 파티션 수, 복제 요소, 주제 수준 구성 재정의와 같은 구성 설정이 포함됩니다.

다음을 바꿉니다.
- TOPIC_ID: 주제의 ID입니다.
- CLUSTER_ID: 주제가 포함된 클러스터의 ID입니다.
- LOCATION_ID: 클러스터의 위치입니다.

gcloud managed-kafka topics describe 명령어는 파티션 수, 복제 계수 등 주제에 관한 최소한의 정보를 표시합니다. 파티션 할당 및 전체 구성 설정을 비롯한 자세한 정보를 가져오려면 kafka-topics.sh 명령줄 도구를 사용하세요.

Kafka CLI

이 명령어를 실행하기 전에 Compute Engine VM에 Kafka 명령줄 도구를 설치하세요. VM은 Apache Kafka용 관리형 서비스 클러스터에 연결된 서브넷에 도달할 수 있어야 합니다. Kafka 명령줄 도구로 메시지 생성 및 사용의 안내를 따릅니다.

주제에 대한 세부정보를 보려면 kafka-topics.sh --describe 명령어를 실행합니다.

kafka-topics.sh --describe \
  --bootstrap-server=BOOTSTRAP_ADDRESS \
  --command-config client.properties \
  --topic TOPIC_ID

다음을 바꿉니다.

BOOTSTRAP_ADDRESS: Managed Service for Apache Kafka 클러스터의 부트스트랩 주소입니다.
TOPIC_ID: 주제의 ID입니다.

이 명령어는 다음을 포함하여 주제 속성의 하위 집합을 반환합니다.

파티션 수
복제 인수
파티션 할당
동적 구성 (명시적으로 설정한 설정)
정적 구성 (클러스터가 시작될 때 적용되는 설정)

기본값이 있는 설정을 포함하여 주제의 전체 구성 설정을 보려면 kafka-configs.sh --describe 명령어를 실행하세요.

kafka-configs.sh --describe \
--bootstrap-server=BOOTSTRAP_ADDRESS \
--command-config client.properties \
--entity-type topics \
--entity-name TOPIC_ID \
--all

출력은 설정 목록을 키-값 쌍으로 표시합니다. --all 플래그는 모든 구성 설정을 반환합니다. 동적 구성 설정 목록만 가져오려면 --all 플래그를 생략합니다.

REST

요청 데이터를 사용하기 전에 다음을 바꿉니다.

PROJECT_ID: Google Cloud 프로젝트 ID
LOCATION: 클러스터의 위치
CLUSTER_ID: 클러스터의 ID
TOPIC_ID: 주제의 ID

HTTP 메서드 및 URL:

GET https://managedkafka.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/topics/TOPIC_ID

요청을 보내려면 다음 옵션 중 하나를 펼칩니다.

cURL(Linux, macOS, Cloud Shell)

참고: 다음 명령어는 gcloud init 또는 gcloud auth login을 실행하거나 gcloud CLI에 자동으로 로그인하는 Cloud Shell을 사용하여 사용자 계정으로 gcloud CLI에 로그인했다고 가정합니다. gcloud auth list를 실행하면 현재 활성 계정을 확인할 수 있습니다.

다음 명령어를 실행합니다.

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

PowerShell(Windows)

참고: 다음 명령어는 gcloud init 또는 gcloud auth login을 실행하여 사용자 계정으로 gcloud CLI에 로그인했다고 가정합니다. gcloud auth list를 실행하면 현재 활성 계정을 확인할 수 있습니다.

다음 명령어를 실행합니다.

$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/topics/TOPIC_ID" | Select-Object -Expand Content

다음과 비슷한 JSON 응답이 표시됩니다.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/topics/TOPIC_ID",
  "partitionCount": PARTITION_COUNT,
  "replicationFactor": REPLICATION_FACTOR
}

Go

이 샘플을 사용해 보기 전에 클라이언트 라이브러리 설치의 Go 설정 안내를 따르세요. 자세한 내용은 Apache Kafka용 관리형 서비스 Go API 참조 문서를 참고하세요.

Managed Service for Apache Kafka에 인증하려면 애플리케이션 기본 사용자 인증 정보(ADC)를 설정합니다. 자세한 내용은 로컬 개발 환경의 ADC 설정을 참고하세요.

import (
	"context"
	"fmt"
	"io"

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

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

func getTopic(w io.Writer, projectID, region, clusterID, topicID string, opts ...option.ClientOption) error {
	// projectID := "my-project-id"
	// region := "us-central1"
	// clusterID := "my-cluster"
	// topicID := "my-topic"
	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)
	topicPath := fmt.Sprintf("%s/topics/%s", clusterPath, topicID)
	req := &managedkafkapb.GetTopicRequest{
		Name: topicPath,
	}
	topic, err := client.GetTopic(ctx, req)
	if err != nil {
		return fmt.Errorf("client.GetTopic got err: %w", err)
	}
	fmt.Fprintf(w, "Got topic: %#v\n", topic)
	return nil
}

자바

이 샘플을 시도하기 전에 클라이언트 라이브러리 설치의 Java 설정 안내를 따르세요. 자세한 내용은 Apache Kafka용 관리형 서비스 Java API 참조 문서를 참고하세요.

Managed Service for Apache Kafka에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 ADC 설정을 참고하세요.

import com.google.api.gax.rpc.ApiException;
import com.google.cloud.managedkafka.v1.ManagedKafkaClient;
import com.google.cloud.managedkafka.v1.Topic;
import com.google.cloud.managedkafka.v1.TopicName;
import java.io.IOException;

public class GetTopic {

  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";
    String topicId = "my-topic";
    getTopic(projectId, region, clusterId, topicId);
  }

  public static void getTopic(String projectId, String region, String clusterId, String topicId)
      throws Exception {
    try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
      // This operation is being handled synchronously.
      Topic topic =
          managedKafkaClient.getTopic(TopicName.of(projectId, region, clusterId, topicId));
      System.out.println(topic.getAllFields());
    } catch (IOException | ApiException e) {
      System.err.printf("managedKafkaClient.getTopic got err: %s", e.getMessage());
    }
  }
}

Python

이 샘플을 시도하기 전에 클라이언트 라이브러리 설치의 Python 설정 안내를 따르세요. 자세한 내용은 Apache Kafka용 관리형 서비스 Python API 참조 문서를 참고하세요.

Managed Service for Apache Kafka에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 로컬 개발 환경의 ADC 설정을 참고하세요.

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"
# topic_id = "my-topic"

client = managedkafka_v1.ManagedKafkaClient()

topic_path = client.topic_path(project_id, region, cluster_id, topic_id)
request = managedkafka_v1.GetTopicRequest(
    name=topic_path,
)

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

Apache Kafka용 Google Cloud 관리형 서비스 주제 보기 컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

주제를 볼 수 있는 필수 역할 및 권한

필수 권한

콘솔의 주제 속성

주제 보기

콘솔

gcloud

Kafka CLI

REST

cURL(Linux, macOS, Cloud Shell)

PowerShell(Windows)

Go

자바

Python

다음 단계

Apache Kafka용 Google Cloud 관리형 서비스 주제 보기