examples: add gcp-observability examples #9967

DNVindhya · 2023-03-20T21:57:38Z

This PR adds gcp-observability example based on HelloWorld.

sanjaypujare · 2023-03-20T22:40:32Z

examples/example-gcp-observability/README.md

+
+The GCP Observability example consists of a Hello World client and a Hello World server instrumented for logs, metrics and tracing. 
+
+__Please refer to GCP observability user guide for setting up authorization to acess Google Cloud Platform with Google user credentials.__


Can we provide a link to the UG? We have one for preview and it's not going to change for GA, right?

Also it will be good if the link is to the specific section about credentials and authorization

I checked with Lisa, she is trying to get a new directory set up. In that case, UG link will be different than what we have now.

Okay, we can go with the current link and update it whenever we have the updated link

Updated and added current user guide link.

Link is correct but the link text "GCP observability user guide" doesn't match it or is not even correct. The user guide says it is for "Microservices observability" - so we could at least say that. In reality the UG is for "gRPC GCP Observability" or "gRPC Microservices on GCP Observability" . "GCP Observability" is too broad.

I removed the link, as the link is going to be changed when we release.
The product name is "Microservices Observability", should i add "gRPC Microservices Observability" instead here to show connection to gRPC (while we do not have a link). Let me know what you think.

If you removed the link, make sure the description is as close to what the actual UG title is (since users will have to search to find it). I think it is "Microservices Observability" so that makes most sense.

examples/example-gcp-observability/README.md

...ty/src/main/java/io/grpc/examples/observabilityHelloWorld/ObservabilityHelloWorldClient.java

ejona86 · 2023-03-21T00:47:28Z

...ty/src/main/java/io/grpc/examples/observabilityHelloWorld/ObservabilityHelloWorldClient.java

+          String.format(
+              "Sleeping %d seconds before shutdown to ensure all records are flushed.",
+              EXPORT_INTERVAL));
+      Thread.sleep(TimeUnit.MILLISECONDS.convert(EXPORT_INTERVAL, TimeUnit.SECONDS));


If a sleep is still necessary, we should have that sleep in gcp-observability. The user shouldn't have to deal with stuff like this. Once we fix the issue the user's shutdown would naturally run faster.

Agree, will add sleep to gcp-observability in a follow up PR.

Added in PR #9972

examples/example-gcp-observability/src/main/proto/helloworld/helloworld.proto

sanjaypujare

Added a bunch of comments. Will take a look again once addressed

…or client and server

DNVindhya · 2023-03-21T07:40:59Z

Addressed comments. @sanjaypujare PTAL.

…uctions

fengli79 · 2023-03-22T22:45:56Z

...cp-observability/src/main/java/io/grpc/examples/gcpobservability/GcpObservabilityServer.java

+   */
+  public static void main(String[] args) throws IOException, InterruptedException {
+    // Initialize observability
+    GcpObservability observability = GcpObservability.grpcInit();


Shall we do?

try(observability) {

} finally {
WaitUntilShutdown();
}

Do you mean

try (observability) { final GcpObservabilityServer server = new GcpObservabilityServer(); } finally { server.blockUntilShutdown(); }

In this case, server being a non-static variable cannot be accessed in a static method. Server needs to be created after initializing observability within the try block.

In the above code server is not in scope in the finally clause ...

fengli79 · 2023-03-22T22:47:01Z

...ty/src/main/resources/io/grpc/examples/gcpobservability/gcp_observability_client_config.json

+{
+  "cloud_monitoring": {},
+  "cloud_trace": {
+    "sampling_rate": 1.00


...ty/src/main/resources/io/grpc/examples/gcpobservability/gcp_observability_client_config.json

sanjaypujare

I have some comments and it will be nice to address them but looks good so okay to merge without them too.

…lity

* add examples for gcp-observability

* examples: add gcp-observability examples (#9967)

* add examples for gcp-observability

DNVindhya added 3 commits March 20, 2023 14:43

add examples for gcp-observability

c7cd10b

updated comments

11d4ada

added newline at EOF

502e582

sanjaypujare reviewed Mar 20, 2023

View reviewed changes

examples/example-gcp-observability/README.md Outdated Show resolved Hide resolved

sanjaypujare reviewed Mar 20, 2023

View reviewed changes

examples/example-gcp-observability/README.md Outdated Show resolved Hide resolved

sanjaypujare reviewed Mar 20, 2023

View reviewed changes

examples/example-gcp-observability/README.md Outdated Show resolved Hide resolved

sanjaypujare reviewed Mar 20, 2023

View reviewed changes

...ty/src/main/java/io/grpc/examples/observabilityHelloWorld/ObservabilityHelloWorldClient.java Outdated Show resolved Hide resolved

sanjaypujare reviewed Mar 21, 2023

View reviewed changes

...ty/src/main/java/io/grpc/examples/observabilityHelloWorld/ObservabilityHelloWorldClient.java Outdated Show resolved Hide resolved

ejona86 reviewed Mar 21, 2023

View reviewed changes

sanjaypujare reviewed Mar 21, 2023

View reviewed changes

examples/example-gcp-observability/src/main/proto/helloworld/helloworld.proto Show resolved Hide resolved

sanjaypujare reviewed Mar 21, 2023

View reviewed changes

Updated package name and class names; added separate configurations f…

0df5bb8

…or client and server

DNVindhya added 3 commits March 21, 2023 16:28

added observability.close() to be invoked as part of server shutdown

04a70f7

updated package and class names

623273a

remove user-guide link, as the current link does not have setup instr…

bce8a0a

…uctions

ejona86 approved these changes Mar 22, 2023

View reviewed changes

ejona86 added the TODO:release blocker Issue/PR is important enough to delay the release. Removed after release issues resolved label Mar 22, 2023

fengli79 reviewed Mar 22, 2023

View reviewed changes

sanjaypujare reviewed Mar 22, 2023

View reviewed changes

...ty/src/main/resources/io/grpc/examples/gcpobservability/gcp_observability_client_config.json Show resolved Hide resolved

sanjaypujare approved these changes Mar 22, 2023

View reviewed changes

update gRPC GCP observability product name to Microservices Observabi…

48dbdc0

…lity

sanjaypujare merged commit af8048b into grpc:master Mar 23, 2023
5 checks passed

DNVindhya added a commit to DNVindhya/grpc-java that referenced this pull request Mar 23, 2023

examples: add gcp-observability examples (grpc#9967)

0bca9b5

* add examples for gcp-observability

DNVindhya mentioned this pull request Mar 23, 2023

examples: add gcp-observability examples (v1.54.x backport) #9987

Merged

sanjaypujare pushed a commit that referenced this pull request Mar 23, 2023

examples: add gcp-observability examples (v1.54.x backport) (#9987)

fefa2d9

* examples: add gcp-observability examples (#9967)

ejona86 removed the TODO:release blocker Issue/PR is important enough to delay the release. Removed after release issues resolved label Mar 23, 2023

larry-safran pushed a commit to larry-safran/grpc-java that referenced this pull request Mar 23, 2023

examples: add gcp-observability examples (grpc#9967)

c5904cf

* add examples for gcp-observability

DNVindhya deleted the gcp-o11y-examples branch March 24, 2023 20:45

larry-safran pushed a commit to larry-safran/grpc-java that referenced this pull request Mar 29, 2023

examples: add gcp-observability examples (grpc#9967)

7581150

* add examples for gcp-observability

github-actions bot locked as resolved and limited conversation to collaborators Jun 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

examples: add gcp-observability examples #9967

examples: add gcp-observability examples #9967

DNVindhya commented Mar 20, 2023 •

edited

sanjaypujare Mar 20, 2023 •

edited

DNVindhya Mar 20, 2023

sanjaypujare Mar 21, 2023

DNVindhya Mar 21, 2023

sanjaypujare Mar 22, 2023

DNVindhya Mar 22, 2023

sanjaypujare Mar 22, 2023

DNVindhya Mar 22, 2023

ejona86 Mar 21, 2023

DNVindhya Mar 21, 2023

DNVindhya Mar 22, 2023

sanjaypujare left a comment

DNVindhya commented Mar 21, 2023

fengli79 Mar 22, 2023

DNVindhya Mar 22, 2023 •

edited

sanjaypujare Mar 22, 2023

fengli79 Mar 22, 2023

DNVindhya Mar 22, 2023

sanjaypujare left a comment


		The GCP Observability example consists of a Hello World client and a Hello World server instrumented for logs, metrics and tracing.

		__Please refer to GCP observability user guide for setting up authorization to acess Google Cloud Platform with Google user credentials.__

examples: add gcp-observability examples #9967

examples: add gcp-observability examples #9967

Conversation

DNVindhya commented Mar 20, 2023 • edited

sanjaypujare Mar 20, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sanjaypujare left a comment

Choose a reason for hiding this comment

DNVindhya commented Mar 21, 2023

Choose a reason for hiding this comment

DNVindhya Mar 22, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sanjaypujare left a comment

Choose a reason for hiding this comment

DNVindhya commented Mar 20, 2023 •

edited

sanjaypujare Mar 20, 2023 •

edited

DNVindhya Mar 22, 2023 •

edited