This repository has been archived by the owner on Jun 19, 2023. It is now read-only.
/
logger.js
212 lines (200 loc) · 5.8 KB
/
logger.js
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
import http from 'http';
import bunyan from 'bunyan';
import bunyanDebugStream from 'bunyan-debug-stream';
import { LoggingBunyan } from '@google-cloud/logging-bunyan';
/*
* convert a millisecond value into a 'Duration' object, defined as
* `{ seconds, nanos }`, where `nanos` is the nanosecond component of the
* time
*
* https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration
*/
const formatDuration = ms => {
const seconds = Math.floor(ms / 1000); // whole seconds
const nanos = (ms % 1000) * 1000 * 1000; // remainder milliseconds in nanoseconds (= ms * 1,000,000)
return {
seconds,
nanos,
};
};
const serializers = {
...bunyan.stdSerializers,
};
/*
* These serializers correspond to the 2 major types of 'request'/'response'
* objects that are used in MWP apps - Hapi requests and http.IncomingMessage
* responses that are returned from the `request` library for server-to-server
* requests.
*/
export const httpRequestSerializers = {
hapi: request => {
const requestInfo = {
requestMethod: request.method.toUpperCase(),
requestUrl: request.url.href,
requestSize: request.headers['content-length'],
userAgent: request.headers['user-agent'],
remoteIp: request.info.remoteAddress,
serverIp: request.server.info.address, // internal IP
referer: request.info.referrer,
};
if (request.response) {
requestInfo.responseSize = request.response.headers['content-length'];
requestInfo.status = request.response.statusCode;
requestInfo.latency = formatDuration(
request.info.completed - request.info.received
);
}
return requestInfo;
},
incomingMessage: message => {
const messageInfo = {
requestMethod: message.request.method.toUpperCase(),
requestUrl: message.request.uri.href,
responseSize: (message.body || '').length,
status: message.statusCode,
latency: message.elapsedTime && formatDuration(message.elapsedTime),
userAgent: message.request.headers['user-agent'],
remoteIp:
message.request.headers['x_forwarded_for'] ||
message.request.headers['remote_addr'],
referer: message.request.headers['referer'],
};
return messageInfo;
},
};
/*
* Parse an http.IncomingMessage instance from `request` into an error `context`
* object defined by https://cloud.google.com/error-reporting/docs/formatting-error-messages
*/
const errorContextSerializers = {
hapi: request => {
const context = {
httpRequest: {
method: request.method.toUpperCase(),
url: request.url.href,
userAgent: request.headers['user-agent'],
referrer: request.headers['referer'],
responseStatusCode: (request.response || {}).statusCode || 500,
remoteIp:
request.headers['x_forwarded_for'] ||
request.headers['remote_addr'],
},
};
const memberId = request.headers['x-member'];
if (memberId && memberId !== '0') {
// Stackdriver Error Reporting specifically does not want this field for
// logged-out users
context.user = memberId;
}
return context;
},
incomingMessage: response => ({
httpRequest: {
method: response.request.method.toUpperCase(),
url: response.request.uri.href,
userAgent: response.request.headers['user-agent'],
referrer: response.request.headers['referer'],
responseStatusCode: response.statusCode,
remoteIp:
response.request.headers['x_forwarded_for'] ||
response.request.headers['remote_addr'],
},
}),
requestOpts: requestOpts => ({
httpRequest: {
method: requestOpts.method.toUpperCase(),
url: requestOpts.url,
userAgent: requestOpts.headers['user-agent'],
referrer: requestOpts.headers['referer'],
responseStatusCode: 500, // only used when logging request errors
remoteIp:
requestOpts.headers['x_forwarded_for'] ||
requestOpts.headers['remote_addr'],
},
}),
};
serializers.context = request => {
const { hapi, incomingMessage, requestOpts } = errorContextSerializers;
// choose the serializer based on the type of the object
if (request.server) {
// assume a Hapi request
return hapi(request);
}
if (request instanceof http.IncomingMessage) {
return incomingMessage(request);
}
if (request.agentOptions) {
return requestOpts(request);
}
return request;
};
/*
* Format a Hapi request object as a Stackdriver httpRequest for pretty logging
* https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#httprequest
*/
serializers.httpRequest = request => {
const { hapi, incomingMessage } = httpRequestSerializers;
// choose the serializer based on the type of the object
if (request.server) {
// assume a Hapi request
return hapi(request);
}
if (request instanceof http.IncomingMessage) {
return incomingMessage(request);
}
logger.warn(request, 'Unsupported httpRequest object');
return {};
};
const streams = [];
const {
NODE_ENV,
GAE_INSTANCE,
GCLOUD_PROJECT,
GAE_VERSION,
GAE_SERVICE,
DISABLE_GAE_LOG,
} = process.env;
if (!NODE_ENV || NODE_ENV === 'development') {
streams.push({
type: 'raw',
stream: bunyanDebugStream({ forceColor: true, basepath: process.cwd() }),
});
}
if (GAE_INSTANCE && !DISABLE_GAE_LOG) {
const GAELogger = new LoggingBunyan({
logName: 'mwp_log',
resource: {
type: 'gae_app',
labels: {
project_id: GCLOUD_PROJECT,
module_id: GAE_SERVICE,
version_id: GAE_VERSION,
},
},
serviceContext: {
service: GAE_SERVICE,
version: GAE_VERSION,
},
});
GAELogger.on('error', err => console.error(err));
streams.push(GAELogger.stream());
}
if (
streams.length === 0 &&
(NODE_ENV !== 'test' || process.argv.includes('--verbose'))
) {
// fallback if no stream specified
streams.push({ stream: process.stdout });
}
const logger = bunyan.createLogger({
name: 'mwp-logger',
serializers,
streams,
});
if (GAE_INSTANCE && !DISABLE_GAE_LOG) {
logger.info(
{ GAE_SERVICE, GAE_VERSION, GAE_INSTANCE },
'GAE logging initialized'
);
}
export default logger;