-
Notifications
You must be signed in to change notification settings - Fork 332
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(kuma-cp): introduce OpenTelemetry tracing #7153
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
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
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,23 @@ | ||
| package tracing | ||
|
|
||
| type Config struct { | ||
| OpenTelemetry OpenTelemetry `json:"openTelemetry,omitempty"` | ||
| } | ||
|
|
||
| func (c Config) Validate() error { | ||
| if err := c.OpenTelemetry.Validate(); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| type OpenTelemetry struct { | ||
| // Address of OpenTelemetry collector. | ||
| // E.g. otel-collector:4317 | ||
| Endpoint string `json:"endpoint,omitempty" envconfig:"kuma_tracing_opentelemetry_endpoint"` | ||
| } | ||
|
|
||
| func (c OpenTelemetry) Validate() error { | ||
| return nil | ||
| } |
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,113 @@ | ||
| package opentelemetry | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc" | ||
| "go.opentelemetry.io/otel/propagation" | ||
| "go.opentelemetry.io/otel/sdk/resource" | ||
| "go.opentelemetry.io/otel/sdk/trace" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
|
|
||
| "github.com/kumahq/kuma/pkg/config/tracing" | ||
| "github.com/kumahq/kuma/pkg/core" | ||
| core_plugins "github.com/kumahq/kuma/pkg/core/plugins" | ||
| core_runtime "github.com/kumahq/kuma/pkg/core/runtime" | ||
| "github.com/kumahq/kuma/pkg/core/runtime/component" | ||
| ) | ||
|
|
||
| func init() { | ||
| core_plugins.Register("tracing.opentelemetry", &plugin{}) | ||
| } | ||
|
|
||
| var log = core.Log.WithName("tracing").WithName("opentelemetry") | ||
|
|
||
| type plugin struct{} | ||
|
|
||
| var _ core_plugins.RuntimePlugin = &plugin{} | ||
|
|
||
| type tracer struct { | ||
| config tracing.OpenTelemetry | ||
| } | ||
|
|
||
| var _ component.Component = &tracer{} | ||
|
|
||
| func (t *tracer) Start(stop <-chan struct{}) error { | ||
| shutdown, err := initOtel(context.Background(), t.config) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| go func() { | ||
| <-stop | ||
| log.Info("stopping") | ||
| if err := shutdown(context.Background()); err != nil { | ||
| log.Error(err, "shutting down") | ||
| } | ||
| }() | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (t *tracer) NeedLeaderElection() bool { | ||
| return false | ||
| } | ||
|
|
||
| func (p *plugin) Customize(rt core_runtime.Runtime) error { | ||
| otel := rt.Config().Tracing.OpenTelemetry | ||
| if otel.Endpoint == "" { | ||
| return nil | ||
| } | ||
|
|
||
| t := tracer{ | ||
| config: otel, | ||
| } | ||
| if err := rt.Add(component.NewResilientComponent(core.Log.WithName("otel-tracer"), &t)); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func initOtel(ctx context.Context, otelConfig tracing.OpenTelemetry) (func(context.Context) error, error) { | ||
| res, err := resource.New(ctx) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create resource: %w", err) | ||
| } | ||
|
|
||
| ctx, cancel := context.WithTimeout(ctx, time.Second) | ||
| defer cancel() | ||
|
|
||
| conn, err := grpc.DialContext( | ||
| ctx, | ||
| otelConfig.Endpoint, | ||
| grpc.WithTransportCredentials( | ||
| insecure.NewCredentials(), | ||
| ), | ||
| ) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create gRPC connection to collector: %w", err) | ||
| } | ||
|
|
||
| traceExporter, err := otlptracegrpc.New(ctx, otlptracegrpc.WithGRPCConn(conn)) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("failed to create trace exporter: %w", err) | ||
| } | ||
|
|
||
| bsp := trace.NewBatchSpanProcessor(traceExporter) | ||
|
|
||
| tracerProvider := trace.NewTracerProvider( | ||
| trace.WithSampler(trace.AlwaysSample()), | ||
| trace.WithResource(res), | ||
| trace.WithSpanProcessor(bsp), | ||
| ) | ||
| otel.SetTracerProvider(tracerProvider) | ||
|
|
||
| otel.SetTextMapPropagator(propagation.TraceContext{}) | ||
|
|
||
| return tracerProvider.Shutdown, nil | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this need to be configurable?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah we need to add this in another PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@michaelbeaumont - do we have an issue for that?