/
HttpDependencies.ts
222 lines (187 loc) · 11.4 KB
/
HttpDependencies.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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
import http = require("http");
import https = require("https");
import url = require("url");
import Contracts = require("../Declarations/Contracts");
import TelemetryClient = require("../Library/TelemetryClient");
import Logging = require("../Library/Logging");
import Util = require("../Library/Util");
import RequestResponseHeaders = require("../Library/RequestResponseHeaders");
import HttpDependencyParser = require("./HttpDependencyParser");
import { CorrelationContextManager, CorrelationContext, PrivateCustomProperties } from "./CorrelationContextManager";
import CorrelationIdManager = require("../Library/CorrelationIdManager");
import Traceparent = require("../Library/Traceparent");
import * as DiagChannel from "./diagnostic-channel/initialization";
class AutoCollectHttpDependencies {
public static disableCollectionRequestOption = 'disableAppInsightsAutoCollection';
public static INSTANCE: AutoCollectHttpDependencies;
private static requestNumber = 1;
private static alreadyAutoCollectedFlag = '_appInsightsAutoCollected';
private _client: TelemetryClient;
private _isEnabled: boolean;
private _isInitialized: boolean;
constructor(client: TelemetryClient) {
if (!!AutoCollectHttpDependencies.INSTANCE) {
throw new Error("Client request tracking should be configured from the applicationInsights object");
}
AutoCollectHttpDependencies.INSTANCE = this;
this._client = client;
}
public enable(isEnabled: boolean) {
this._isEnabled = isEnabled;
if (this._isEnabled && !this._isInitialized) {
this._initialize();
}
if (DiagChannel.IsInitialized) {
require("./diagnostic-channel/azure-coretracing.sub").enable(true, this._client);
require("./diagnostic-channel/mongodb.sub").enable(isEnabled, this._client);
require("./diagnostic-channel/mysql.sub").enable(isEnabled, this._client);
require("./diagnostic-channel/redis.sub").enable(isEnabled, this._client);
require("./diagnostic-channel/postgres.sub").enable(isEnabled, this._client);
}
}
public isInitialized() {
return this._isInitialized;
}
private _initialize() {
this._isInitialized = true;
const originalGet = http.get;
const originalRequest = http.request;
const originalHttpsRequest = https.request;
const clientRequestPatch = (request: http.ClientRequest, options: http.RequestOptions | https.RequestOptions) => {
var shouldCollect = !(<any>options)[AutoCollectHttpDependencies.disableCollectionRequestOption] &&
!(<any>request)[AutoCollectHttpDependencies.alreadyAutoCollectedFlag];
// If someone else patched traceparent headers onto this request
if (options.headers && options.headers['user-agent'] && options.headers['user-agent'].toString().indexOf('azsdk-js') !== -1) {
shouldCollect = false;
}
(<any>request)[AutoCollectHttpDependencies.alreadyAutoCollectedFlag] = true;
if (request && options && shouldCollect) {
CorrelationContextManager.wrapEmitter(request);
AutoCollectHttpDependencies.trackRequest(this._client, {options: options, request: request});
}
};
// On node >= v0.11.12 and < 9.0 (excluding 8.9.0) https.request just calls http.request (with additional options).
// On node < 0.11.12, 8.9.0, and 9.0 > https.request is handled separately
// Patch both and leave a flag to not double-count on versions that just call through
// We add the flag to both http and https to protect against strange double collection in other scenarios
http.request = (options, ...requestArgs: any[]) => {
const request: http.ClientRequest = originalRequest.call(http, options, ...requestArgs);
clientRequestPatch(request, options);
return request;
};
https.request = (options, ...requestArgs: any[]) => {
const request: http.ClientRequest = originalHttpsRequest.call(https, options, ...requestArgs);
clientRequestPatch(request, options);
return request;
};
// Node 8 calls http.request from http.get using a local reference!
// We have to patch .get manually in this case and can't just assume request is enough
// We have to replace the entire method in this case. We can't call the original.
// This is because calling the original will give us no chance to set headers as it internally does .end().
http.get = (options, ...requestArgs: any[]) => {
const request: http.ClientRequest = http.request.call(http, options, ...requestArgs);
request.end();
return request;
};
https.get = (options, ...requestArgs: any[]) => {
const request: http.ClientRequest = https.request.call(https, options, ...requestArgs);
request.end();
return request;
};
}
/**
* Tracks an outgoing request. Because it may set headers this method must be called before
* writing content to or ending the request.
*/
public static trackRequest(client: TelemetryClient, telemetry: Contracts.NodeHttpDependencyTelemetry) {
if (!telemetry.options || !telemetry.request || !client) {
Logging.info("AutoCollectHttpDependencies.trackRequest was called with invalid parameters: ", !telemetry.options, !telemetry.request, !client);
return;
}
let requestParser = new HttpDependencyParser(telemetry.options, telemetry.request);
const currentContext = CorrelationContextManager.getCurrentContext();
let uniqueRequestId: string;
let uniqueTraceparent: string;
if (currentContext && currentContext.operation && currentContext.operation.traceparent && Traceparent.isValidTraceId(currentContext.operation.traceparent.traceId)) {
currentContext.operation.traceparent.updateSpanId();
uniqueRequestId = currentContext.operation.traceparent.getBackCompatRequestId();
} else if (CorrelationIdManager.w3cEnabled) {
// Start an operation now so that we can include the w3c headers in the outgoing request
const traceparent = new Traceparent();
uniqueTraceparent = traceparent.toString();
uniqueRequestId = traceparent.getBackCompatRequestId();
} else {
uniqueRequestId = currentContext && currentContext.operation && (currentContext.operation.parentId + AutoCollectHttpDependencies.requestNumber++ + '.');
}
// Add the source correlationId to the request headers, if a value was not already provided.
// The getHeader/setHeader methods aren't available on very old Node versions, and
// are not included in the v0.10 type declarations currently used. So check if the
// methods exist before invoking them.
if (Util.canIncludeCorrelationHeader(client, requestParser.getUrl()) && telemetry.request.getHeader && telemetry.request.setHeader) {
if (client.config && client.config.correlationId) {
// getHeader returns "any" type in newer versions of node. In basic scenarios, this will be <string | string[] | number>, but could be modified to anything else via middleware
const correlationHeader = <any>telemetry.request.getHeader(RequestResponseHeaders.requestContextHeader)
try {
Util.safeIncludeCorrelationHeader(client, telemetry.request, correlationHeader);
} catch (err) {
Logging.warn("Request-Context header could not be set. Correlation of requests may be lost", err);
}
if (currentContext && currentContext.operation) {
try {
telemetry.request.setHeader(RequestResponseHeaders.requestIdHeader, uniqueRequestId);
// Also set legacy headers
telemetry.request.setHeader(RequestResponseHeaders.parentIdHeader, currentContext.operation.id);
telemetry.request.setHeader(RequestResponseHeaders.rootIdHeader, uniqueRequestId);
// Set W3C headers, if available
if (uniqueTraceparent || currentContext.operation.traceparent) {
telemetry.request.setHeader(RequestResponseHeaders.traceparentHeader, uniqueTraceparent || currentContext.operation.traceparent.toString());
} else if (CorrelationIdManager.w3cEnabled) {
// should never get here since we set uniqueTraceparent above for the w3cEnabled scenario
const traceparent = new Traceparent().toString();
telemetry.request.setHeader(RequestResponseHeaders.traceparentHeader, traceparent);
}
if (currentContext.operation.tracestate) {
const tracestate = currentContext.operation.tracestate.toString();
if (tracestate) {
telemetry.request.setHeader(RequestResponseHeaders.traceStateHeader, tracestate)
}
}
const correlationContextHeader = (<PrivateCustomProperties>currentContext.customProperties).serializeToHeader();
if (correlationContextHeader) {
telemetry.request.setHeader(RequestResponseHeaders.correlationContextHeader, correlationContextHeader);
}
} catch (err) {
Logging.warn("Correlation headers could not be set. Correlation of requests may be lost.", err);
}
}
}
}
// Collect dependency telemetry about the request when it finishes.
if (telemetry.request.on) {
telemetry.request.on('response', (response: http.ClientResponse) => {
requestParser.onResponse(response);
var dependencyTelemetry = requestParser.getDependencyTelemetry(telemetry, uniqueRequestId);
dependencyTelemetry.contextObjects = dependencyTelemetry.contextObjects || {};
dependencyTelemetry.contextObjects["http.RequestOptions"] = telemetry.options;
dependencyTelemetry.contextObjects["http.ClientRequest"] = telemetry.request;
dependencyTelemetry.contextObjects["http.ClientResponse"] = response;
client.trackDependency(dependencyTelemetry);
});
telemetry.request.on('error', (e: Error) => {
requestParser.onError(e);
var dependencyTelemetry = requestParser.getDependencyTelemetry(telemetry, uniqueRequestId);
dependencyTelemetry.contextObjects = dependencyTelemetry.contextObjects || {};
dependencyTelemetry.contextObjects["http.RequestOptions"] = telemetry.options;
dependencyTelemetry.contextObjects["http.ClientRequest"] = telemetry.request;
dependencyTelemetry.contextObjects["Error"] = e;
client.trackDependency(dependencyTelemetry);
});
}
}
public dispose() {
AutoCollectHttpDependencies.INSTANCE = null;
this.enable(false);
this._isInitialized = false;
}
}
export = AutoCollectHttpDependencies;