C++

1. After you connect to the VM instance, run the following command.

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

Go

1. Make sure that you have Go installed.

   sudo apt-get install -y gitsudo apt install wgetwget https://go.dev/dl/go1.20.2.linux-amd64.tar.gzsudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf \go1.20.2.linux-amd64.tar.gzexport PATH=$PATH:/usr/local/go/bin

2. Clone thegRPC-Go examples.

   git clone https://github.com/grpc/grpc-go.gitcd grpc-go/git checkout -b run-observability-example875c97a94dca8093bf01ff2fef490fbdd576373d

Java

1. After you connect to the VM instance, make sure that you have Java 8 orlater installed.

   sudo apt updatesudo apt upgradesudo apt install gitsudo apt-get install -y openjdk-11-jdk-headless

2. Clone thegrpc-java repository.

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

C++

You can use C++ with Microservices observability as of gRPC C++ v1.54. Theexample repository is in GitHub.

1. Observability support is only available through the Bazel build system. Addthe targetgrpcpp_gcp_observability as a dependency.

2. Opting in Microservices observability requires an additionaldependency (an observability modul) and the following code changes toexisting gRPC clients, servers, or both:

   #include <grpcpp/ext/gcp_observability.h>intmain(intargc,char**argv){autoobservability=grpc::GcpObservability::Init();assert(observability.ok());…// Observability data flushed when object goes out of scope}

   Before any gRPC operations, including creating a channel, server, orcredentials, invoke the following:

   grpc::GcpObservability::Init();

   This returnsabsl::StatusOr<GcpObservability> which should be saved. Thestatus helps determine whether observability was successfully initialized.The accompanyingGcpObservability object controls the lifetime ofobservability, and automatically closes and flushes observability datawhen it goes out of scope.

Go

1. Microservices observability plugins are supported for gRPC Go versionsv1.54.0 and later. Theexample repository is in GitHub.

With the Go module, opting in Microservices observability requires anobservability module and the following code:

import"google.golang.org/grpc/gcp/observability"funcmain(){ctx,cancel:=context.WithTimeout(context.Background(),time.Second)defercancel()iferr:=observability.Start(ctx);err!=nil{log.Warning("Unable to start gRPC observability:",err)}deferobservability.End()…}

Theobservability.Start call parses the configuration from environmentvariables, creates exporters accordingly, and injects collection logic to clientconnections and servers created after the call. The deferredobservability.Endcall cleans up resources and ensures that buffered data is flushed before theapplication closes.

After the application code is updated, run the following command to update thego.mod file.

gomodtidy

Java

To use Microservices observability with Java applications, modify your build toinclude thegrpc-gcp-observability artifact. Use gRPC version 1.54.1 orlater.

In the build snippets in the Gradle and Maven build tool sections,grpcVersion is set to the value 1.54.1.

Theexample repository is in GitHub.

1. To successfully instrument your Java applications for Microservicesobservability, add the following code tomain().

...importio.grpc.gcp.observability.GcpObservability;...// Main application class...publicstaticvoidmain(String[]args){...// call GcpObservability.grpcInit() to initialize & get observabilityGcpObservabilityobservability=GcpObservability.grpcInit();...// call close() on the observability instance to shutdown observabilityobservability.close();...}

Note that you must callGcpObservability.grpcInit() before any gRPC channelsor servers are created. TheGcpObservability.grpcInit() function reads theMicroservices observability configuration and uses that to set up the globalinterceptors and tracers that are required for the logging, metrics, and tracefeatures in each channel and server created.GcpObservability.grpcInit()is thread safe and must be called exactly once. It returns an instance ofGcpObservability that you must save in order to callclose() later.

GcpObservability.close() de-allocates resources. Any channel or servers createdafterwards don't perform any logging.

GcpObservability implementsjava.lang.AutoCloseable, which is closedautomatically if you usetry-with-resources as follows:

...importio.grpc.gcp.observability.GcpObservability;...// Main application class...publicstaticvoidmain(String[]args){...// call GcpObservability.grpcInit() to initialize & get observabilitytry(GcpObservabilityobservability=GcpObservability.grpcInit()){...}// observability.close() called implicitly...}

Use the Gradle build tool

If you are using the Gradle build tool, include the following:

def grpcVersion = '1.54.1'...dependencies {...implementation "io.grpc:grpc-gcp-observability:${grpcVersion}"...}

Use the Maven build tool (pom.xml)

If you are using the Maven build tool, include the following:

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

C++

1. Create a SSH session into the VM.

2. Export environmental variables. Use steps definedabove to createserver_config.json.

   exportGOOGLE_CLOUD_PROJECT=$PROJECT_IDexportGRPC_GCP_OBSERVABILITY_CONFIG_FILE="$(pwd)/examples/cpp/gcp_observability/helloworld/server_config.json"

3. Run the server applicationshellcd grpctools/bazel run examples/cpp/gcp_observability/helloworld:greeter_server

Go

1. Create a SSH session into the VM.

2. Export environmental variables. Use steps definedabove to createserver_config.json.

   exportGRPC_GCP_OBSERVABILITY_CONFIG_FILE=./server/serverConfig.json

3. Run the server applicationshellgo run ./server/main.go

Java

1. In the examples directory, open the README file and follow theinstructions in the file.
2. When the instructions tell you to open another terminal window, issuethis command:shellgcloud compute ssh --project=$PROJECT_ID grpc-observability-vm

C++

1. Create another SSH session into the VM.

2. Export environmental variables. Use steps definedabove to createclient_config.json file.

   exportGOOGLE_CLOUD_PROJECT=$PROJECT_IDexportGRPC_GCP_OBSERVABILITY_CONFIG_FILE="$(pwd)/examples/cpp/gcp_observability/helloworld/client_config.json"

3. Run the client application

   cdgrpctools/bazelrunexamples/cpp/gcp_observability/helloworld:greeter_client

Go

1. Create another SSH session into the VM.
2. Export environmental variables. Use steps definedabove to createclient_config.json file.shellexport GRPC_GCP_OBSERVABILITY_CONFIG_FILE=./client/clientConfig.json

3. Run the client application

   cdgrpc-go/examples/features/observabilitygorun./client/main.go

Java

1. In the examples directory, open the README file and follow the instructionsin the file.
2. When the instructions tell you to open another terminal window, issue thiscommand:shellgcloud compute ssh --project=$PROJECT_ID grpc-observability-vm