diff --git a/.chloggen/goleak_remotetap.yaml b/.chloggen/goleak_remotetap.yaml new file mode 100644 index 000000000000..daab888e6d3f --- /dev/null +++ b/.chloggen/goleak_remotetap.yaml @@ -0,0 +1,27 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: bug_fix + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: remotetapprocessor + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Fix memory leak on shutdown + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [32571] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: + +# If your change doesn't affect end users or the exported elements of any package, +# you should instead start your pull request title with [chore] or use the "Skip Changelog" label. +# Optional: The change log or logs in which this entry should be included. +# e.g. '[user]' or '[user, api]' +# Include 'user' if the change is relevant to end users. +# Include 'api' if there is a change to a library API. +# Default: '[user]' +change_logs: [] diff --git a/processor/remotetapprocessor/channelset.go b/processor/remotetapprocessor/channelset.go index 4314514ae3fb..9181d8cca30b 100644 --- a/processor/remotetapprocessor/channelset.go +++ b/processor/remotetapprocessor/channelset.go @@ -48,3 +48,22 @@ func (c *channelSet) closeAndRemove(key int) { delete(c.chanmap, key) c.mu.Unlock() } + +func (c *channelSet) shutdown() { + c.mu.Lock() + defer c.mu.Unlock() + + // Get all keys before deletion, so the map is not + // being modified while iterating. + keys := make([]int, len(c.chanmap)) + i := 0 + for key := range c.chanmap { + keys[i] = key + i++ + } + + for key := range keys { + close(c.chanmap[key]) + delete(c.chanmap, key) + } +} diff --git a/processor/remotetapprocessor/generated_package_test.go b/processor/remotetapprocessor/generated_package_test.go index 673077d15f09..38f6ce1fe320 100644 --- a/processor/remotetapprocessor/generated_package_test.go +++ b/processor/remotetapprocessor/generated_package_test.go @@ -4,8 +4,10 @@ package remotetapprocessor import ( "testing" + + "go.uber.org/goleak" ) func TestMain(m *testing.M) { - // skipping goleak test as per metadata.yml configuration + goleak.VerifyTestMain(m) } diff --git a/processor/remotetapprocessor/go.mod b/processor/remotetapprocessor/go.mod index b5bd34acf056..b00f8f00c317 100644 --- a/processor/remotetapprocessor/go.mod +++ b/processor/remotetapprocessor/go.mod @@ -14,6 +14,7 @@ require ( go.opentelemetry.io/collector/processor v0.99.0 go.opentelemetry.io/otel/metric v1.25.0 go.opentelemetry.io/otel/trace v1.25.0 + go.uber.org/goleak v1.3.0 go.uber.org/zap v1.27.0 golang.org/x/net v0.24.0 golang.org/x/time v0.5.0 diff --git a/processor/remotetapprocessor/metadata.yaml b/processor/remotetapprocessor/metadata.yaml index 1488c43eca59..33ac255ceb5b 100644 --- a/processor/remotetapprocessor/metadata.yaml +++ b/processor/remotetapprocessor/metadata.yaml @@ -12,5 +12,3 @@ status: tests: config: - goleak: - skip: true diff --git a/processor/remotetapprocessor/processor.go b/processor/remotetapprocessor/processor.go index 4607394a133e..23de9beeebd0 100644 --- a/processor/remotetapprocessor/processor.go +++ b/processor/remotetapprocessor/processor.go @@ -81,11 +81,20 @@ func (w *wsprocessor) handleConn(conn *websocket.Conn) { } func (w *wsprocessor) Shutdown(ctx context.Context) error { + var err error + if w.server != nil { - err := w.server.Shutdown(ctx) - return err + err = w.server.Shutdown(ctx) + w.shutdownWG.Wait() } - return nil + + // The processor's channelset is only modified by its server, so once + // it's completely shutdown it's safe to shutdown the channelset itself. + if w.cs != nil { + w.cs.shutdown() + } + + return err } func (w *wsprocessor) ConsumeMetrics(_ context.Context, md pmetric.Metrics) (pmetric.Metrics, error) {