Skip to content

Fix NPE in APMTracer through RestController #128314

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.

Sign up for GitHub

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 2 commits into from
May 23, 2025
Merged

Fix NPE in APMTracer through RestController #128314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95ccfd9
Protect against NPE on attributes; better error message in case of nulls
ldematte May 22, 2025
a77c72c
Update docs/changelog/128314.yaml
ldematte May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/changelog/128314.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
pr: 128314
summary: Fix NPE in APMTracer through `RestController`
area: Infra/REST API
type: bug
issues: []
2 changes: 2 additions & 0 deletions modules/apm/src/main/java/org/elasticsearch/telemetry/apm/internal/tracing/APMTracer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,8 @@ private void setSpanAttributes(@Nullable Map<String, Object> spanAttributes, Spa
spanBuilder.setAttribute(key, (Double) value);
} else if (value instanceof Boolean) {
spanBuilder.setAttribute(key, (Boolean) value);
} else if (value == null) {
throw new IllegalArgumentException("span attributes cannot have a null value");
} else {
throw new IllegalArgumentException(
"span attributes do not support value type of [" + value.getClass().getCanonicalName() + "]"
Expand Down
7 changes: 4 additions & 3 deletions server/src/main/java/org/elasticsearch/rest/RestController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;
Expand Down Expand Up @@ -560,10 +561,10 @@ private void startTrace(ThreadContext threadContext, RestChannel channel, String
final Map<String, Object> attributes = Maps.newMapWithExpectedSize(req.getHeaders().size() + 3);
req.getHeaders().forEach((key, values) -> {
final String lowerKey = key.toLowerCase(Locale.ROOT).replace('-', '_');
attributes.put("http.request.headers." + lowerKey, values.size() == 1 ? values.get(0) : String.join("; ", values));
attributes.put("http.request.headers." + lowerKey, values == null ? "" : String.join("; ", values));
Copy link
Member

@rjernst rjernst May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How did we get a null in the first place? If the header was passed but empty wouldn't it be an empty string?

Copy link
Contributor Author

@ldematte ldematte May 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is a possibility for the map to contain a key mapping to a null list; we wrap headers from netty HttpHeaders in Netty4HttpRequest like this:

// Map.get() implementation
public List<String> get(Object key) {
    return key instanceof String ? httpHeaders.getAll((String) key) : null;
}

It's probably remote, but I decided to err on the safe side.

(To be precise, we did not get a null here, the null was in the http.method attribute, but I wanted to be sure this was not possible elsewhere too)

});
attributes.put("http.method", method);
attributes.put("http.url", req.uri());
attributes.put("http.method", Objects.requireNonNullElse(method, "<unknown>"));
attributes.put("http.url", Objects.requireNonNullElse(req.uri(), "<unknown>"));
switch (req.getHttpRequest().protocolVersion()) {
case HTTP_1_0 -> attributes.put("http.flavour", "1.0");
case HTTP_1_1 -> attributes.put("http.flavour", "1.1");
Expand Down
Loading