refactor: improve telemetry api receiver listener initialization logic #2096
+43
−26
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -18,11 +18,12 @@ import ( | |
| "context" | ||
| crand "crypto/rand" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "net" | ||
| "net/http" | ||
| "os" | ||
| "strings" | ||
| "sync" | ||
| "time" | ||
|
|
@@ -75,30 +76,52 @@ type telemetryAPIReceiver struct { | |
| logReport bool | ||
| } | ||
|
|
||
| func (r *telemetryAPIReceiver) Start(ctx context.Context, _ component.Host) error { | ||
| if len(r.types) == 0 { | ||
| return fmt.Errorf("no telemetry event types provided") | ||
| } | ||
| listener, address, err := r.bindListener(ctx) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to bind listener: %w", err) | ||
| } | ||
| r.logger.Info("Starting telemetry API listener", zap.String("address", address)) | ||
|
|
||
| mux := http.NewServeMux() | ||
| mux.HandleFunc("/", r.httpHandler) | ||
| r.httpServer = &http.Server{Addr: address, Handler: mux} | ||
| go func() { | ||
| err := r.httpServer.Serve(listener) | ||
| if !errors.Is(err, http.ErrServerClosed) { | ||
| r.logger.Error("Telemetry API server stopped unexpectedly", zap.Error(err)) | ||
| } else { | ||
| r.logger.Info("Telemetry API server stopped", zap.String("address", address)) | ||
| } | ||
| }() | ||
|
|
||
| telemetryClient := telemetryapi.NewClient(r.logger) | ||
| if _, err := telemetryClient.Subscribe(ctx, r.types, r.extensionID, fmt.Sprintf("http://%s/", address)); err != nil { | ||
| r.logger.Error("Failed to subscribe to telemetry", zap.Error(err)) | ||
| _ = r.Shutdown(ctx) | ||
| return err | ||
| } | ||
| r.logger.Info("Successfully subscribed to telemetry", zap.String("address", address)) | ||
| return nil | ||
| } | ||
|
|
||
| func (r *telemetryAPIReceiver) bindListener(ctx context.Context) (net.Listener, string, error) { | ||
| listenerAddr := listenOnAddress() | ||
| var lc net.ListenConfig | ||
| l, err := lc.Listen(ctx, "tcp", fmt.Sprintf("%s:%d", listenerAddr, r.port)) | ||
| if err != nil { | ||
| return nil, "", err | ||
| } | ||
| addr := fmt.Sprintf("%s:%d", l.Addr().Network(), l.Addr().(*net.TCPAddr).Port) | ||
| return l, addr, nil | ||
| } | ||
|
|
||
| func (r *telemetryAPIReceiver) Shutdown(ctx context.Context) error { | ||
| err := r.httpServer.Shutdown(ctx) | ||
| return err | ||
| } | ||
|
Comment on lines
122
to
125
Contributor
There was a problem hiding this comment. Again looking at some "prior art" in internal/telemetryapi/listener.go it looks like just to be safe we might want to also nil check |
||
|
|
||
| func newSpanID() pcommon.SpanID { | ||
|
|
@@ -192,9 +215,6 @@ func (r *telemetryAPIReceiver) httpHandler(w http.ResponseWriter, req *http.Requ | |
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (r *telemetryAPIReceiver) getRecordRequestId(record map[string]interface{}) string { | ||
|
|
@@ -534,14 +554,11 @@ func newTelemetryAPIReceiver( | |
| }, nil | ||
| } | ||
|
|
||
| func listenOnAddress() string { | ||
| envAwsLocal, ok := os.LookupEnv("AWS_SAM_LOCAL") | ||
| if ok && envAwsLocal == "true" { | ||
| return "" | ||
| } else { | ||
| return "sandbox.localdomain" | ||
| } | ||
| } | ||
This file contains hidden or 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.
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.
Looks like
l.Addr().Network()returns the network type string "tcp". So wouldn't this produce an address liketcp:53421instead ofsandbox.localdomain:53421?That would mean the subscribe URI passed to the Telemetry API ends up as http://tcp:53421/, which Lambda wouldn't be able to resolve to deliver events to I think?
For reference, the internal listener at internal/telemetryapi/listener.go uses the
listenerAddrvariable directly for this and I think a lot of the logic we already have there is directly applicable here as well.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.
Good catch, this must have been a typo, or I made this change very late at night. I can update this, and add a test, since I'm surprised this managed to slip through.