Exclude attributes from Endpoint.toString()
#6061
Open
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
Motivation:
We observed `OutOfMemoryError` in internal CI tests when
a new `Endpoint` is created.
```
com.linecorp.armeria.xds.client.endpoint.EndpointsPool$$Lambda$754/1708334230@3a58f44e
java.lang.OutOfMemoryError: Java heap space
at java.util.Arrays.copyOfRange(Arrays.java:3664)
at java.lang.String.<init>(String.java:207)
at java.lang.StringBuilder.toString(StringBuilder.java:412)
at com.google.protobuf.TextFormat$Printer.printToString(TextFormat.java:593)
at com.google.protobuf.AbstractMessage.toString(AbstractMessage.java:87)
at java.lang.String.valueOf(String.java:2994)
at java.lang.StringBuilder.append(StringBuilder.java:136)
at com.linecorp.armeria.internal.shaded.guava.collect.AbstractMapEntry.toString(AbstractMapEntry.java:70)
at java.lang.String.valueOf(String.java:2994)
at java.lang.StringBuilder.append(StringBuilder.java:136)
at com.linecorp.armeria.internal.shaded.guava.collect.Iterators.toString(Iterators.java:294)
at com.linecorp.armeria.common.ImmutableAttributes.toString(ImmutableAttributes.java:183)
at java.lang.String.valueOf(String.java:2994)
at java.lang.StringBuilder.append(StringBuilder.java:136)
at com.linecorp.armeria.client.Endpoint.generateToString(Endpoint.java:304)
at com.linecorp.armeria.client.Endpoint.<init>(Endpoint.java:268)
at com.linecorp.armeria.client.Endpoint.replaceAttrs(Endpoint.java:747)
at com.linecorp.armeria.client.Endpoint.withAttr(Endpoint.java:707)
at com.linecorp.armeria.xds.client.endpoint.EndpointsPool.withTimestamp(EndpointsPool.java:103)
at com.linecorp.armeria.xds.client.endpoint.EndpointsPool.cacheAttributesAndDelegate(EndpointsPool.java:71)
at com.linecorp.armeria.xds.client.endpoint.EndpointsPool.lambda$updateClusterSnapshot$1(EndpointsPool.java:62)
at com.linecorp.armeria.xds.client.endpoint.EndpointsPool$$Lambda$754/1708334230.run(Unknown Source)
```
When an `Endpoint` is initicated, it pre-generates a string
representation for caching and reuse. In our tests, it contained many
attributes related to xDS for service discovery.
It might be a good idea to remove attributes whose size is hard to
predict from `toString()` and prevent unintended OOM.
In addition, the result size of `toString()` gets small, I doubt that
the pre-generated cache is useful for performance.
Modifications:
- Remove attributes from `toString()`.
- Lazily build the string representation when `toString()` is called and
don't cache the result.
Result:
`Endpoint` no longer include attributes in `.toString()`.
jrhee17
approved these changes
Jan 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation:
We observed
OutOfMemoryErrorin internal CI tests when a newEndpointis created.When an
Endpointis initicated, it pre-generates a string representation for caching and reuse. In our tests, it contained many attributes related to xDS for service discovery. It might be a good idea to remove attributes whose size is hard to predict fromtoString()and prevent unintended OOM.In addition, the result size of
toString()gets small, so I doubt that the pre-generated cache is useful for performance.Modifications:
toString().toString()is called and don't cache the result.Result:
Endpointno longer includes attributes in.toString().