-
Notifications
You must be signed in to change notification settings - Fork 967
Fix netty memory leak #12003
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
Merged
Merged
Fix netty memory leak #12003
Changes from all commits
Commits
Show all changes
3 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 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
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
79 changes: 79 additions & 0 deletions
79
...ry/src/main/java/io/opentelemetry/instrumentation/netty/v4_1/internal/ServerContexts.java
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 |
---|---|---|
@@ -0,0 +1,79 @@ | ||
/* | ||
* Copyright The OpenTelemetry Authors | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
package io.opentelemetry.instrumentation.netty.v4_1.internal; | ||
|
||
import io.netty.channel.Channel; | ||
import io.netty.util.Attribute; | ||
import java.util.ArrayDeque; | ||
import java.util.Deque; | ||
|
||
/** | ||
* A helper class for keeping track of incoming requests and spans associated with them. | ||
* | ||
* <p>This class is internal and is hence not for public use. Its APIs are unstable and can change | ||
* at any time. | ||
*/ | ||
public final class ServerContexts { | ||
private static final int PIPELINING_LIMIT = 1000; | ||
// With http pipelining multiple requests can be sent on the same connection. Responses should be | ||
// sent in the same order the requests came in. We use this deque to store the request context | ||
// and pop elements as responses are sent. | ||
private final Deque<ServerContext> serverContexts = new ArrayDeque<>(); | ||
private volatile boolean broken = false; | ||
|
||
private ServerContexts() {} | ||
|
||
public static ServerContexts get(Channel channel) { | ||
return channel.attr(AttributeKeys.SERVER_CONTEXTS).get(); | ||
} | ||
|
||
public static ServerContexts getOrCreate(Channel channel) { | ||
Attribute<ServerContexts> attribute = channel.attr(AttributeKeys.SERVER_CONTEXTS); | ||
ServerContexts result = attribute.get(); | ||
if (result == null) { | ||
result = new ServerContexts(); | ||
attribute.set(result); | ||
} | ||
return result; | ||
} | ||
|
||
public static ServerContext peekFirst(Channel channel) { | ||
ServerContexts serverContexts = get(channel); | ||
return serverContexts != null ? serverContexts.peekFirst() : null; | ||
} | ||
|
||
public ServerContext peekFirst() { | ||
return serverContexts.peekFirst(); | ||
} | ||
|
||
public ServerContext peekLast() { | ||
return serverContexts.peekFirst(); | ||
} | ||
|
||
public ServerContext pollFirst() { | ||
return serverContexts.pollFirst(); | ||
} | ||
|
||
public ServerContext pollLast() { | ||
return serverContexts.pollLast(); | ||
} | ||
|
||
public void addLast(ServerContext context) { | ||
if (broken) { | ||
return; | ||
} | ||
// If the pipelining limit is exceeded we'll stop tracing and mark the channel as broken. | ||
// Exceeding the limit indicates that there is good chance that server context are not removed | ||
// from the deque and there could be a memory leak. This could happen when http server decides | ||
// not to send response to some requests, for example see | ||
// https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/11942 | ||
if (serverContexts.size() > PIPELINING_LIMIT) { | ||
broken = true; | ||
serverContexts.clear(); | ||
} | ||
serverContexts.addLast(context); | ||
} | ||
trask marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
laurit marked this conversation as resolved.
Show resolved
Hide resolved
|
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.