Skip to content
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

feat: allow to add attributes from grpc metadata in the patched server #3589

2 changes: 2 additions & 0 deletions experimental/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ All notable changes to experimental packages in this project will be documented

### :rocket: (Enhancement)

- feat(opentelemetry-instrumentation-grpc): allow to add attributes from grpc metadata in the patched server #3589 @zombispormedio

### :bug: (Bug Fix)

### :books: (Refine Doc)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,24 @@ export class GrpcJsInstrumentation extends InstrumentationBase {
[SemanticAttributes.RPC_SERVICE]: service,
});

instrumentation._metadataCapture.server.captureRequestMetadata(
span,
call.metadata
);

instrumentation._wrap(
call,
'sendMetadata',
originalSendMetadata =>
(responseMetadata: grpcJs.Metadata) => {
instrumentation._metadataCapture.server.captureResponseMetadata(
span,
responseMetadata
);
originalSendMetadata.call(call, responseMetadata);
}
);

context.with(trace.setSpan(context.active(), span), () => {
handleServerFunction.call(
self,
Expand Down Expand Up @@ -385,6 +403,16 @@ export class GrpcJsInstrumentation extends InstrumentationBase {
config.metadataToSpanAttributes?.client?.responseMetadata ?? []
),
},
server: {
captureRequestMetadata: metadataCapture(
'request',
config.metadataToSpanAttributes?.server?.requestMetadata ?? []
),
captureResponseMetadata: metadataCapture(
'response',
config.metadataToSpanAttributes?.server?.responseMetadata ?? []
),
},
};
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,24 @@ export class GrpcNativeInstrumentation extends InstrumentationBase<
[SemanticAttributes.RPC_SERVICE]: service,
});

instrumentation._metadataCapture.server.captureRequestMetadata(
span,
call.metadata
);

instrumentation._wrap(
call as any,
'sendMetadata',
originalSendMetadata =>
(responseMetadata: grpcTypes.Metadata) => {
instrumentation._metadataCapture.server.captureResponseMetadata(
span,
responseMetadata
);
originalSendMetadata.call(call, responseMetadata);
}
);

context.with(trace.setSpan(context.active(), span), () => {
switch (type) {
case 'unary':
Expand Down Expand Up @@ -370,6 +388,16 @@ export class GrpcNativeInstrumentation extends InstrumentationBase<
config.metadataToSpanAttributes?.client?.responseMetadata ?? []
),
},
server: {
captureRequestMetadata: metadataCapture(
'request',
config.metadataToSpanAttributes?.server?.requestMetadata ?? []
),
captureResponseMetadata: metadataCapture(
'response',
config.metadataToSpanAttributes?.server?.responseMetadata ?? []
),
},
};
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,14 @@ export type metadataCaptureType = {
metadata: grpcJsTypes.Metadata | grpcTypes.Metadata
) => void;
};
server: {
captureRequestMetadata: (
span: Span,
metadata: grpcJsTypes.Metadata | grpcTypes.Metadata
) => void;
captureResponseMetadata: (
span: Span,
metadata: grpcJsTypes.Metadata | grpcTypes.Metadata
) => void;
};
};
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,9 @@ export interface GrpcInstrumentationConfig extends InstrumentationConfig {
responseMetadata?: string[];
requestMetadata?: string[];
};
server?: {
dyladan marked this conversation as resolved.
Show resolved Hide resolved
responseMetadata?: string[];
requestMetadata?: string[];
};
};
}
Original file line number Diff line number Diff line change
Expand Up @@ -978,6 +978,10 @@ export const runTests = (
requestMetadata: ['client_metadata_key'],
responseMetadata: ['server_metadata_key'],
},
server: {
requestMetadata: ['client_metadata_key'],
responseMetadata: ['server_metadata_key'],
},
},
});

Expand Down Expand Up @@ -1006,6 +1010,11 @@ export const runTests = (
'rpc.response.metadata.server_metadata_key':
dyladan marked this conversation as resolved.
Show resolved Hide resolved
'server_metadata_value',
},
serverAttributes: {
'rpc.request.metadata.client_metadata_key': 'client_metadata_value',
'rpc.response.metadata.server_metadata_key':
'server_metadata_value',
},
};

runTestWithAttributeValidation(
Expand Down