-
Notifications
You must be signed in to change notification settings - Fork 461
Expand file tree
/
Copy pathBootstrap.php
More file actions
311 lines (298 loc) · 9.98 KB
/
Bootstrap.php
File metadata and controls
311 lines (298 loc) · 9.98 KB
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
<?php
namespace Google\Cloud\ErrorReporting;
use Google\Cloud\Logging\LoggingClient;
use Google\Cloud\Logging\PsrLogger;
/**
* Static methods for bootstrapping Stackdriver Error Reporting.
*/
class Bootstrap
{
const DEFAULT_LOGNAME = 'app-error';
/** @var PsrLogger */
public static $psrLogger;
/**
* Return the full path of the prepend file.
*
* @return string
*/
public static function prependFileLocation()
{
// Now it's in the same directory.
return realpath(__DIR__ . '/prepend.php');
}
/**
* Register hooks for error reporting.
*
* @param PsrLogger $psrLogger
* @return void
* @codeCoverageIgnore
*/
public static function init(?PsrLogger $psrLogger = null)
{
self::$psrLogger = $psrLogger ?: (new LoggingClient())
->psrLogger(self::DEFAULT_LOGNAME, [
'batchEnabled' => true,
'debugOutput' => true,
'batchOptions' => [
'numWorkers' => 2
]
]);
register_shutdown_function([self::class, 'shutdownHandler']);
set_exception_handler([self::class, 'exceptionHandler']);
set_error_handler([self::class, 'errorHandler']);
}
/**
* Return a string prefix for the given error level.
*
* @param int $level
* @return string A string prefix for reporting the error.
*/
public static function getErrorPrefix($level)
{
switch ($level) {
case E_PARSE:
$prefix = 'PHP Parse error';
break;
case E_ERROR:
case E_CORE_ERROR:
case E_COMPILE_ERROR:
$prefix = 'PHP Fatal error';
break;
case E_USER_ERROR:
case E_RECOVERABLE_ERROR:
$prefix = 'PHP error';
break;
case E_WARNING:
case E_CORE_WARNING:
case E_COMPILE_WARNING:
case E_USER_WARNING:
$prefix = 'PHP Warning';
break;
case E_NOTICE:
case E_USER_NOTICE:
$prefix = 'PHP Notice';
break;
default:
$prefix = 'PHP Notice';
}
return $prefix;
}
/**
* Return an error level string for the given PHP error level.
*
* @param int $level
* @return string An error level string.
*/
public static function getErrorLevelString($level)
{
switch ($level) {
case E_PARSE:
return 'CRITICAL';
case E_ERROR:
case E_CORE_ERROR:
case E_COMPILE_ERROR:
case E_USER_ERROR:
case E_RECOVERABLE_ERROR:
return 'ERROR';
case E_WARNING:
case E_CORE_WARNING:
case E_COMPILE_WARNING:
case E_USER_WARNING:
return 'WARNING';
case E_NOTICE:
case E_USER_NOTICE:
return 'NOTICE';
default:
return 'NOTICE';
}
}
/**
* @param mixed $ex \Throwable (PHP 7) or \Exception (PHP 5)
*/
public static function exceptionHandler($ex)
{
$message = sprintf('PHP Notice: %s', (string) $ex);
if (self::$psrLogger) {
$service = self::$psrLogger->getMetadataProvider()->serviceId();
$version = self::$psrLogger->getMetadataProvider()->versionId();
$context = [
'context' => [
'reportLocation' => [
'filePath' => $ex->getFile(),
'lineNumber' => $ex->getLine(),
'functionName' =>
self::getFunctionNameForReport($ex->getTrace()),
]
],
'serviceContext' => [
'service' => $service,
'version' => $version,
]
];
$httpRequest = self::getHttpRequest();
if (!empty($httpRequest)) {
$context['context']['httpRequest'] = self::getHttpRequest();
}
self::$psrLogger->error($message, $context);
} else {
$stderr = defined('STDERR') ? STDERR : fopen('php://stderr', 'w');
fwrite($stderr, $message . PHP_EOL);
}
}
/**
* @param int $level The error level.
* @param string $message The error message.
* @param string $file The filename that the error was raised in.
* @param int $line The line number that the error was raised at.
*/
public static function errorHandler($level, $message, $file, $line)
{
if (!($level & error_reporting())) {
return true;
}
$message = sprintf(
'%s: %s in %s on line %d',
self::getErrorPrefix($level),
$message,
$file,
$line
);
if (!self::$psrLogger) {
return false;
}
$service = self::$psrLogger->getMetadataProvider()->serviceId();
$version = self::$psrLogger->getMetadataProvider()->versionId();
$context = [
'context' => [
'reportLocation' => [
'filePath' => $file,
'lineNumber' => $line,
'functionName' =>
self::getFunctionNameForReport(),
]
],
'serviceContext' => [
'service' => $service,
'version' => $version
]
];
$httpRequest = self::getHttpRequest();
if (!empty($httpRequest)) {
$context['context']['httpRequest'] = self::getHttpRequest();
}
self::$psrLogger->log(
self::getErrorLevelString($level),
$message,
$context
);
}
/**
* Called at exit, to check there's a fatal error and report the error if
* any.
*/
public static function shutdownHandler()
{
if ($err = error_get_last()) {
switch ($err['type']) {
case E_ERROR:
case E_PARSE:
case E_COMPILE_ERROR:
case E_CORE_ERROR:
$service = self::$psrLogger
->getMetadataProvider()
->serviceId();
$version = self::$psrLogger
->getMetadataProvider()
->versionId();
$message = sprintf(
'%s: %s in %s on line %d',
self::getErrorPrefix($err['type']),
$err['message'],
$err['file'],
$err['line']
);
$context = [
'context' => [
'reportLocation' => [
'filePath' => $err['file'],
'lineNumber' => $err['line'],
'functionName' =>
self::getFunctionNameForReport(),
]
],
'serviceContext' => [
'service' => $service,
'version' => $version
]
];
$httpRequest = self::getHttpRequest();
if (!empty($httpRequest)) {
$context['context']['httpRequest'] = self::getHttpRequest();
}
if (self::$psrLogger) {
self::$psrLogger->log(
self::getErrorLevelString($err['type']),
$message,
$context
);
}
break;
}
}
}
/**
* Format the function name from a stack trace. This could be a global
* function (function_name), a class function (Class->function), or a static
* function (Class::function).
*
* @param array $trace The stack trace returned from Exception::getTrace()
*/
private static function getFunctionNameForReport(?array $trace = null)
{
if (null === $trace) {
return '<unknown function>';
}
if (empty($trace[0]['function'])) {
return '<none>';
}
$functionName = [$trace[0]['function']];
if (isset($trace[0]['type'])) {
$functionName[] = $trace[0]['type'];
}
if (isset($trace[0]['class'])) {
$functionName[] = $trace[0]['class'];
}
return implode('', array_reverse($functionName));
}
/**
* Builds an HttpRequestContext from available server information.
*
* @return array An HttpRequestContext.
*/
private static function getHttpRequest()
{
$httpRequest = [];
if (isset($_SERVER)) {
if (isset($_SERVER['REQUEST_METHOD'])) {
$httpRequest['method'] = $_SERVER['REQUEST_METHOD'];
}
if (isset($_SERVER['HTTP_USER_AGENT'])) {
$httpRequest['userAgent'] = $_SERVER['HTTP_USER_AGENT'];
}
if (isset($_SERVER['HTTP_REFERER'])) {
$httpRequest['referrer'] = $_SERVER['HTTP_REFERER'];
}
if (isset($_SERVER['REMOTE_ADDR'])) {
$httpRequest['remoteIp'] = $_SERVER['REMOTE_ADDR'];
}
if (isset($_SERVER['HTTP_HOST']) && isset($_SERVER['REQUEST_URI'])) {
$httpRequest['url'] = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'on' ? 'https' : 'http')
. '://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
}
if (http_response_code() !== false) {
$httpRequest['responseStatusCode'] = http_response_code();
}
}
return $httpRequest;
}
}