/
serverUtils.ts
136 lines (126 loc) · 3.89 KB
/
serverUtils.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
* Copyright The OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type * as grpcTypes from 'grpc';
import { SendUnaryDataCallback, ServerCallWithMeta } from './types';
import { GrpcNativeInstrumentation } from './';
import { context, Span, SpanStatusCode } from '@opentelemetry/api';
import {
_grpcStatusCodeToOpenTelemetryStatusCode,
_grpcStatusCodeToSpanStatus,
_methodIsIgnored,
} from '../utils';
import { AttributeNames } from '../enums/AttributeNames';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
export const clientStreamAndUnaryHandler = function <RequestType, ResponseType>(
grpcClient: typeof grpcTypes,
span: Span,
call: ServerCallWithMeta,
callback: SendUnaryDataCallback,
original:
| grpcTypes.handleCall<RequestType, ResponseType>
| grpcTypes.ClientReadableStream<RequestType>,
self: {}
) {
function patchedCallback(
err: grpcTypes.ServiceError,
value: any,
trailer: grpcTypes.Metadata,
flags: grpcTypes.writeFlags
) {
if (err) {
if (err.code) {
span.setStatus({
code: _grpcStatusCodeToOpenTelemetryStatusCode(err.code),
message: err.message,
});
span.setAttribute(
SemanticAttributes.RPC_GRPC_STATUS_CODE,
err.code.toString()
);
}
span.setAttributes({
[AttributeNames.GRPC_ERROR_NAME]: err.name,
[AttributeNames.GRPC_ERROR_MESSAGE]: err.message,
});
} else {
span.setStatus({ code: SpanStatusCode.UNSET });
span.setAttribute(
SemanticAttributes.RPC_GRPC_STATUS_CODE,
grpcClient.status.OK.toString()
);
}
span.addEvent('received');
// end the span
span.end();
return callback(err, value, trailer, flags);
}
context.bind(context.active(), call);
return (original as Function).call(self, call, patchedCallback);
};
export const serverStreamAndBidiHandler = function <RequestType, ResponseType>(
span: Span,
call: ServerCallWithMeta,
original: grpcTypes.handleCall<RequestType, ResponseType>,
self: {}
) {
let spanEnded = false;
const endSpan = () => {
if (!spanEnded) {
spanEnded = true;
span.end();
}
};
context.bind(context.active(), call);
call.on('finish', () => {
span.setStatus(_grpcStatusCodeToSpanStatus(call.status.code));
span.setAttribute(
SemanticAttributes.RPC_GRPC_STATUS_CODE,
call.status.code.toString()
);
// if there is an error, span will be ended on error event, otherwise end it here
if (call.status.code === 0) {
span.addEvent('finished');
endSpan();
}
});
call.on('error', (err: grpcTypes.ServiceError) => {
span.setStatus({
code: _grpcStatusCodeToOpenTelemetryStatusCode(err.code),
message: err.message,
});
span.addEvent('finished with error');
span.setAttributes({
[AttributeNames.GRPC_ERROR_NAME]: err.name,
[AttributeNames.GRPC_ERROR_MESSAGE]: err.message,
});
endSpan();
});
return (original as any).call(self, call);
};
/**
* Returns true if the server call should not be traced.
*/
export const shouldNotTraceServerCall = function (
this: GrpcNativeInstrumentation,
call: ServerCallWithMeta,
name: string
): boolean {
const parsedName = name.split('/');
return _methodIsIgnored(
parsedName[parsedName.length - 1] || name,
this._config.ignoreGrpcMethods
);
};