-
-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathSentryHandler.php
More file actions
267 lines (223 loc) · 8 KB
/
SentryHandler.php
File metadata and controls
267 lines (223 loc) · 8 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
<?php
declare(strict_types=1);
/**
* This file is part of friendsofhyperf/components.
*
* @link https://github.com/friendsofhyperf/components
* @document https://github.com/friendsofhyperf/components/blob/main/README.md
* @contact [email protected]
*/
namespace FriendsOfHyperf\Sentry;
use Hyperf\Context\ApplicationContext;
use Hyperf\Contract\ConfigInterface;
use Monolog\DateTimeImmutable;
use Monolog\Formatter\FormatterInterface;
use Monolog\Formatter\LineFormatter;
use Monolog\Handler\AbstractProcessingHandler;
use Monolog\Logger;
use Monolog\LogRecord;
use Sentry\Breadcrumb;
use Sentry\Event;
use Sentry\Monolog\CompatibilityProcessingHandlerTrait;
use Sentry\SentrySdk;
use Sentry\State\Scope;
use Throwable;
/**
* @deprecated since v3.1, use `FriendsOfHyperf\Sentry\Monolog\LogsHandler` instead, will remove in v3.2
*/
class SentryHandler extends AbstractProcessingHandler
{
use CompatibilityProcessingHandlerTrait;
/**
* The current application environment (staging|preprod|prod).
*/
protected string $environment;
/**
* Should represent the current version of the calling
* software. Can be any string (git commit, version number).
*/
protected string $release;
/**
* The formatter to use for the logs generated via handleBatch().
*/
protected ?FormatterInterface $batchFormatter = null;
/**
* @param int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct(
$level = Logger::DEBUG,
bool $bubble = true,
protected bool $reportExceptions = true,
protected bool $useFormattedMessage = false
) {
parent::__construct($level, $bubble); /* @phpstan-ignore-line */
$container = ApplicationContext::getContainer();
$config = $container->get(ConfigInterface::class);
if ($environment = $config->get('sentry.environment')) {
$this->environment = $environment;
}
if ($release = $config->get('sentry.release')) {
$this->release = $release;
}
}
public function handleBatch(array $records): void
{
$level = $this->level;
// filter records based on their level
$records = array_filter(
$records,
fn ($record) => $record['level'] >= $level
);
if (! $records) {
return;
}
// the record with the highest severity is the "main" one
$record = array_reduce(
$records,
function ($highest, $record) {
if ($highest === null || $record['level'] > $highest['level']) {
return $record;
}
return $highest;
}
);
// the other ones are added as a context item
$logs = [];
foreach ($records as $r) {
$logs[] = $this->processRecord($r);
}
$record['context']['logs'] = (string) $this->getBatchFormatter()->formatBatch($logs);
$this->handle($record);
}
/**
* Sets the formatter for the logs generated by handleBatch().
*/
public function setBatchFormatter(FormatterInterface $formatter): self
{
$this->batchFormatter = $formatter;
return $this;
}
/**
* Gets the formatter for the logs generated by handleBatch().
*/
public function getBatchFormatter(): FormatterInterface
{
if (! $this->batchFormatter) {
$this->batchFormatter = $this->getDefaultBatchFormatter();
}
return $this->batchFormatter;
}
/**
* Set the release.
*
* @param string $value
*/
public function setRelease($value): self
{
$this->release = $value;
return $this;
}
/**
* Set the current application environment.
*
* @param string $value
*/
public function setEnvironment($value): self
{
$this->environment = $value;
return $this;
}
/**
* Add a breadcrumb.
*
* @see https://docs.sentry.io/learn/breadcrumbs/
*/
public function addBreadcrumb(Breadcrumb $crumb): self
{
SentrySdk::getCurrentHub()->addBreadcrumb($crumb);
return $this;
}
/**
* @param array<string, mixed>|LogRecord $record
*/
protected function doWrite($record): void
{
$exception = $record['context']['exception'] ?? null;
$isException = $exception instanceof Throwable;
unset($record['context']['exception']);
if (! $this->reportExceptions && $isException) {
return;
}
SentrySdk::getCurrentHub()->withScope(
function (Scope $scope) use ($record, $isException, $exception) {
if (! empty($record['context']['extra'])) {
foreach ($record['context']['extra'] as $key => $tag) {
$scope->setExtra($key, $tag);
}
unset($record['context']['extra']);
}
if (! empty($record['context']['tags'])) {
foreach ($record['context']['tags'] as $key => $tag) {
$scope->setTag($key, (string) $tag);
}
unset($record['context']['tags']);
}
if (! empty($record['extra'])) {
foreach ($record['extra'] as $key => $extra) {
$scope->setExtra($key, $extra);
}
}
if (! empty($record['context']['fingerprint'])) {
$scope->setFingerprint($record['context']['fingerprint']);
unset($record['context']['fingerprint']);
}
if (! empty($record['context']['user'])) {
$scope->setUser((array) $record['context']['user']);
unset($record['context']['user']);
}
$logger = ! empty($record['context']['logger']) ? $record['context']['logger'] : $record['channel'];
unset($record['context']['logger']);
if (! empty($record['context'])) {
$scope->setExtra('log_context', $record['context']);
}
$scope->addEventProcessor(
function (Event $event) use ($record, $logger) {
$event->setLevel($this->getSeverityFromLevel($record['level']));
$event->setLogger($logger);
if (! empty($this->environment) && ! $event->getEnvironment()) {
$event->setEnvironment($this->environment);
}
if (! empty($this->release) && ! $event->getRelease()) {
$event->setRelease($this->release);
}
if (isset($record['datetime']) && $record['datetime'] instanceof DateTimeImmutable) {
$event->setTimestamp($record['datetime']->getTimestamp());
}
return $event;
}
);
if ($isException) {
SentrySdk::getCurrentHub()->captureException($exception);
} else {
SentrySdk::getCurrentHub()->captureMessage(
$this->useFormattedMessage || empty($record['message'])
? $record['formatted']
: $record['message']
);
}
}
);
}
protected function getDefaultFormatter(): FormatterInterface
{
return new LineFormatter('[%channel%] %message%');
}
/**
* Gets the default formatter for the logs generated by handleBatch().
*/
protected function getDefaultBatchFormatter(): FormatterInterface
{
return new LineFormatter();
}
}