Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This is a bunch of OTEL initialization code. It's all in `internal/` because there are re-usable parts here, but Compose isn't the right spot. Once we've stabilized the interfaces a bit and the need arises, we can move it to a separate module. Currently, a single span is produced to wrap the root Compose command. Compose will respect the standard OTEL environment variables as well as OTEL metadata from the Docker context. Both can be used simultaneously. The latter is intended for local system integration and is restricted to Unix sockets / named pipes. None of this is enabled by default. It requires setting the `COMPOSE_EXPERIMENTAL_OTEL=1` environment variable to gate it during development. Signed-off-by: Milas Bowman <milas.bowman@docker.com>
- Loading branch information
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
Codecov
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,44 @@ | ||
| //go:build !windows | ||
|
|
||
| /* | ||
| Copyright 2023 Docker Compose CLI 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 tracing | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net" | ||
| "strings" | ||
| "syscall" | ||
| ) | ||
|
|
||
| const maxUnixSocketPathSize = len(syscall.RawSockaddrUnix{}.Path) | ||
|
|
||
| func DialInMemory(ctx context.Context, addr string) (net.Conn, error) { | ||
| if !strings.HasPrefix(addr, "unix://") { | ||
| return nil, fmt.Errorf("not a Unix socket address: %s", addr) | ||
| } | ||
| addr = strings.TrimPrefix(addr, "unix://") | ||
|
|
||
| if len(addr) > maxUnixSocketPathSize { | ||
| //goland:noinspection GoErrorStringFormat | ||
| return nil, fmt.Errorf("Unix socket address is too long: %s", addr) | ||
| } | ||
|
|
||
| var d net.Dialer | ||
| return d.DialContext(ctx, "unix", addr) | ||
| } | ||
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 2023 Docker Compose CLI 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 tracing | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net" | ||
| "strings" | ||
|
|
||
| "github.com/Microsoft/go-winio" | ||
| ) | ||
|
|
||
| func DialInMemory(ctx context.Context, addr string) (net.Conn, error) { | ||
| if !strings.HasPrefix(addr, "npipe://") { | ||
| return nil, fmt.Errorf("not a named pipe address: %s", addr) | ||
| } | ||
| addr = strings.TrimPrefix(addr, "npipe://") | ||
|
|
||
| return winio.DialPipeContext(ctx, addr) | ||
| } |
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,121 @@ | ||
| /* | ||
| Copyright 2023 Docker Compose CLI 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 tracing | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "time" | ||
|
|
||
| "github.com/docker/cli/cli/command" | ||
| "github.com/docker/cli/cli/context/store" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlptrace" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
| ) | ||
|
|
||
| const otelConfigFieldName = "otel" | ||
|
|
||
| // traceClientFromDockerContext creates a gRPC OTLP client based on metadata | ||
| // from the active Docker CLI context. | ||
| func traceClientFromDockerContext(dockerCli command.Cli, otelEnv envMap) (otlptrace.Client, error) { | ||
| // attempt to extract an OTEL config from the Docker context to enable | ||
| // automatic integration with Docker Desktop; | ||
| cfg, err := ConfigFromDockerContext(dockerCli.ContextStore(), dockerCli.CurrentContext()) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("loading otel config from docker context metadata: %v", err) | ||
| } | ||
|
|
||
| if cfg.Endpoint == "" { | ||
| return nil, nil | ||
| } | ||
|
|
||
| // HACK: unfortunately _all_ public OTEL initialization functions | ||
| // implicitly read from the OS env, so temporarily unset them all and | ||
| // restore afterwards | ||
| defer func() { | ||
| for k, v := range otelEnv { | ||
| if err := os.Setenv(k, v); err != nil { | ||
| panic(fmt.Errorf("restoring env for %q: %v", k, err)) | ||
| } | ||
| } | ||
| }() | ||
| for k := range otelEnv { | ||
| if err := os.Unsetenv(k); err != nil { | ||
| return nil, fmt.Errorf("stashing env for %q: %v", k, err) | ||
| } | ||
| } | ||
|
|
||
| dialCtx, cancel := context.WithTimeout(context.Background(), 1*time.Second) | ||
| defer cancel() | ||
| conn, err := grpc.DialContext( | ||
| dialCtx, | ||
| cfg.Endpoint, | ||
| grpc.WithContextDialer(DialInMemory), | ||
| grpc.WithTransportCredentials(insecure.NewCredentials()), | ||
| grpc.WithBlock(), | ||
| ) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("initializing otel connection from docker context metadata: %v", err) | ||
| } | ||
|
|
||
| client := otlptracegrpc.NewClient(otlptracegrpc.WithGRPCConn(conn)) | ||
| return client, nil | ||
| } | ||
|
|
||
| // ConfigFromDockerContext inspects extra metadata included as part of the | ||
| // specified Docker context to try and extract a valid OTLP client configuration. | ||
| func ConfigFromDockerContext(st store.Store, name string) (OTLPConfig, error) { | ||
| meta, err := st.GetMetadata(name) | ||
| if err != nil { | ||
| return OTLPConfig{}, err | ||
| } | ||
|
|
||
| var otelCfg interface{} | ||
| switch m := meta.Metadata.(type) { | ||
| case command.DockerContext: | ||
| otelCfg = m.AdditionalFields[otelConfigFieldName] | ||
| case map[string]interface{}: | ||
| otelCfg = m[otelConfigFieldName] | ||
| } | ||
| otelMap, ok := otelCfg.(map[string]interface{}) | ||
| if !ok { | ||
| return OTLPConfig{}, fmt.Errorf( | ||
| "unexpected type for field %q: %T (expected: %T)", | ||
| otelConfigFieldName, | ||
| otelCfg, | ||
| otelMap, | ||
| ) | ||
| } | ||
|
|
||
| // keys from https://opentelemetry.io/docs/concepts/sdk-configuration/otlp-exporter-configuration/ | ||
| cfg := OTLPConfig{ | ||
| Endpoint: strValue(otelMap, "OTEL_EXPORTER_OTLP_ENDPOINT"), | ||
| } | ||
| return cfg, nil | ||
| } | ||
|
|
||
| // strValue returns the string value at the specified key in the map if present | ||
| // and a string type; otherwise, it returns an empty string. | ||
| func strValue(m map[string]interface{}, key string) string { | ||
| if v, ok := m[key].(string); ok { | ||
| return v | ||
| } | ||
| return "" | ||
| } | ||
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.