Halaman ini diterjemahkan oleh Cloud Translation API.

Menyiapkan aplikasi gRPC di Google Cloud dengan kemampuan observasi Microservices

Alat observabilitas microservice memberi Anda kemampuan untuk menginstrumentasi aplikasi guna mengumpulkan dan menyajikan data telemetri di Cloud Monitoring, Cloud Logging, dan Cloud Trace dari workload gRPC yang di-deploy di Google Cloud dan di tempat lain. Kemampuan observasi microservice berfungsi dengan deployment apa pun yang telah diberi izin untuk mengakses Monitoring, Logging, dan Trace dengan mengaktifkan Microservices API.

Dalam tutorial ini, Anda akan mempelajari cara menggunakan fitur keobservasian Microservice dengan membuat aplikasi gRPC sederhana di Google Cloud menggunakan Compute Engine dan menginstrumentasikan aplikasi Anda dengan keobservasian Microservice, serta melihatnya muncul secara langsung di Monitoring dan Logging.

Membuat dan menghubungkan ke VM Compute Engine

Gunakan petunjuk ini untuk membuat dan menghubungkan ke instance VM Compute Engine. Di VM, Anda men-deploy aplikasi, lalu menginstrumentasikan aplikasi dengan kemampuan observasi Microservice.

Buat instance VM:

gcloud compute instances create grpc-observability-vm \
  --image-family=debian-11 \
  --image-project=debian-cloud \
  --service-account=SERVICE_ACCOUNT_NAME@$PROJECT_ID.iam.gserviceaccount.com

Hubungkan ke instance VM:

gcloud compute ssh --project=$PROJECT_ID grpc-observability-vm

Men-deploy aplikasi Anda ke VM Compute Engine

Anda dapat men-deploy aplikasi pilihan Anda ke VM Compute Engine yang Anda buat pada langkah sebelumnya, lalu lewati langkah ini, atau Anda dapat menggunakan contoh untuk melanjutkan petunjuk dalam bahasa pilihan Anda.

C++

Setelah Anda terhubung ke instance VM, jalankan perintah berikut.

sudo apt-get update -y
sudo apt-get install -y git build-essential clang
git clone -b v1.54.0 https://github.com/grpc/grpc.git --depth=1

Go

Pastikan Anda telah menginstal Go.

sudo apt-get install -y git
sudo apt install wget
wget https://go.dev/dl/go1.20.2.linux-amd64.tar.gz
sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf \
go1.20.2.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin

Buat clone contoh gRPC-Go.

git clone https://github.com/grpc/grpc-go.git
cd grpc-go/
git checkout -b run-observability-example
875c97a94dca8093bf01ff2fef490fbdd576373d

Java

Setelah Anda terhubung ke instance VM, pastikan Anda telah menginstal Java 8 atau yang lebih baru.

sudo apt update
sudo apt upgrade
sudo apt install git
sudo apt-get install -y openjdk-11-jdk-headless

Buat clone repositori grpc-java.

export EXAMPLES_VERSION=v1.54.1
git clone -b $EXAMPLES_VERSION --single-branch --depth=1 \
https://github.com/grpc/grpc-java.git

Buat file konfigurasi gRPC Google Cloud Observability

Anda memerlukan file konfigurasi gRPC Google Cloud Observability terpisah untuk mengaktifkan Microservices observability untuk server dan klien. Lokasi file ini diekspor sebagai GRPC_GCP_OBSERVABILITY_CONFIG_FILE pada langkah-langkah berikutnya. Gunakan petunjuk berikut tentang cara menyiapkan berbagai parameter dalam file config.

Contoh `GRPC_GCP_OBSERVABILITY_CONFIG_FILE`

{
  "project_id": "your-project-here",
  "cloud_logging": {
    "client_rpc_events": [
    {
      "methods": ["google.pubsub.v1.Subscriber/Acknowledge", "google.pubsub.v1.Publisher/CreateTopic"],
      "exclude": true,
    },
    {
      "methods": ["google.pubsub.v1.Subscriber/*", "google.pubsub.v1.Publisher/*"],
      "max_metadata_bytes": 4096,
      "max_message_bytes": 4096,
    }],
    "server_rpc_events": [{
      "methods": ["*"],
      "max_metadata_bytes": 4096,
      "max_message_bytes": 4096
    }],
  },
  "cloud_monitoring": {},
  "cloud_trace": {
    "sampling_rate": 0.5,
  }
  "labels": {
    "SOURCE_VERSION": "J2e1Cf",
    "SERVICE_NAME": "payment-service-1Cf",
    "DATA_CENTER": "us-west1-a"
  }
}

Bagian berikut berisi petunjuk untuk mengaktifkan pengumpulan data dalam konfigurasi Anda untuk setiap komponen. Jika menggunakan contoh gRPC dalam tutorial ini, Anda dapat menggunakan konfigurasi ini apa adanya (setelah memperbarui your-project-here) atau menggunakannya sebagai template untuk aplikasi Anda.Contoh yang menunjukkan informasi konfigurasi dalam variabel lingkungan.

Mengaktifkan metrik

Untuk mengaktifkan metrik, tambahkan objek cloud_monitoring ke konfigurasi dan tetapkan nilainya ke {}.

Untuk mengetahui informasi selengkapnya tentang metrik, lihat Definisi metrik.

Mengaktifkan pelacakan

Untuk mengaktifkan pelacakan, lakukan hal berikut:

Tambahkan objek cloud_trace ke konfigurasi.
Tetapkan cloud_trace.sampling_rate ke 0.5 yang secara acak melacak 50% RPC.

Jika Anda berencana mengaktifkan pelacakan di seluruh layanan, pastikan layanan mendukung propagasi konteks rekaman aktivitas yang diterima dari hulu (atau dimulai dengan sendirinya) ke hilir.

Untuk mengetahui informasi selengkapnya tentang rekaman aktivitas, lihat Definisi rekaman aktivitas.

Aktifkan logging

Untuk mengaktifkan logging, lakukan hal berikut:

Tambahkan objek cloud_logging ke konfigurasi.
Tambahkan pola ke client_rpc_events atau server_rpc_events atau keduanya yang menentukan kumpulan layanan atau metode yang ingin Anda buat pencatatan peristiwa tingkat transportasi dan jumlah byte yang akan dicatat untuk header dan pesan.

Untuk mengetahui informasi selengkapnya tentang logging, lihat Definisi rekaman log.

Melengkapi aplikasi Anda untuk plugin kemampuan observasi

Untuk menginstrumentasi aplikasi agar dapat menggunakan plugin observabilitas Microservices, gunakan petunjuk berikut untuk bahasa pilihan Anda.

C++

Anda dapat menggunakan C++ dengan kemampuan observasi Microservices mulai dari gRPC C++ v1.54. Repositori contoh ada di GitHub.

Dukungan kemampuan observasi hanya tersedia melalui sistem build Bazel. Tambahkan target grpcpp_gcp_observability sebagai dependensi.
Mengaktifkan kemampuan observasi Microservice memerlukan dependensi tambahan (modul kemampuan observasi) dan perubahan kode berikut pada klien, server gRPC, atau keduanya yang ada:
```
#include <grpcpp/ext/gcp_observability.h>

int main(int argc, char** argv) {
  auto observability = grpc::GcpObservability::Init();
  assert(observability.ok());
  …
  // Observability data flushed when object goes out of scope
}
```
Sebelum melakukan operasi gRPC apa pun, termasuk membuat saluran, server, atau kredensial, panggil yang berikut:
```
grpc::GcpObservability::Init();
```
Tindakan ini menampilkan absl::StatusOr<GcpObservability> yang harus disimpan. Status membantu menentukan apakah observabilitas berhasil diinisialisasi. Objek GcpObservability yang menyertainya mengontrol masa aktif kemampuan pengamatan, dan secara otomatis menutup serta menghapus data kemampuan pengamatan saat keluar dari cakupan.

Go

Plugin kemampuan observasi microservice didukung untuk gRPC Go versi v1.54.0 dan yang lebih baru. Repositori contoh ada di GitHub.

Dengan modul Go, memilih untuk mengaktifkan kemampuan observasi Microservice memerlukan modul kemampuan observasi dan kode berikut:

import "google.golang.org/grpc/gcp/observability"

func main() {
  ctx, cancel := context.WithTimeout(context.Background(), time.Second)
  defer cancel()
  if err := observability.Start(ctx); err != nil {
    log.Warning("Unable to start gRPC observability:", err)
  }
  defer observability.End()
  …
}

Panggilan observability.Start mengurai konfigurasi dari variabel lingkungan, membuat eksportir yang sesuai, dan menyisipkan logika pengumpulan ke koneksi klien dan server yang dibuat setelah panggilan. Panggilanobservability.End yang ditangguhkan membersihkan resource dan memastikan data yang di-buffer dikosongkan sebelum aplikasi ditutup.

Setelah kode aplikasi diperbarui, jalankan perintah berikut untuk memperbarui file go.mod.

go mod tidy

Java

Untuk menggunakan Kemampuan observasi microservice dengan aplikasi Java, ubah build Anda untuk menyertakan artefak grpc-gcp-observability. Gunakan gRPC versi 1.54.1 atau yang lebih baru.

Dalam cuplikan build di bagian alat build Gradle dan Maven, grpcVersion disetel ke nilai 1.54.1.

Repositori contoh ada di GitHub.

Agar berhasil melengkapi aplikasi Java untuk kemampuan pengamatan Microservice, tambahkan kode berikut ke main().

...
import io.grpc.gcp.observability.GcpObservability;
...

// Main application class
...

public static void main(String[] args) {
...
  // call GcpObservability.grpcInit() to initialize & get observability
  GcpObservability observability = GcpObservability.grpcInit();

...
  // call close() on the observability instance to shutdown observability
  observability.close();
...
}

Perhatikan bahwa Anda harus memanggil GcpObservability.grpcInit() sebelum saluran atau server gRPC dibuat. Fungsi GcpObservability.grpcInit() membaca konfigurasi pengamatan Microservices dan menggunakannya untuk menyiapkan interseptor dan tracer global yang diperlukan untuk fitur logging, metrik, dan trace di setiap saluran dan server yang dibuat. GcpObservability.grpcInit() aman untuk thread dan harus dipanggil tepat satu kali. Tindakan ini akan menampilkan instance GcpObservability yang harus Anda simpan untuk memanggil close() nanti.

GcpObservability.close() membatalkan alokasi resource. Channel atau server yang dibuat setelahnya tidak melakukan logging apa pun.

GcpObservability mengimplementasikan java.lang.AutoCloseable, yang ditutup secara otomatis jika Anda menggunakan try-with-resource sebagai berikut:

...
import io.grpc.gcp.observability.GcpObservability;
...

// Main application class
...

public static void main(String[] args) {
...
  // call GcpObservability.grpcInit() to initialize & get observability
  try (GcpObservability observability = GcpObservability.grpcInit()) {

...
  } // observability.close() called implicitly
...
}

Menggunakan alat build Gradle

Jika Anda menggunakan alat build Gradle, sertakan kode berikut:

def grpcVersion = '1.54.1'

...

dependencies {
...
implementation "io.grpc:grpc-gcp-observability:${grpcVersion}"
...
}

Menggunakan alat build Maven (pom.xml)

Jika Anda menggunakan alat build Maven, sertakan kode berikut:

<properties>
...
<grpc.version>1.54.1</grpc.version>
...
</properties>

...

<dependencies>
...
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-gcp-observability</artifactId>
<version>${grpc.version}</version>
</dependency>
...
</dependencies>

Jalankan aplikasi Anda

Ikuti petunjuk di bagian ini hanya jika Anda menggunakan contoh gRPC untuk tutorial. Anda dapat mengubah perintah run untuk menargetkan biner aplikasi Anda.

Menjalankan Server

C++

Buat sesi SSH ke VM.

Ekspor variabel lingkungan. Gunakan langkah-langkah yang ditentukan di atas untuk membuat server_config.json.

  export GOOGLE_CLOUD_PROJECT=$PROJECT_ID
  export GRPC_GCP_OBSERVABILITY_CONFIG_FILE="$(pwd)/examples/cpp/gcp_observability/helloworld/server_config.json"

Jalankan aplikasi server shell cd grpc tools/bazel run examples/cpp/gcp_observability/helloworld:greeter_server

Go

Buat sesi SSH ke VM.
Ekspor variabel lingkungan. Gunakan langkah-langkah yang ditentukan di atas untuk membuat server_config.json.
```
export GRPC_GCP_OBSERVABILITY_CONFIG_FILE=./server/serverConfig.json
```
Jalankan aplikasi server shell go run ./server/main.go

Java

Di direktori contoh, buka file README dan ikuti petunjuk dalam file.
Saat petunjuk meminta Anda membuka jendela terminal lain, jalankan perintah ini: shell gcloud compute ssh --project=$PROJECT_ID grpc-observability-vm

Menjalankan Klien

C++

Buat sesi SSH lain ke VM.

Ekspor variabel lingkungan. Gunakan langkah-langkah yang ditentukan di atas untuk membuat file client_config.json.

  export GOOGLE_CLOUD_PROJECT=$PROJECT_ID
  export GRPC_GCP_OBSERVABILITY_CONFIG_FILE="$(pwd)/examples/cpp/gcp_observability/helloworld/client_config.json"

Menjalankan aplikasi klien

cd grpc
tools/bazel run examples/cpp/gcp_observability/helloworld:greeter_client

Go

Buat sesi SSH lain ke VM.
Ekspor variabel lingkungan. Gunakan langkah-langkah yang ditentukan di atas untuk membuat file client_config.json. shell export GRPC_GCP_OBSERVABILITY_CONFIG_FILE=./client/clientConfig.json

Menjalankan aplikasi klien

cd grpc-go/examples/features/observability
go run ./client/main.go

Java

Di direktori contoh, buka file README dan ikuti petunjuk dalam file.
Saat petunjuk meminta Anda membuka jendela terminal lain, jalankan perintah ini: shell gcloud compute ssh --project=$PROJECT_ID grpc-observability-vm

Menyiapkan aplikasi gRPC di Google Cloud dengan kemampuan observasi Microservices Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Membuat dan menghubungkan ke VM Compute Engine

Men-deploy aplikasi Anda ke VM Compute Engine

C++

Go

Java

Buat file konfigurasi gRPC Google Cloud Observability

Contoh GRPC_GCP_OBSERVABILITY_CONFIG_FILE

Mengaktifkan metrik

Mengaktifkan pelacakan

Aktifkan logging

Melengkapi aplikasi Anda untuk plugin kemampuan observasi

C++

Go

Java

Menggunakan alat build Gradle

Menggunakan alat build Maven (pom.xml)

Jalankan aplikasi Anda

Menjalankan Server

C++

Go

Java

Menjalankan Klien

C++

Go

Java

Menyiapkan aplikasi gRPC di Google Cloud dengan kemampuan observasi Microservices

Contoh `GRPC_GCP_OBSERVABILITY_CONFIG_FILE`