Skip to content

Avoid Metadata.key allocations on grpc #11351

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
gh-worker-dd-mergequeue-cf854d merged 1 commit into from
May 13, 2026
Merged

Avoid Metadata.key allocations on grpc #11351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion ...84/src/main/java/datadog/trace/instrumentation/armeria/grpc/client/GrpcInjectAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
package datadog.trace.instrumentation.armeria.grpc.client;

import datadog.context.propagation.CarrierSetter;
import datadog.trace.api.cache.DDCache;
import datadog.trace.api.cache.DDCaches;
import io.grpc.Metadata;
import java.util.function.Function;
import javax.annotation.ParametersAreNonnullByDefault;

@ParametersAreNonnullByDefault
public final class GrpcInjectAdapter implements CarrierSetter<Metadata> {
private static final Function<String, Metadata.Key<String>> KEY_MAKER =
key -> Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
private static final DDCache<String, Metadata.Key<String>> KEY_CACHE =
DDCaches.newFixedSizeCache(64);

public static final GrpcInjectAdapter SETTER = new GrpcInjectAdapter();

@Override
public void set(final Metadata carrier, final String key, final String value) {
Metadata.Key<String> metadataKey = Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
Metadata.Key<String> metadataKey = KEY_CACHE.computeIfAbsent(key, KEY_MAKER);
if (carrier.containsKey(metadataKey)) {
carrier.removeAll(
metadataKey); // Remove existing to ensure identical behavior with other carriers
Expand Down
10 changes: 8 additions & 2 deletions ...4/src/main/java/datadog/trace/instrumentation/armeria/grpc/server/GrpcExtractAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
package datadog.trace.instrumentation.armeria.grpc.server;

import datadog.trace.api.cache.DDCache;
import datadog.trace.api.cache.DDCaches;
import datadog.trace.bootstrap.instrumentation.api.AgentPropagation;
import io.grpc.Metadata;
import java.util.function.Function;

public final class GrpcExtractAdapter implements AgentPropagation.ContextVisitor<Metadata> {
private static final Function<String, Metadata.Key<String>> KEY_MAKER =
key -> Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
private static final DDCache<String, Metadata.Key<String>> KEY_CACHE =
DDCaches.newFixedSizeCache(64);

public static final GrpcExtractAdapter GETTER = new GrpcExtractAdapter();

@Override
public void forEachKey(Metadata carrier, AgentPropagation.KeyClassifier classifier) {
for (String key : carrier.keys()) {
if (!key.endsWith(Metadata.BINARY_HEADER_SUFFIX) && !key.startsWith(":")) {
if (!classifier.accept(
key, carrier.get(Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER)))) {
if (!classifier.accept(key, carrier.get(KEY_CACHE.computeIfAbsent(key, KEY_MAKER)))) {
return;
}
}
Expand Down
8 changes: 7 additions & 1 deletion ...main/java/datadog/trace/instrumentation/armeria/grpc/server/TracingServerInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
import static datadog.trace.instrumentation.armeria.grpc.server.GrpcServerDecorator.SERVER_PATHWAY_EDGE_TAGS;

import datadog.trace.api.Config;
import datadog.trace.api.cache.DDCache;
import datadog.trace.api.cache.DDCaches;
import datadog.trace.api.function.TriConsumer;
import datadog.trace.api.function.TriFunction;
import datadog.trace.api.gateway.CallbackProvider;
Expand Down Expand Up @@ -43,6 +45,10 @@
import javax.annotation.Nonnull;

public class TracingServerInterceptor implements ServerInterceptor {
private static final Function<String, Metadata.Key<String>> KEY_MAKER =
key -> Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
private static final DDCache<String, Metadata.Key<String>> KEY_CACHE =
DDCaches.newFixedSizeCache(64);

public static final TracingServerInterceptor INSTANCE = new TracingServerInterceptor();
private static final Set<String> IGNORED_METHODS = Config.get().getGrpcIgnoredInboundMethods();
Expand Down Expand Up @@ -294,7 +300,7 @@ private static void callIGCallbackHeaders(
}
for (String key : metadata.keys()) {
if (!key.endsWith(Metadata.BINARY_HEADER_SUFFIX) && !key.startsWith(":")) {
Metadata.Key<String> mdKey = Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
Metadata.Key<String> mdKey = KEY_CACHE.computeIfAbsent(key, KEY_MAKER);
for (String value : metadata.getAll(mdKey)) {
headerCb.accept(reqCtx, key, value);
}
Expand Down
10 changes: 9 additions & 1 deletion ...n/grpc-1.5/src/main/java/datadog/trace/instrumentation/grpc/client/GrpcInjectAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
package datadog.trace.instrumentation.grpc.client;

import datadog.context.propagation.CarrierSetter;
import datadog.trace.api.cache.DDCache;
import datadog.trace.api.cache.DDCaches;
import io.grpc.Metadata;
import java.util.function.Function;
import javax.annotation.ParametersAreNonnullByDefault;

@ParametersAreNonnullByDefault
public final class GrpcInjectAdapter implements CarrierSetter<Metadata> {
private static final Function<String, Metadata.Key<String>> KEY_MAKER =
key -> Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
private static final DDCache<String, Metadata.Key<String>> KEY_CACHE =
DDCaches.newFixedSizeCache(64);

public static final GrpcInjectAdapter SETTER = new GrpcInjectAdapter();

@Override
public void set(final Metadata carrier, final String key, final String value) {
Metadata.Key<String> metadataKey = Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
Metadata.Key<String> metadataKey = KEY_CACHE.computeIfAbsent(key, KEY_MAKER);
if (carrier.containsKey(metadataKey)) {
carrier.removeAll(
metadataKey); // Remove existing to ensure identical behavior with other carriers
Expand Down
10 changes: 8 additions & 2 deletions .../grpc-1.5/src/main/java/datadog/trace/instrumentation/grpc/server/GrpcExtractAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
package datadog.trace.instrumentation.grpc.server;

import datadog.trace.api.cache.DDCache;
import datadog.trace.api.cache.DDCaches;
import datadog.trace.bootstrap.instrumentation.api.AgentPropagation;
import io.grpc.Metadata;
import java.util.function.Function;

public final class GrpcExtractAdapter implements AgentPropagation.ContextVisitor<Metadata> {
private static final Function<String, Metadata.Key<String>> KEY_MAKER =
key -> Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
private static final DDCache<String, Metadata.Key<String>> KEY_CACHE =
DDCaches.newFixedSizeCache(64);

public static final GrpcExtractAdapter GETTER = new GrpcExtractAdapter();

@Override
public void forEachKey(Metadata carrier, AgentPropagation.KeyClassifier classifier) {
for (String key : carrier.keys()) {
if (!key.endsWith(Metadata.BINARY_HEADER_SUFFIX)) {
if (!classifier.accept(
key, carrier.get(Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER)))) {
if (!classifier.accept(key, carrier.get(KEY_CACHE.computeIfAbsent(key, KEY_MAKER)))) {
return;
}
}
Expand Down
8 changes: 7 additions & 1 deletion ...1.5/src/main/java/datadog/trace/instrumentation/grpc/server/TracingServerInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
import static datadog.trace.instrumentation.grpc.server.GrpcServerDecorator.SERVER_PATHWAY_EDGE_TAGS;

import datadog.trace.api.Config;
import datadog.trace.api.cache.DDCache;
import datadog.trace.api.cache.DDCaches;
import datadog.trace.api.function.TriConsumer;
import datadog.trace.api.function.TriFunction;
import datadog.trace.api.gateway.CallbackProvider;
Expand Down Expand Up @@ -44,6 +46,10 @@
import javax.annotation.Nonnull;

public class TracingServerInterceptor implements ServerInterceptor {
private static final Function<String, Metadata.Key<String>> KEY_MAKER =
key -> Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
private static final DDCache<String, Metadata.Key<String>> KEY_CACHE =
DDCaches.newFixedSizeCache(64);

public static final TracingServerInterceptor INSTANCE = new TracingServerInterceptor();
private static final Set<String> IGNORED_METHODS = Config.get().getGrpcIgnoredInboundMethods();
Expand Down Expand Up @@ -295,7 +301,7 @@ private static void callIGCallbackHeaders(
}
for (String key : metadata.keys()) {
if (!key.endsWith(Metadata.BINARY_HEADER_SUFFIX)) {
Metadata.Key<String> mdKey = Metadata.Key.of(key, Metadata.ASCII_STRING_MARSHALLER);
Metadata.Key<String> mdKey = KEY_CACHE.computeIfAbsent(key, KEY_MAKER);
for (String value : metadata.getAll(mdKey)) {
headerCb.accept(reqCtx, key, value);
}
Expand Down
Loading