gcp/observability: fix End() to cleanup global state correctly #5623
Conversation
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
dfawley
changed the title
dfawley
reviewed
Sep 1, 2022
gcp/observability/observability.go
Outdated
| @@ -80,4 +85,18 @@ func Start(ctx context.Context) error { | |||
| // Note: this method should only be invoked once. | |||
| func End() { | |||
| defaultLogger.Close() | |||
| if exporter != nil { | |||
There was a problem hiding this comment.
Let's create a stopOpenCensus function that does the cleanup needed due to startOpenCensus, and put it right next to it so we can be sure everything pairs up between start/end.
dfawley
changed the title
dfawley
reviewed
Sep 6, 2022
dfawley
reviewed
Sep 6, 2022
gcp/observability/opencensus.go
Outdated
| trace.UnregisterExporter(exporter) | ||
| view.UnregisterExporter(exporter) | ||
|
|
||
| if sdExporter, ok := exporter.(*stackdriver.Exporter); ok { |
There was a problem hiding this comment.
Why not define Flush and Close methods on tracingMetricsExporter instead? Does it make the tests unnecessarily complex?
dfawley
approved these changes
Sep 6, 2022
zasweq
changed the title
This was referenced Sep 7, 2022
# for free
to subscribe to this conversation on GitHub.
Already have an account?
#.
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.
Previously, our metrics and tracing calls would not have the buffer flushed in observability.End(), and also keep the exporters registered globally in another package. Thus, tracing and metrics data would possibly not get uploaded to a backend properly. Also, our tests would break when run more than once due to the trailing exporter.
Fixes #5423, #5558, #5559
RELEASE NOTES: