mirror of
https://github.com/element-hq/synapse.git
synced 2024-12-14 11:57:44 +00:00
Add logging for redis connection setup (#9590)
This commit is contained in:
parent
e55bd0e110
commit
464e5da7b2
3 changed files with 39 additions and 1 deletions
1
changelog.d/9590.misc
Normal file
1
changelog.d/9590.misc
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Add logging for redis connection setup.
|
|
@ -17,6 +17,8 @@
|
||||||
"""
|
"""
|
||||||
from typing import Any, List, Optional, Type, Union
|
from typing import Any, List, Optional, Type, Union
|
||||||
|
|
||||||
|
from twisted.internet import protocol
|
||||||
|
|
||||||
class RedisProtocol:
|
class RedisProtocol:
|
||||||
def publish(self, channel: str, message: bytes): ...
|
def publish(self, channel: str, message: bytes): ...
|
||||||
async def ping(self) -> None: ...
|
async def ping(self) -> None: ...
|
||||||
|
@ -52,7 +54,7 @@ def lazyConnection(
|
||||||
|
|
||||||
class ConnectionHandler: ...
|
class ConnectionHandler: ...
|
||||||
|
|
||||||
class RedisFactory:
|
class RedisFactory(protocol.ReconnectingClientFactory):
|
||||||
continueTrying: bool
|
continueTrying: bool
|
||||||
handler: RedisProtocol
|
handler: RedisProtocol
|
||||||
pool: List[RedisProtocol]
|
pool: List[RedisProtocol]
|
||||||
|
|
|
@ -20,6 +20,10 @@ from typing import TYPE_CHECKING, Generic, Optional, Type, TypeVar, cast
|
||||||
import attr
|
import attr
|
||||||
import txredisapi
|
import txredisapi
|
||||||
|
|
||||||
|
from twisted.internet.address import IPv4Address, IPv6Address
|
||||||
|
from twisted.internet.interfaces import IAddress, IConnector
|
||||||
|
from twisted.python.failure import Failure
|
||||||
|
|
||||||
from synapse.logging.context import PreserveLoggingContext, make_deferred_yieldable
|
from synapse.logging.context import PreserveLoggingContext, make_deferred_yieldable
|
||||||
from synapse.metrics.background_process_metrics import (
|
from synapse.metrics.background_process_metrics import (
|
||||||
BackgroundProcessLoggingContext,
|
BackgroundProcessLoggingContext,
|
||||||
|
@ -253,6 +257,37 @@ class SynapseRedisFactory(txredisapi.RedisFactory):
|
||||||
except Exception:
|
except Exception:
|
||||||
logger.warning("Failed to send ping to a redis connection")
|
logger.warning("Failed to send ping to a redis connection")
|
||||||
|
|
||||||
|
# ReconnectingClientFactory has some logging (if you enable `self.noisy`), but
|
||||||
|
# it's rubbish. We add our own here.
|
||||||
|
|
||||||
|
def startedConnecting(self, connector: IConnector):
|
||||||
|
logger.info(
|
||||||
|
"Connecting to redis server %s", format_address(connector.getDestination())
|
||||||
|
)
|
||||||
|
super().startedConnecting(connector)
|
||||||
|
|
||||||
|
def clientConnectionFailed(self, connector: IConnector, reason: Failure):
|
||||||
|
logger.info(
|
||||||
|
"Connection to redis server %s failed: %s",
|
||||||
|
format_address(connector.getDestination()),
|
||||||
|
reason.value,
|
||||||
|
)
|
||||||
|
super().clientConnectionFailed(connector, reason)
|
||||||
|
|
||||||
|
def clientConnectionLost(self, connector: IConnector, reason: Failure):
|
||||||
|
logger.info(
|
||||||
|
"Connection to redis server %s lost: %s",
|
||||||
|
format_address(connector.getDestination()),
|
||||||
|
reason.value,
|
||||||
|
)
|
||||||
|
super().clientConnectionLost(connector, reason)
|
||||||
|
|
||||||
|
|
||||||
|
def format_address(address: IAddress) -> str:
|
||||||
|
if isinstance(address, (IPv4Address, IPv6Address)):
|
||||||
|
return "%s:%i" % (address.host, address.port)
|
||||||
|
return str(address)
|
||||||
|
|
||||||
|
|
||||||
class RedisDirectTcpReplicationClientFactory(SynapseRedisFactory):
|
class RedisDirectTcpReplicationClientFactory(SynapseRedisFactory):
|
||||||
"""This is a reconnecting factory that connects to redis and immediately
|
"""This is a reconnecting factory that connects to redis and immediately
|
||||||
|
|
Loading…
Reference in a new issue