|
| 1 | +/* |
| 2 | + * Copyright 2024 The gRPC Authors |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +package io.grpc.codelabs.opentelemetry; |
| 18 | + |
| 19 | +import io.grpc.Channel; |
| 20 | +import io.grpc.Grpc; |
| 21 | +import io.grpc.InsecureChannelCredentials; |
| 22 | +import io.grpc.ManagedChannel; |
| 23 | +import io.grpc.ManagedChannelBuilder; |
| 24 | +import io.grpc.StatusRuntimeException; |
| 25 | +import io.grpc.codelabs.helloworld.GreeterGrpc; |
| 26 | +import io.grpc.codelabs.helloworld.HelloReply; |
| 27 | +import io.grpc.codelabs.helloworld.HelloRequest; |
| 28 | +import io.grpc.opentelemetry.GrpcOpenTelemetry; |
| 29 | +import io.opentelemetry.exporter.prometheus.PrometheusHttpServer; |
| 30 | +import io.opentelemetry.sdk.OpenTelemetrySdk; |
| 31 | +import io.opentelemetry.sdk.metrics.SdkMeterProvider; |
| 32 | +import java.util.concurrent.TimeUnit; |
| 33 | +import java.util.concurrent.atomic.AtomicBoolean; |
| 34 | +import java.util.logging.Level; |
| 35 | +import java.util.logging.Logger; |
| 36 | + |
| 37 | +/** |
| 38 | + * A simple gRPC client that requests a greeting from the {@link HelloWorldServer} and |
| 39 | + * generates gRPC OpenTelmetry metrics data based on the configuration. |
| 40 | + */ |
| 41 | +public class OpenTelemetryClient { |
| 42 | + private static final Logger logger = Logger.getLogger(OpenTelemetryClient.class.getName()); |
| 43 | + |
| 44 | + private final GreeterGrpc.GreeterBlockingStub blockingStub; |
| 45 | + |
| 46 | + /** Construct client for accessing HelloWorld server using the existing channel. */ |
| 47 | + public OpenTelemetryClient(Channel channel) { |
| 48 | + blockingStub = GreeterGrpc.newBlockingStub(channel); |
| 49 | + } |
| 50 | + |
| 51 | + /** Say hello to server. */ |
| 52 | + public void greet(String name) { |
| 53 | + logger.info("Will try to greet " + name + " ..."); |
| 54 | + HelloRequest request = HelloRequest.newBuilder().setName(name).build(); |
| 55 | + HelloReply response; |
| 56 | + try { |
| 57 | + response = blockingStub.sayHello(request); |
| 58 | + } catch (StatusRuntimeException e) { |
| 59 | + logger.log(Level.WARNING, "RPC failed: {0}", e.getStatus()); |
| 60 | + return; |
| 61 | + } |
| 62 | + logger.info("Greeting: " + response.getMessage()); |
| 63 | + } |
| 64 | + |
| 65 | + /** |
| 66 | + * Greet server. If provided, the first element of {@code args} is the name to use in the |
| 67 | + * greeting. The second argument is the target server. |
| 68 | + */ |
| 69 | + public static void main(String[] args) throws Exception { |
| 70 | + String user = "world"; |
| 71 | + // Access a service running on the local machine on port 50051 |
| 72 | + String target = "localhost:50051"; |
| 73 | + // The port on which prometheus metrics are exposed. |
| 74 | + int prometheusPort = 9465; |
| 75 | + AtomicBoolean sendRpcs = new AtomicBoolean(true); |
| 76 | + if (args.length > 0) { |
| 77 | + if ("--help".equals(args[0])) { |
| 78 | + System.err.println("Usage: [name [target [prometheusPort]]]"); |
| 79 | + System.err.println(""); |
| 80 | + System.err.println(" name The name you wish to be greeted by. Defaults to " + user); |
| 81 | + System.err.println(" target The server to connect to. Defaults to " + target); |
| 82 | + System.err.println(" prometheusPort The port to expose prometheus metrics. Defaults to " + prometheusPort); |
| 83 | + System.exit(1); |
| 84 | + } |
| 85 | + user = args[0]; |
| 86 | + } |
| 87 | + if (args.length > 1) { |
| 88 | + target = args[1]; |
| 89 | + } |
| 90 | + if (args.length > 2) { |
| 91 | + prometheusPort = Integer.parseInt(args[2]); |
| 92 | + } |
| 93 | + |
| 94 | + Thread mainThread = Thread.currentThread(); |
| 95 | + |
| 96 | + Runtime.getRuntime().addShutdownHook(new Thread() { |
| 97 | + @Override |
| 98 | + public void run() { |
| 99 | + // Use stderr here since the logger may have been reset by its JVM shutdown hook. |
| 100 | + System.err.println("*** shutting down gRPC client since JVM is shutting down"); |
| 101 | + |
| 102 | + sendRpcs.set(false); |
| 103 | + try { |
| 104 | + mainThread.join(); |
| 105 | + } catch (InterruptedException e) { |
| 106 | + e.printStackTrace(System.err); |
| 107 | + } |
| 108 | + System.err.println("*** client shut down"); |
| 109 | + } |
| 110 | + }); |
| 111 | + |
| 112 | + /////////////////////////////////////////////////////////////////////////// |
| 113 | + // CODELAB SOLUTION : Register GrpcOpenTelemetry. |
| 114 | + /////////////////////////////////////////////////////////////////////////// |
| 115 | + |
| 116 | + // Adds a PrometheusHttpServer to convert OpenTelemetry metrics to Prometheus format and |
| 117 | + // expose these via a HttpServer exporter to the SdkMeterProvider. |
| 118 | + PrometheusHttpServer prometheusExporter = PrometheusHttpServer.builder() |
| 119 | + .setPort(prometheusPort) |
| 120 | + .build(); |
| 121 | + |
| 122 | + SdkMeterProvider sdkMeterProvider = SdkMeterProvider.builder() |
| 123 | + .registerMetricReader(prometheusExporter) |
| 124 | + .build(); |
| 125 | + |
| 126 | + // Initialize OpenTelemetry SDK with MeterProvider configured with Prometeheus. |
| 127 | + OpenTelemetrySdk openTelemetrySdk = |
| 128 | + OpenTelemetrySdk.builder().setMeterProvider(sdkMeterProvider).build(); |
| 129 | + |
| 130 | + // Initialize gRPC OpenTelemetry. |
| 131 | + // Following client metrics are enabled by default : |
| 132 | + // 1. grpc.client.attempt.started |
| 133 | + // 2. grpc.client.attempt.sent_total_compressed_message_size |
| 134 | + // 3. grpc.client.attempt.rcvd_total_compressed_message_size |
| 135 | + // 4. grpc.client.attempt.duration |
| 136 | + // 5. grpc.client.call.duration |
| 137 | + GrpcOpenTelemetry grpcOpenTelmetry = GrpcOpenTelemetry.newBuilder() |
| 138 | + .sdk(openTelemetrySdk) |
| 139 | + .build(); |
| 140 | + // Registers gRPC OpenTelemetry globally. |
| 141 | + grpcOpenTelmetry.registerGlobal(); |
| 142 | + |
| 143 | + // Create a communication channel to the server, known as a Channel. |
| 144 | + ManagedChannel channel = Grpc.newChannelBuilder(target, InsecureChannelCredentials.create()) |
| 145 | + .build(); |
| 146 | + OpenTelemetryClient client = new OpenTelemetryClient(channel); |
| 147 | + |
| 148 | + try { |
| 149 | + // Run RPCs every second. |
| 150 | + while (sendRpcs.get()) { |
| 151 | + client.greet(user); |
| 152 | + // Sleep for a bit before sending the next RPC. |
| 153 | + Thread.sleep(1000); |
| 154 | + } |
| 155 | + } finally { |
| 156 | + channel.shutdownNow().awaitTermination(5, TimeUnit.SECONDS); |
| 157 | + /////////////////////////////////////////////////////////////////////////// |
| 158 | + // CODELAB SOLUTION : Add code to shutdown OpenTelemetry SDK. |
| 159 | + /////////////////////////////////////////////////////////////////////////// |
| 160 | + openTelemetrySdk.close(); |
| 161 | + } |
| 162 | + } |
| 163 | +} |
0 commit comments