/
types.ts
142 lines (132 loc) · 3.73 KB
/
types.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
137
138
139
140
141
142
/*
* 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 { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { Span } from '@opentelemetry/api';
export interface MongoDBInstrumentationExecutionResponseHook {
(span: Span, result: CommandResult): void;
}
export interface MongoDBInstrumentationConfig extends InstrumentationConfig {
/**
* If true, additional information about query parameters and
* results will be attached (as `attributes`) to spans representing
* database operations.
*/
enhancedDatabaseReporting?: boolean;
/**
* Hook that allows adding custom span attributes based on the data
* returned from MongoDB actions.
*
* @default undefined
*/
responseHook?: MongoDBInstrumentationExecutionResponseHook;
}
export type Func<T> = (...args: unknown[]) => T;
export type MongoInternalCommand = {
findandmodify: boolean;
createIndexes: boolean;
count: boolean;
ismaster: boolean;
indexes?: unknown[];
query?: Record<string, unknown>;
limit?: number;
q?: Record<string, unknown>;
u?: Record<string, unknown>;
};
export type CursorState = { cmd: MongoInternalCommand } & Record<
string,
unknown
>;
// https://github.com/mongodb/node-mongodb-native/blob/3.6/lib/core/connection/command_result.js
export type CommandResult = {
result?: string;
connection?: string;
message?: string;
};
// https://github.com/mongodb/node-mongodb-native/blob/3.6/lib/core/wireprotocol/index.js
export type WireProtocolInternal = {
insert: (
server: MongoInternalTopology,
ns: string,
ops: unknown[],
options: unknown | Function,
callback?: Function
) => unknown;
update: (
server: MongoInternalTopology,
ns: string,
ops: unknown[],
options: unknown | Function,
callback?: Function
) => unknown;
remove: (
server: MongoInternalTopology,
ns: string,
ops: unknown[],
options: unknown | Function,
callback?: Function
) => unknown;
killCursors: (
server: MongoInternalTopology,
ns: string,
cursorState: CursorState,
callback: Function
) => unknown;
getMore: (
server: MongoInternalTopology,
ns: string,
cursorState: CursorState,
batchSize: number,
options: unknown | Function,
callback?: Function
) => unknown;
query: (
server: MongoInternalTopology,
ns: string,
cmd: MongoInternalCommand,
cursorState: CursorState,
options: unknown | Function,
callback?: Function
) => unknown;
command: (
server: MongoInternalTopology,
ns: string,
cmd: MongoInternalCommand,
options: unknown | Function,
callback?: Function
) => unknown;
};
// https://github.com/mongodb/node-mongodb-native/blob/3.6/lib/topologies/server.js#L172
// https://github.com/mongodb/node-mongodb-native/blob/2.2/lib/server.js#L174
export type MongoInternalTopology = {
s?: {
// those are for mongodb@3
options?: {
host?: string;
port?: number;
servername?: string;
};
// those are for mongodb@2
host?: string;
port?: number;
};
};
export enum MongodbCommandType {
CREATE_INDEXES = 'createIndexes',
FIND_AND_MODIFY = 'findAndModify',
IS_MASTER = 'isMaster',
COUNT = 'count',
UNKNOWN = 'unknown',
}