|
| 1 | +from typing import Any |
| 2 | + |
| 3 | +from sentry.metrics.base import MetricsBackend, Tags |
| 4 | +from sentry.metrics.dummy import DummyMetricsBackend |
| 5 | +from sentry.metrics.minimetrics import MiniMetricsMetricsBackend |
| 6 | +from sentry.utils.imports import import_string |
| 7 | + |
| 8 | +__all__ = ["CompositeExperimentalMetricsBackend"] |
| 9 | + |
| 10 | + |
| 11 | +class CompositeExperimentalMetricsBackend(MetricsBackend): |
| 12 | + def __init__(self, **kwargs: Any): |
| 13 | + super().__init__() |
| 14 | + self._initialize_backends( |
| 15 | + kwargs.pop("primary_backend", None), kwargs.pop("primary_backend_args", {}) |
| 16 | + ) |
| 17 | + self._deny_prefixes = tuple(kwargs.pop("deny_prefixes", [])) |
| 18 | + |
| 19 | + def _initialize_backends( |
| 20 | + self, primary_backend: str | None, primary_backend_args: dict[str, Any] |
| 21 | + ): |
| 22 | + # If we don't have a primary metrics backend we default to the dummy, which won't do anything. |
| 23 | + if primary_backend is None: |
| 24 | + self._primary_backend: MetricsBackend = DummyMetricsBackend() |
| 25 | + else: |
| 26 | + cls: type[MetricsBackend] = import_string(primary_backend) |
| 27 | + self._primary_backend = cls(**primary_backend_args) |
| 28 | + |
| 29 | + self._minimetrics: MiniMetricsMetricsBackend = MiniMetricsMetricsBackend() |
| 30 | + |
| 31 | + def _is_denied(self, key: str) -> bool: |
| 32 | + return key.startswith(self._deny_prefixes) |
| 33 | + |
| 34 | + @staticmethod |
| 35 | + def _minimetrics_sample_rate() -> float: |
| 36 | + # Previously bound to options.get("delightful_metrics.minimetrics_sample_rate") |
| 37 | + # but this option check was resulting in excessive cache misses somehow. |
| 38 | + |
| 39 | + return 1.0 |
| 40 | + |
| 41 | + def incr( |
| 42 | + self, |
| 43 | + key: str, |
| 44 | + instance: str | None = None, |
| 45 | + tags: Tags | None = None, |
| 46 | + amount: float | int = 1, |
| 47 | + sample_rate: float = 1, |
| 48 | + unit: str | None = None, |
| 49 | + stacklevel: int = 0, |
| 50 | + ) -> None: |
| 51 | + self._primary_backend.incr(key, instance, tags, amount, sample_rate, unit) |
| 52 | + if not self._is_denied(key): |
| 53 | + self._minimetrics.incr( |
| 54 | + key, |
| 55 | + instance, |
| 56 | + tags, |
| 57 | + amount, |
| 58 | + self._minimetrics_sample_rate(), |
| 59 | + unit, |
| 60 | + stacklevel=stacklevel + 1, |
| 61 | + ) |
| 62 | + |
| 63 | + def timing( |
| 64 | + self, |
| 65 | + key: str, |
| 66 | + value: float, |
| 67 | + instance: str | None = None, |
| 68 | + tags: Tags | None = None, |
| 69 | + sample_rate: float = 1, |
| 70 | + stacklevel: int = 0, |
| 71 | + ) -> None: |
| 72 | + self._primary_backend.timing(key, value, instance, tags, sample_rate) |
| 73 | + if not self._is_denied(key): |
| 74 | + self._minimetrics.timing( |
| 75 | + key, |
| 76 | + value, |
| 77 | + instance, |
| 78 | + tags, |
| 79 | + self._minimetrics_sample_rate(), |
| 80 | + stacklevel=stacklevel + 1, |
| 81 | + ) |
| 82 | + |
| 83 | + def gauge( |
| 84 | + self, |
| 85 | + key: str, |
| 86 | + value: float, |
| 87 | + instance: str | None = None, |
| 88 | + tags: Tags | None = None, |
| 89 | + sample_rate: float = 1, |
| 90 | + unit: str | None = None, |
| 91 | + stacklevel: int = 0, |
| 92 | + ) -> None: |
| 93 | + self._primary_backend.gauge(key, value, instance, tags, sample_rate, unit) |
| 94 | + if not self._is_denied(key): |
| 95 | + self._minimetrics.gauge( |
| 96 | + key, |
| 97 | + value, |
| 98 | + instance, |
| 99 | + tags, |
| 100 | + self._minimetrics_sample_rate(), |
| 101 | + unit, |
| 102 | + stacklevel=stacklevel + 1, |
| 103 | + ) |
| 104 | + |
| 105 | + def distribution( |
| 106 | + self, |
| 107 | + key: str, |
| 108 | + value: float, |
| 109 | + instance: str | None = None, |
| 110 | + tags: Tags | None = None, |
| 111 | + sample_rate: float = 1, |
| 112 | + unit: str | None = None, |
| 113 | + stacklevel: int = 0, |
| 114 | + ) -> None: |
| 115 | + self._primary_backend.distribution(key, value, instance, tags, sample_rate, unit) |
| 116 | + # We share the same option between timing and distribution, since they are both distribution |
| 117 | + # metrics. |
| 118 | + if not self._is_denied(key): |
| 119 | + self._minimetrics.distribution( |
| 120 | + key, |
| 121 | + value, |
| 122 | + instance, |
| 123 | + tags, |
| 124 | + self._minimetrics_sample_rate(), |
| 125 | + unit, |
| 126 | + stacklevel=stacklevel + 1, |
| 127 | + ) |
| 128 | + |
| 129 | + def event( |
| 130 | + self, |
| 131 | + title: str, |
| 132 | + message: str, |
| 133 | + alert_type: str | None = None, |
| 134 | + aggregation_key: str | None = None, |
| 135 | + source_type_name: str | None = None, |
| 136 | + priority: str | None = None, |
| 137 | + instance: str | None = None, |
| 138 | + tags: Tags | None = None, |
| 139 | + stacklevel: int = 0, |
| 140 | + ) -> None: |
| 141 | + self._primary_backend.event( |
| 142 | + title, |
| 143 | + message, |
| 144 | + alert_type, |
| 145 | + aggregation_key, |
| 146 | + source_type_name, |
| 147 | + priority, |
| 148 | + instance, |
| 149 | + tags, |
| 150 | + stacklevel + 1, |
| 151 | + ) |
0 commit comments