Skip to content

Commit 257f3f1

Browse files
nicolas-grekasnicolas-grekas
committed
[Cache] improve logged messages
1 parent 1cd99ea commit 257f3f1

File tree

6 files changed

+18
-15
lines changed

6 files changed

+18
-15
lines changed

‎src/Symfony/Component/Cache/Adapter/AbstractTagAwareAdapter.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,8 @@ public function deleteItems(array $keys)
253253
}
254254
} catch (\Exception $e) {
255255
}
256-
CacheItem::log($this->logger, 'Failed to delete key "{key}"', ['key' => $key, 'exception' => $e]);
256+
$message = 'Failed to delete key "{key}"'.($e instanceof \Exception ? ': '.$e->getMessage() : '.');
257+
CacheItem::log($this->logger, $message, ['key' => $key, 'exception' => $e]);
257258
$ok = false;
258259
}
259260

‎src/Symfony/Component/Cache/Adapter/RedisTagAwareAdapter.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ private function redisServerSupportSPOP(): bool
198198
$info = $host->info('Server');
199199
$info = isset($info['Server']) ? $info['Server'] : $info;
200200
if (version_compare($info['redis_version'], '3.2', '<')) {
201-
CacheItem::log($this->logger, 'Redis server needs to be version 3.2 or higher, your Redis server was detected as {version}', ['version' => $info['redis_version']]);
201+
CacheItem::log($this->logger, 'Redis server needs to be version 3.2 or higher, your Redis server was detected as '.$info['redis_version']);
202202

203203
return $this->redisServerSupportSPOP = false;
204204
}

‎src/Symfony/Component/Cache/Simple/AbstractCache.php

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public function get($key, $default = null)
5656
return $value;
5757
}
5858
} catch (\Exception $e) {
59-
CacheItem::log($this->logger, 'Failed to fetch key "{key}"', ['key' => $key, 'exception' => $e]);
59+
CacheItem::log($this->logger, 'Failed to fetch key "{key}": '.$e->getMessage(), ['key' => $key, 'exception' => $e]);
6060
}
6161

6262
return $default;
@@ -90,7 +90,7 @@ public function getMultiple($keys, $default = null)
9090
try {
9191
$values = $this->doFetch($ids);
9292
} catch (\Exception $e) {
93-
CacheItem::log($this->logger, 'Failed to fetch requested values', ['keys' => $keys, 'exception' => $e]);
93+
CacheItem::log($this->logger, 'Failed to fetch values: '.$e->getMessage(), ['keys' => $keys, 'exception' => $e]);
9494
$values = [];
9595
}
9696
$ids = array_combine($ids, $keys);
@@ -129,7 +129,8 @@ public function setMultiple($values, $ttl = null)
129129
foreach (\is_array($e) ? $e : array_keys($valuesById) as $id) {
130130
$keys[] = substr($id, \strlen($this->namespace));
131131
}
132-
CacheItem::log($this->logger, 'Failed to save values', ['keys' => $keys, 'exception' => $e instanceof \Exception ? $e : null]);
132+
$message = 'Failed to save values'.($e instanceof \Exception ? ': '.$e->getMessage() : '.');
133+
CacheItem::log($this->logger, $message, ['keys' => $keys, 'exception' => $e instanceof \Exception ? $e : null]);
133134

134135
return false;
135136
}
@@ -175,7 +176,7 @@ private function generateValues($values, &$keys, $default)
175176
yield $key => $value;
176177
}
177178
} catch (\Exception $e) {
178-
CacheItem::log($this->logger, 'Failed to fetch requested values', ['keys' => array_values($keys), 'exception' => $e]);
179+
CacheItem::log($this->logger, 'Failed to fetch values: '.$e->getMessage(), ['keys' => array_values($keys), 'exception' => $e]);
179180
}
180181

181182
foreach ($keys as $key) {

‎src/Symfony/Component/Cache/Traits/AbstractAdapterTrait.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public function getItem($key)
5252
$isHit = true;
5353
}
5454
} catch (\Exception $e) {
55-
CacheItem::log($this->logger, 'Failed to fetch key "{key}"', ['key' => $key, 'exception' => $e]);
55+
CacheItem::log($this->logger, 'Failed to fetch key "{key}": '.$e->getMessage(), ['key' => $key, 'exception' => $e]);
5656
}
5757

5858
return $f($key, $value, $isHit);
@@ -74,7 +74,7 @@ public function getItems(array $keys = [])
7474
try {
7575
$items = $this->doFetch($ids);
7676
} catch (\Exception $e) {
77-
CacheItem::log($this->logger, 'Failed to fetch requested items', ['keys' => $keys, 'exception' => $e]);
77+
CacheItem::log($this->logger, 'Failed to fetch items: '.$e->getMessage(), ['keys' => $keys, 'exception' => $e]);
7878
$items = [];
7979
}
8080
$ids = array_combine($ids, $keys);
@@ -129,7 +129,7 @@ private function generateItems($items, &$keys)
129129
yield $key => $f($key, $value, true);
130130
}
131131
} catch (\Exception $e) {
132-
CacheItem::log($this->logger, 'Failed to fetch requested items', ['keys' => array_values($keys), 'exception' => $e]);
132+
CacheItem::log($this->logger, 'Failed to fetch items: '.$e->getMessage(), ['keys' => array_values($keys), 'exception' => $e]);
133133
}
134134

135135
foreach ($keys as $key) {

‎src/Symfony/Component/Cache/Traits/AbstractTrait.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public function hasItem($key)
9494
try {
9595
return $this->doHave($id);
9696
} catch (\Exception $e) {
97-
CacheItem::log($this->logger, 'Failed to check if key "{key}" is cached', ['key' => $key, 'exception' => $e]);
97+
CacheItem::log($this->logger, 'Failed to check if key "{key}" is cached: '.$e->getMessage(), ['key' => $key, 'exception' => $e]);
9898

9999
return false;
100100
}
@@ -122,7 +122,7 @@ public function clear()
122122
try {
123123
return $this->doClear($this->namespace) || $cleared;
124124
} catch (\Exception $e) {
125-
CacheItem::log($this->logger, 'Failed to clear the cache', ['exception' => $e]);
125+
CacheItem::log($this->logger, 'Failed to clear the cache: '.$e->getMessage(), ['exception' => $e]);
126126

127127
return false;
128128
}
@@ -166,7 +166,8 @@ public function deleteItems(array $keys)
166166
}
167167
} catch (\Exception $e) {
168168
}
169-
CacheItem::log($this->logger, 'Failed to delete key "{key}"', ['key' => $key, 'exception' => $e]);
169+
$message = 'Failed to delete key "{key}"'.($e instanceof \Exception ? ': '.$e->getMessage() : '.');
170+
CacheItem::log($this->logger, $message, ['key' => $key, 'exception' => $e]);
170171
$ok = false;
171172
}
172173

‎src/Symfony/Component/Cache/Traits/ArrayTrait.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,8 +128,8 @@ private function freeze($value, $key)
128128
$serialized = serialize($value);
129129
} catch (\Exception $e) {
130130
$type = \is_object($value) ? \get_class($value) : \gettype($value);
131-
$message = sprintf('Failed to save key "{key}" of type %s%s', $type, $e instanceof \Exception ? ': '.$e->getMessage() : '.');
132-
CacheItem::log($this->logger, $message, ['key' => substr($id, \strlen($this->namespace)), 'exception' => $e instanceof \Exception ? $e : null]);
131+
$message = sprintf('Failed to save key "{key}" of type %s: %s', $type, $e->getMessage());
132+
CacheItem::log($this->logger, $message, ['key' => substr($id, \strlen($this->namespace)), 'exception' => $e]);
133133

134134
return;
135135
}
@@ -151,7 +151,7 @@ private function unfreeze(string $key, bool &$isHit)
151151
try {
152152
$value = unserialize($value);
153153
} catch (\Exception $e) {
154-
CacheItem::log($this->logger, 'Failed to unserialize key "{key}"', ['key' => $key, 'exception' => $e]);
154+
CacheItem::log($this->logger, 'Failed to unserialize key "{key}": '.$e->getMessage(), ['key' => $key, 'exception' => $e]);
155155
$value = false;
156156
}
157157
if (false === $value) {

0 commit comments

Comments
 (0)