forked from grpc/grpc-go
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
1,429 additions
and
306 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
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,92 @@ | ||
| /* | ||
| * | ||
| * 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 csm | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/url" | ||
|
|
||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/internal" | ||
| "google.golang.org/grpc/stats/opentelemetry" | ||
| otelinternal "google.golang.org/grpc/stats/opentelemetry/internal" | ||
| ) | ||
|
|
||
| var clientSideOTelWithCSM grpc.DialOption | ||
| var clientSideOTel grpc.DialOption | ||
|
|
||
| // Observability sets up CSM Observability for the binary globally. It sets up | ||
| // two client side OpenTelemetry instrumentation components configured with the | ||
| // provided options, one with a CSM Plugin Option configured, one without. | ||
| // Created channels will pick up one of these dependent on whether channels are | ||
| // CSM Channels or not, which is derived from the Channel's parsed target after | ||
| // dialing. | ||
| // | ||
| // It sets up a server side OpenTelemetry instrumentation component configured | ||
| // with options provided alongside a CSM Plugin Option to be registered globally | ||
| // and picked up for every server. | ||
| // | ||
| // The CSM Plugin Option is instantiated with local labels and metadata exchange | ||
| // labels pulled from the environment, and emits metadata exchange labels from | ||
| // the peer, local labels, and xDS Labels if provided. Context timeouts does not | ||
| // trigger an error, but sets certain labels to "unknown". | ||
| // | ||
| // This function is not thread safe, and should only be invoked once in main | ||
| // before any channels or servers are created. Returns a cleanup function to be | ||
| // deferred in main. | ||
| func Observability(ctx context.Context, options opentelemetry.Options) func() { | ||
| csmPluginOption := newPluginOption(ctx) // Do this operation in tests now...because this is global to the binary... | ||
| clientSideOTelWithCSM = dialOptionWithCSMPluginOption(options, csmPluginOption) | ||
| clientSideOTel = opentelemetry.DialOption(options) | ||
|
|
||
| serverSideOTelWithCSM := serverOptionWithCSMPluginOption(options, csmPluginOption) | ||
|
|
||
| // internal.AddGlobalLateApplyDialOptions.(func(opt ...LateApplyDialOption))(&testLateApplyDialOption{}) | ||
|
|
||
|
|
||
| internal.AddGlobalServerOptions.(func(opt ...grpc.ServerOption))(serverSideOTelWithCSM) // sets the global - not intended to be used with o11y so we're good here... | ||
|
|
||
| return func() { | ||
| internal.ClearGlobalServerOptions() | ||
| internal.ClearGlobalLateApplyDialOptions() | ||
| } | ||
| } // this won't actually compile unless I rebase | ||
|
|
||
| type lateApplyDialOption interface { // doing this in other PR...although idk how if this will be able to access... | ||
| DialOption(parsedTarget *url.URL) grpc.DialOption | ||
| } | ||
|
|
||
| // Just call this with a pointer... | ||
| // Do I register just this function or do I need to make this on an object... | ||
| func DialOption(parsedTarget *url.URL) grpc.DialOption { | ||
| if determineTargetCSM(parsedTarget) { | ||
| return clientSideOTelWithCSM | ||
| } | ||
| return clientSideOTel | ||
| } | ||
|
|
||
| func dialOptionWithCSMPluginOption(options opentelemetry.Options, po otelinternal.PluginOption) grpc.DialOption { // test at this layer and replace grpc.DialOption in OTel tests... | ||
| otelinternal.SetPluginOption.(func(options opentelemetry.Options, po otelinternal.PluginOption))(options, po) | ||
| return opentelemetry.DialOption(options) | ||
| } | ||
|
|
||
| func serverOptionWithCSMPluginOption(options opentelemetry.Options, po otelinternal.PluginOption) grpc.ServerOption { | ||
| otelinternal.SetPluginOption.(func(options opentelemetry.Options, po otelinternal.PluginOption))(options, po) | ||
| return opentelemetry.ServerOption(options) | ||
| } |
Oops, something went wrong.