|
| 1 | +import os |
| 2 | +import random |
| 3 | +import threading |
| 4 | +from datetime import datetime, timezone |
| 5 | +from typing import Optional, List, Callable, TYPE_CHECKING, Any, Union |
| 6 | + |
| 7 | +from sentry_sdk.utils import format_timestamp, safe_repr |
| 8 | +from sentry_sdk.envelope import Envelope, Item, PayloadRef |
| 9 | + |
| 10 | +if TYPE_CHECKING: |
| 11 | + from sentry_sdk._types import Metric |
| 12 | + |
| 13 | + |
| 14 | +class MetricsBatcher: |
| 15 | + MAX_METRICS_BEFORE_FLUSH = 100 |
| 16 | + FLUSH_WAIT_TIME = 5.0 |
| 17 | + |
| 18 | + def __init__( |
| 19 | + self, |
| 20 | + capture_func, # type: Callable[[Envelope], None] |
| 21 | + ): |
| 22 | + # type: (...) -> None |
| 23 | + self._metric_buffer = [] # type: List[Metric] |
| 24 | + self._capture_func = capture_func |
| 25 | + self._running = True |
| 26 | + self._lock = threading.Lock() |
| 27 | + |
| 28 | + self._flush_event = threading.Event() # type: threading.Event |
| 29 | + |
| 30 | + self._flusher = None # type: Optional[threading.Thread] |
| 31 | + self._flusher_pid = None # type: Optional[int] |
| 32 | + |
| 33 | + def _ensure_thread(self): |
| 34 | + # type: (...) -> bool |
| 35 | + if not self._running: |
| 36 | + return False |
| 37 | + |
| 38 | + pid = os.getpid() |
| 39 | + if self._flusher_pid == pid: |
| 40 | + return True |
| 41 | + |
| 42 | + with self._lock: |
| 43 | + if self._flusher_pid == pid: |
| 44 | + return True |
| 45 | + |
| 46 | + self._flusher_pid = pid |
| 47 | + |
| 48 | + self._flusher = threading.Thread(target=self._flush_loop) |
| 49 | + self._flusher.daemon = True |
| 50 | + |
| 51 | + try: |
| 52 | + self._flusher.start() |
| 53 | + except RuntimeError: |
| 54 | + self._running = False |
| 55 | + return False |
| 56 | + |
| 57 | + return True |
| 58 | + |
| 59 | + def _flush_loop(self): |
| 60 | + # type: (...) -> None |
| 61 | + while self._running: |
| 62 | + self._flush_event.wait(self.FLUSH_WAIT_TIME + random.random()) |
| 63 | + self._flush_event.clear() |
| 64 | + self._flush() |
| 65 | + |
| 66 | + def add( |
| 67 | + self, |
| 68 | + metric, # type: Metric |
| 69 | + ): |
| 70 | + # type: (...) -> None |
| 71 | + if not self._ensure_thread() or self._flusher is None: |
| 72 | + return None |
| 73 | + |
| 74 | + with self._lock: |
| 75 | + self._metric_buffer.append(metric) |
| 76 | + if len(self._metric_buffer) >= self.MAX_METRICS_BEFORE_FLUSH: |
| 77 | + self._flush_event.set() |
| 78 | + |
| 79 | + def kill(self): |
| 80 | + # type: (...) -> None |
| 81 | + if self._flusher is None: |
| 82 | + return |
| 83 | + |
| 84 | + self._running = False |
| 85 | + self._flush_event.set() |
| 86 | + self._flusher = None |
| 87 | + |
| 88 | + def flush(self): |
| 89 | + # type: (...) -> None |
| 90 | + self._flush() |
| 91 | + |
| 92 | + @staticmethod |
| 93 | + def _metric_to_transport_format(metric): |
| 94 | + # type: (Metric) -> Any |
| 95 | + def format_attribute(val): |
| 96 | + # type: (Union[int, float, str, bool]) -> Any |
| 97 | + if isinstance(val, bool): |
| 98 | + return {"value": val, "type": "boolean"} |
| 99 | + if isinstance(val, int): |
| 100 | + return {"value": val, "type": "integer"} |
| 101 | + if isinstance(val, float): |
| 102 | + return {"value": val, "type": "double"} |
| 103 | + if isinstance(val, str): |
| 104 | + return {"value": val, "type": "string"} |
| 105 | + return {"value": safe_repr(val), "type": "string"} |
| 106 | + |
| 107 | + res = { |
| 108 | + "timestamp": metric["timestamp"], |
| 109 | + "trace_id": metric["trace_id"], |
| 110 | + "name": metric["name"], |
| 111 | + "type": metric["type"], |
| 112 | + "value": metric["value"], |
| 113 | + "attributes": { |
| 114 | + k: format_attribute(v) for (k, v) in metric["attributes"].items() |
| 115 | + }, |
| 116 | + } |
| 117 | + |
| 118 | + if metric.get("span_id") is not None: |
| 119 | + res["span_id"] = metric["span_id"] |
| 120 | + |
| 121 | + if metric.get("unit") is not None: |
| 122 | + res["unit"] = metric["unit"] |
| 123 | + |
| 124 | + return res |
| 125 | + |
| 126 | + def _flush(self): |
| 127 | + # type: (...) -> Optional[Envelope] |
| 128 | + |
| 129 | + envelope = Envelope( |
| 130 | + headers={"sent_at": format_timestamp(datetime.now(timezone.utc))} |
| 131 | + ) |
| 132 | + with self._lock: |
| 133 | + if len(self._metric_buffer) == 0: |
| 134 | + return None |
| 135 | + |
| 136 | + envelope.add_item( |
| 137 | + Item( |
| 138 | + type="trace_metric", |
| 139 | + content_type="application/vnd.sentry.items.trace-metric+json", |
| 140 | + headers={ |
| 141 | + "item_count": len(self._metric_buffer), |
| 142 | + }, |
| 143 | + payload=PayloadRef( |
| 144 | + json={ |
| 145 | + "items": [ |
| 146 | + self._metric_to_transport_format(metric) |
| 147 | + for metric in self._metric_buffer |
| 148 | + ] |
| 149 | + } |
| 150 | + ), |
| 151 | + ) |
| 152 | + ) |
| 153 | + self._metric_buffer.clear() |
| 154 | + |
| 155 | + self._capture_func(envelope) |
| 156 | + return envelope |
0 commit comments