-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
examples: Add CSM Observability example (#7302)
- Loading branch information
Showing
7 changed files
with
303 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # CSM Observability | ||
|
|
||
| This examples shows how to configure CSM Observability for gRPC client and | ||
| server applications (configured once per binary), and shows what type of | ||
| telemetry data it can produce for certain RPCs with additional CSM Labels. The | ||
| gRPC Client accepts configuration from an xDS Control plane as the default | ||
| address that it connects to is "xds:///helloworld:50051", but this can be | ||
| overridden with the command line flag --server_addr. This can be plugged into | ||
| the steps outlined in the CSM Observability User Guide. | ||
|
|
||
| ## Try it (locally if overwritten xDS Address) | ||
|
|
||
| ``` | ||
| go run server/main.go | ||
| ``` | ||
|
|
||
| ``` | ||
| go run client/main.go | ||
| ``` | ||
|
|
||
| Curl to the port where Prometheus exporter is outputting metrics data: | ||
| ``` | ||
| curl localhost:9464/metrics | ||
| ``` | ||
|
|
||
| # Building | ||
| From the grpc-go directory: | ||
|
|
||
| Client: | ||
| docker build -t <TAG> -f examples/features/csm_observability/client/Dockerfile . | ||
|
|
||
| Server: | ||
| docker build -t <TAG> -f examples/features/csm_observability/server/Dockerfile . | ||
|
|
||
| Note that this example will not work by default, as the client uses an xDS | ||
| Scheme and thus needs xDS Resources to connect to the server. Deploy the built | ||
| client and server containers within Cloud Service Mesh in order for this example | ||
| to work, or overwrite target to point to :<server serving port>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Copyright 2024 gRPC authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # Dockerfile for building the example client. To build the image, run the | ||
| # following command from grpc-go directory: | ||
| # docker build -t <TAG> -f examples/features/csm_observability/client/Dockerfile . | ||
| FROM golang:1.21-alpine as build | ||
|
|
||
| RUN apk --no-cache add curl | ||
|
|
||
| # Make a grpc-go directory and copy the repo into it. | ||
| WORKDIR /go/src/grpc-go | ||
| COPY . . | ||
|
|
||
| # Build a static binary without cgo so that we can copy just the binary in the | ||
| # final image, and can get rid of the Go compiler and gRPC-Go dependencies. | ||
| RUN cd examples/features/csm_observability/client && go build -tags osusergo,netgo . | ||
|
|
||
| FROM alpine | ||
| RUN apk --no-cache add curl | ||
| COPY --from=build /go/src/grpc-go/examples/features/csm_observability/client/client . | ||
| ENV GRPC_GO_LOG_VERBOSITY_LEVEL=99 | ||
| ENV GRPC_GO_LOG_SEVERITY_LEVEL="info" | ||
| ENTRYPOINT ["./client"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /* | ||
| * | ||
| * Copyright 2024 gRPC authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "flag" | ||
| "fmt" | ||
| "log" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
| "google.golang.org/grpc/examples/features/proto/echo" | ||
| "google.golang.org/grpc/stats/opentelemetry" | ||
| "google.golang.org/grpc/stats/opentelemetry/csm" | ||
| _ "google.golang.org/grpc/xds" // To install the xds resolvers and balancers. | ||
|
|
||
| "github.com/prometheus/client_golang/prometheus/promhttp" | ||
| "go.opentelemetry.io/otel/exporters/prometheus" | ||
| "go.opentelemetry.io/otel/sdk/metric" | ||
| ) | ||
|
|
||
| var ( | ||
| target = flag.String("target", "xds:///helloworld:50051", "the server address to connect to") | ||
| prometheusEndpoint = flag.String("prometheus_endpoint", ":9464", "the Prometheus exporter endpoint") | ||
| ) | ||
|
|
||
| func main() { | ||
| flag.Parse() | ||
| exporter, err := prometheus.New() | ||
| if err != nil { | ||
| log.Fatalf("Failed to start prometheus exporter: %v", err) | ||
| } | ||
| provider := metric.NewMeterProvider(metric.WithReader(exporter)) | ||
| go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler()) | ||
|
|
||
| cleanup := csm.EnableObservability(context.Background(), opentelemetry.Options{MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: provider}}) | ||
| defer cleanup() | ||
|
|
||
| cc, err := grpc.NewClient(*target, grpc.WithTransportCredentials(insecure.NewCredentials())) | ||
| if err != nil { | ||
| log.Fatalf("Failed to start NewClient: %v", err) | ||
| } | ||
| defer cc.Close() | ||
| c := echo.NewEchoClient(cc) | ||
|
|
||
| // Make a RPC every second. This should trigger telemetry to be emitted from | ||
| // the client and the server. | ||
| for { | ||
| ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) | ||
| r, err := c.UnaryEcho(ctx, &echo.EchoRequest{Message: "this is examples/opentelemetry"}) | ||
| if err != nil { | ||
| log.Printf("UnaryEcho failed: %v", err) | ||
| } | ||
| fmt.Println(r) | ||
| time.Sleep(time.Second) | ||
| cancel() | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Copyright 2024 gRPC authors. | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # Dockerfile for building the example server. To build the image, run the | ||
| # following command from grpc-go directory: | ||
| # docker build -t <TAG> -f examples/features/csm_observability/server/Dockerfile . | ||
|
|
||
| FROM golang:1.21-alpine as build | ||
| RUN apk --no-cache add curl | ||
| # Make a grpc-go directory and copy the repo into it. | ||
| WORKDIR /go/src/grpc-go | ||
| COPY . . | ||
|
|
||
| # Build a static binary without cgo so that we can copy just the binary in the | ||
| # final image, and can get rid of the Go compiler and gRPC-Go dependencies. | ||
| RUN cd examples/features/csm_observability/server && go build -tags osusergo,netgo . | ||
|
|
||
| FROM alpine | ||
| RUN apk --no-cache add curl | ||
| COPY --from=build /go/src/grpc-go/examples/features/csm_observability/server/server . | ||
| ENV GRPC_GO_LOG_VERBOSITY_LEVEL=99 | ||
| ENV GRPC_GO_LOG_SEVERITY_LEVEL="info" | ||
| ENTRYPOINT ["./server"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /* | ||
| * | ||
| * Copyright 2024 gRPC authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "flag" | ||
| "fmt" | ||
| "log" | ||
| "net" | ||
| "net/http" | ||
|
|
||
| "google.golang.org/grpc" | ||
| pb "google.golang.org/grpc/examples/features/proto/echo" | ||
| "google.golang.org/grpc/stats/opentelemetry" | ||
| "google.golang.org/grpc/stats/opentelemetry/csm" | ||
|
|
||
| "github.com/prometheus/client_golang/prometheus/promhttp" | ||
| "go.opentelemetry.io/otel/exporters/prometheus" | ||
| "go.opentelemetry.io/otel/sdk/metric" | ||
| ) | ||
|
|
||
| var ( | ||
| port = flag.String("port", "50051", "the server address to connect to") | ||
| prometheusEndpoint = flag.String("prometheus_endpoint", ":9464", "the Prometheus exporter endpoint") | ||
| ) | ||
|
|
||
| type echoServer struct { | ||
| pb.UnimplementedEchoServer | ||
| addr string | ||
| } | ||
|
|
||
| func (s *echoServer) UnaryEcho(ctx context.Context, req *pb.EchoRequest) (*pb.EchoResponse, error) { | ||
| return &pb.EchoResponse{Message: fmt.Sprintf("%s (from %s)", req.Message, s.addr)}, nil | ||
| } | ||
|
|
||
| func main() { | ||
| flag.Parse() | ||
| exporter, err := prometheus.New() | ||
| if err != nil { | ||
| log.Fatalf("Failed to start prometheus exporter: %v", err) | ||
| } | ||
| provider := metric.NewMeterProvider(metric.WithReader(exporter)) | ||
| go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler()) | ||
|
|
||
| cleanup := csm.EnableObservability(context.Background(), opentelemetry.Options{MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: provider}}) | ||
| defer cleanup() | ||
|
|
||
| lis, err := net.Listen("tcp", ":"+*port) | ||
| if err != nil { | ||
| log.Fatalf("Failed to listen: %v", err) | ||
| } | ||
| s := grpc.NewServer() | ||
| pb.RegisterEchoServer(s, &echoServer{addr: ":" + *port}) | ||
|
|
||
| log.Printf("Serving on %s\n", *port) | ||
|
|
||
| if err := s.Serve(lis); err != nil { | ||
| log.Fatalf("Failed to serve: %v", err) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.