-
Notifications
You must be signed in to change notification settings - Fork 265
/
Copy pathPsrLogAdapter.php
161 lines (140 loc) · 4.95 KB
/
PsrLogAdapter.php
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
<?php
/*
* Copyright 2023-present MongoDB, Inc.
*
* 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.
*/
namespace MongoDB;
use MongoDB\Driver\Monitoring\LogSubscriber;
use MongoDB\Exception\UnexpectedValueException;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;
use SplObjectStorage;
use function MongoDB\Driver\Monitoring\addSubscriber;
use function MongoDB\Driver\Monitoring\removeSubscriber;
use function sprintf;
/**
* Integrates libmongoc/PHPC logging with one or more PSR-3 loggers.
*
* This class is internal and should not be utilized by applications. Logging
* should be configured via the add_logger() and remove_logger() functions.
*
* @internal
*/
final class PsrLogAdapter implements LogSubscriber
{
public const EMERGENCY = 0;
public const ALERT = 1;
public const CRITICAL = 2;
public const ERROR = 3;
public const WARN = 4;
public const NOTICE = 5;
public const INFO = 6;
public const DEBUG = 7;
public const TRACE = 8;
private static ?self $instance = null;
/** @psalm-var SplObjectStorage<LoggerInterface, null> */
private SplObjectStorage $loggers;
private const SPEC_TO_PSR = [
self::EMERGENCY => LogLevel::EMERGENCY,
self::ALERT => LogLevel::ALERT,
self::CRITICAL => LogLevel::CRITICAL,
self::ERROR => LogLevel::ERROR,
self::WARN => LogLevel::WARNING,
self::NOTICE => LogLevel::NOTICE,
self::INFO => LogLevel::INFO,
self::DEBUG => LogLevel::DEBUG,
// PSR does not define a "trace" level, so map it to "debug"
self::TRACE => LogLevel::DEBUG,
];
private const MONGOC_TO_PSR = [
LogSubscriber::LEVEL_ERROR => LogLevel::ERROR,
/* libmongoc considers "critical" less severe than "error" so map it to
* "error" in the PSR logger. */
LogSubscriber::LEVEL_CRITICAL => LogLevel::ERROR,
LogSubscriber::LEVEL_WARNING => LogLevel::WARNING,
LogSubscriber::LEVEL_MESSAGE => LogLevel::NOTICE,
LogSubscriber::LEVEL_INFO => LogLevel::INFO,
LogSubscriber::LEVEL_DEBUG => LogLevel::DEBUG,
];
public static function addLogger(LoggerInterface $logger): void
{
$instance = self::getInstance();
$instance->loggers->attach($logger);
addSubscriber($instance);
}
/**
* Forwards a log message from libmongoc/PHPC to all registered PSR loggers.
*
* @see LogSubscriber::log()
*/
public function log(int $level, string $domain, string $message): void
{
if (! isset(self::MONGOC_TO_PSR[$level])) {
throw new UnexpectedValueException(sprintf(
'Expected level to be >= %d and <= %d, %d given for domain "%s" and message: %s',
LogSubscriber::LEVEL_ERROR,
LogSubscriber::LEVEL_DEBUG,
$level,
$domain,
$message,
));
}
$instance = self::getInstance();
$psrLevel = self::MONGOC_TO_PSR[$level];
$context = ['domain' => $domain];
foreach ($instance->loggers as $logger) {
$logger->log($psrLevel, $message, $context);
}
}
public static function removeLogger(LoggerInterface $logger): void
{
$instance = self::getInstance();
$instance->loggers->detach($logger);
if ($instance->loggers->count() === 0) {
removeSubscriber($instance);
}
}
/**
* Writes a log message to all registered PSR loggers.
*
* This function is intended for internal use within the library.
*/
public static function writeLog(int $specLevel, string $domain, string $message): void
{
if (! isset(self::SPEC_TO_PSR[$specLevel])) {
throw new UnexpectedValueException(sprintf(
'Expected level to be >= %d and <= %d, %d given for domain "%s" and message: %s',
self::EMERGENCY,
self::TRACE,
$specLevel,
$domain,
$message,
));
}
$instance = self::getInstance();
$psrLevel = self::SPEC_TO_PSR[$specLevel];
$context = ['domain' => $domain];
foreach ($instance->loggers as $logger) {
$logger->log($psrLevel, $message, $context);
}
}
private function __construct()
{
$this->loggers = new SplObjectStorage();
}
private static function getInstance(): self
{
return self::$instance ??= new self();
}
}