Python日志发送：为SysLogHandler添加连接超时机制

import logging
import logging.handlers
import socket
import sys
import time

# 假设的Syslog服务器地址和端口
# 在实际部署中，请替换为您的远程Syslog服务器地址
SyslogServer = '127.0.0.1' # 示例：指向本地回环地址
SyslogPort = 514 # TCP Syslog默认端口，如果使用UDP通常是514或5140

# 全局日志器字典，用于缓存已配置的日志器
loggers = {}

class SysLogHandlerCustomTimeout(logging.handlers.SysLogHandler):
    """
    自定义SysLogHandler，用于在套接字连接和发送时设置超时。
    """
    def __init__(self, address, socktype=socket.SOCK_STREAM, timeout_seconds=10):
        # 使用Python 2.7/3 兼容的super() 调用父类构造函数
        super(SysLogHandlerCustomTimeout, self).__init__(address, socktype=socktype)
        self.timeout_seconds = timeout_seconds

    def createSocket(self):
        """
        重写createSocket方法，在创建套接字后设置超时。
        此方法在处理器首次尝试发送日志时被调用。
        """
        # 调用父类的createSocket方法来创建套接字
        # Python 2.7/3 兼容的super() 调用
        super(SysLogHandlerCustomTimeout, self).createSocket()

        # 检查套接字是否成功创建，并设置超时
        if self.socket:
            self.socket.settimeout(self.timeout_seconds)
        else:
            # 理论上父类的createSocket不会返回None，但作为防御性编程可保留
            raise IOError("Failed to create socket for SysLogHandler.")

def writeSyslog (mtype, msg):
    """
    发送消息/日志到Syslog服务器。
    此函数整合了自定义超时处理器和日志器缓存逻辑。
    """
    try:
        global loggers
        logger_name = 'SplunkLogger' # 定义日志器名称

        # 检查日志器是否已存在于缓存中
        if loggers.get(logger_name):
            splunk_logger = loggers.get(logger_name)
        else:
            # 如果日志器不存在，则创建并配置它
            # 使用自定义的SysLogHandlerCustomTimeout
            handler = SysLogHandlerCustomTimeout(
                address = (SyslogServer, SyslogPort),
                socktype = socket.SOCK_STREAM, # 示例：使用TCP协议
                timeout_seconds = 5 # 设置5秒的连接和发送超时
            )
            # 设置日志格式
            formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
            handler.setFormatter(formatter)

            # 获取或创建名为'SplunkLogger'的日志器
            splunk_logger = logging.getLogger(logger_name)
            # 避免重复添加handler，确保只添加一次
            if not splunk_logger.handlers:
                splunk_logger.addHandler(handler)

            # 将配置好的日志器存入缓存
            loggers[logger_name] = splunk_logger

        # 根据消息类型发送日志
        if "emerg" in mtype:
            splunk_logger.emergency(msg)
        elif "alert" in mtype:
            splunk_logger.alert(msg)
        elif "crit" in mtype:
            splunk_logger.critical(msg)
        elif "err" in mtype:
            splunk_logger.error(msg)
        elif "warn" in mtype:
            splunk_logger.warning(msg)
        elif "notice" in mtype:
            splunk_logger.notice(msg)
        elif "info" in mtype:
            splunk_logger.info(msg)
        else:
            splunk_logger.debug(msg)

    except socket.timeout:
        # 捕获套接字超时异常
        sys.stdout.write(f"\t\tSyslog sending timed out to {SyslogServer}:{SyslogPort}\n")
    except Exception as e:
        # 捕获其他可能的网络或I/O异常
        sys.stdout.write(f"\t\tSyslog failed sending to {SyslogServer}:{SyslogPort} with error: {e}\n")

# 示例用法
if __name__ == "__main__":
    print(f"尝试向 {SyslogServer}:{SyslogPort} 发送日志...")

    # 假设远程Syslog服务器未运行，或网络不通
    # 在这种情况下，日志发送操作将在5秒后因超时而失败
    writeSyslog("info", "这是一条测试信息，期望在超时后失败。")
    time.sleep(1) # 稍作等待，模拟发送多条日志
    writeSyslog("error", "另一条错误信息。")

    print("日志发送尝试完成。请检查控制台输出以确认超时行为。")

    # 如果有实际的Syslog服务器运行在指定地址和端口，可以测试成功发送
    # SyslogServer = 'your_actual_syslog_server_ip'
    # SyslogPort = 514
    # writeSyslog("info", "这是一条成功发送的测试信息。")