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
|
import errno
import socket
import struct
import threading
import time
import traceback
import msgpack
_global_sender = None
def _set_global_sender(sender): # pragma: no cover
"""[For testing] Function to set global sender directly"""
global _global_sender
_global_sender = sender
def setup(tag, **kwargs): # pragma: no cover
global _global_sender
_global_sender = FluentSender(tag, **kwargs)
def get_global_sender(): # pragma: no cover
return _global_sender
def close(): # pragma: no cover
get_global_sender().close()
class EventTime(msgpack.ExtType):
def __new__(cls, timestamp, nanoseconds=None):
seconds = int(timestamp)
if nanoseconds is None:
nanoseconds = int(timestamp % 1 * 10**9)
return super().__new__(
cls,
code=0,
data=struct.pack(">II", seconds, nanoseconds),
)
@classmethod
def from_unix_nano(cls, unix_nano):
seconds, nanos = divmod(unix_nano, 10**9)
return cls(seconds, nanos)
class FluentSender:
def __init__(
self,
tag,
host="localhost",
port=24224,
bufmax=1 * 1024 * 1024,
timeout=3.0,
verbose=False,
buffer_overflow_handler=None,
nanosecond_precision=False,
msgpack_kwargs=None,
*,
forward_packet_error=True,
**kwargs,
):
"""
:param kwargs: This kwargs argument is not used in __init__. This will be removed in the next major version.
"""
self.tag = tag
self.host = host
self.port = port
self.bufmax = bufmax
self.timeout = timeout
self.verbose = verbose
self.buffer_overflow_handler = buffer_overflow_handler
self.nanosecond_precision = nanosecond_precision
self.forward_packet_error = forward_packet_error
self.msgpack_kwargs = {} if msgpack_kwargs is None else msgpack_kwargs
self.socket = None
self.pendings = None
self.lock = threading.Lock()
self._closed = False
self._last_error_threadlocal = threading.local()
def emit(self, label, data):
if self.nanosecond_precision:
cur_time = EventTime.from_unix_nano(time.time_ns())
else:
cur_time = int(time.time())
return self.emit_with_time(label, cur_time, data)
def emit_with_time(self, label, timestamp, data):
try:
bytes_ = self._make_packet(label, timestamp, data)
except Exception as e:
if not self.forward_packet_error:
raise
self.last_error = e
bytes_ = self._make_packet(
label,
timestamp,
{
"level": "CRITICAL",
"message": "Can't output to log",
"traceback": traceback.format_exc(),
},
)
return self._send(bytes_)
@property
def last_error(self):
return getattr(self._last_error_threadlocal, "exception", None)
@last_error.setter
def last_error(self, err):
self._last_error_threadlocal.exception = err
def clear_last_error(self, _thread_id=None):
if hasattr(self._last_error_threadlocal, "exception"):
delattr(self._last_error_threadlocal, "exception")
def close(self):
with self.lock:
if self._closed:
return
self._closed = True
if self.pendings:
try:
self._send_data(self.pendings)
except Exception:
self._call_buffer_overflow_handler(self.pendings)
self._close()
self.pendings = None
def _make_packet(self, label, timestamp, data):
if label:
tag = f"{self.tag}.{label}" if self.tag else label
else:
tag = self.tag
if self.nanosecond_precision and isinstance(timestamp, float):
timestamp = EventTime(timestamp)
packet = (tag, timestamp, data)
if self.verbose:
print(packet)
return msgpack.packb(packet, **self.msgpack_kwargs)
def _send(self, bytes_):
with self.lock:
if self._closed:
return False
return self._send_internal(bytes_)
def _send_internal(self, bytes_):
# buffering
if self.pendings:
self.pendings += bytes_
bytes_ = self.pendings
try:
self._send_data(bytes_)
# send finished
self.pendings = None
return True
except OSError as e:
self.last_error = e
# close socket
self._close()
# clear buffer if it exceeds max buffer size
if self.pendings and (len(self.pendings) > self.bufmax):
self._call_buffer_overflow_handler(self.pendings)
self.pendings = None
else:
self.pendings = bytes_
return False
def _check_recv_side(self):
try:
self.socket.settimeout(0.0)
try:
recvd = self.socket.recv(4096)
except OSError as recv_e:
if recv_e.errno != errno.EWOULDBLOCK:
raise
return
if recvd == b"":
raise OSError(errno.EPIPE, "Broken pipe")
finally:
self.socket.settimeout(self.timeout)
def _send_data(self, bytes_):
# reconnect if possible
self._reconnect()
# send message
bytes_to_send = len(bytes_)
bytes_sent = 0
self._check_recv_side()
while bytes_sent < bytes_to_send:
sent = self.socket.send(bytes_[bytes_sent:])
if sent == 0:
raise OSError(errno.EPIPE, "Broken pipe")
bytes_sent += sent
self._check_recv_side()
def _reconnect(self):
if not self.socket:
try:
if self.host.startswith("unix://"):
sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
sock.settimeout(self.timeout)
sock.connect(self.host[len("unix://") :])
else:
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.settimeout(self.timeout)
# This might be controversial and may need to be removed
sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
sock.connect((self.host, self.port))
except Exception as e:
try:
sock.close()
except Exception: # pragma: no cover
pass
raise e
else:
self.socket = sock
def _call_buffer_overflow_handler(self, pending_events):
try:
if self.buffer_overflow_handler:
self.buffer_overflow_handler(pending_events)
except Exception:
# User should care any exception in handler
pass
def _close(self):
try:
sock = self.socket
if sock:
try:
try:
sock.shutdown(socket.SHUT_RDWR)
except OSError: # pragma: no cover
pass
finally:
try:
sock.close()
except OSError: # pragma: no cover
pass
finally:
self.socket = None
def __enter__(self):
return self
def __exit__(self, typ, value, traceback):
try:
self.close()
except Exception as e: # pragma: no cover
self.last_error = e
|