| | | 1 | | using System.Text.RegularExpressions; |
| | | 2 | | |
| | | 3 | | namespace OzonOrdersWeb.Observability; |
| | | 4 | | |
| | | 5 | | /// <summary> |
| | | 6 | | /// Отделяет события клиентской телеметрии, описывающие недоступность самого Studio2 или обрыв |
| | | 7 | | /// сети у браузера, от настоящих дефектов фронтенда. |
| | | 8 | | /// |
| | | 9 | | /// Во время деплоя контейнер перезапускается: часть запросов получает 502/503/504 от Nginx, |
| | | 10 | | /// часть обрывается на уже закрытом соединении и приходит в браузер как «сеть недоступна» |
| | | 11 | | /// (<c>XMLHttpRequest.status === 0</c>, <c>TypeError: Failed to fetch</c>). Для пользователя это |
| | | 12 | | /// покрыто модалкой <c>window.ServerAvailability</c>, для эксплуатации — health-мониторингом |
| | | 13 | | /// инстанса. Исправлять в коде фронтенда тут нечего, а <c>Scripts/log-watcher/studio2_log_watcher.py</c> |
| | | 14 | | /// заводит GitHub issue на каждую запись уровня Warning в <c>errors-*.log</c> — по одной на каждый |
| | | 15 | | /// упавший запрос. |
| | | 16 | | /// |
| | | 17 | | /// Поэтому такие события остаются в Seq и консоли (уровнем Information, всплеск по-прежнему виден), |
| | | 18 | | /// но не попадают в журнал отказов и не превращаются в issue. Правила намеренно узкие: смотрим |
| | | 19 | | /// либо HTTP-статус шлюза, либо тип события об обрыве соединения, либо явный текст сетевого сбоя. |
| | | 20 | | /// </summary> |
| | | 21 | | public static class FrontendOutageNoiseClassifier |
| | | 22 | | { |
| | | 23 | | /// <summary>Ответы Nginx, когда приложение за ним не отвечает или ещё поднимается.</summary> |
| | 1 | 24 | | private static readonly int[] GatewayStatusCodes = [502, 503, 504]; |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Виды событий, которые клиентская телеметрия отправляет именно при обрыве соединения: |
| | | 28 | | /// у XHR при этом <c>status === 0</c>, у fetch — <c>TypeError</c> без ответа. |
| | | 29 | | /// </summary> |
| | 1 | 30 | | private static readonly string[] ConnectionLossKinds = |
| | 1 | 31 | | [ |
| | 1 | 32 | | "AjaxNetworkError", |
| | 1 | 33 | | "FetchNetworkError", |
| | 1 | 34 | | "BrowserOffline" |
| | 1 | 35 | | ]; |
| | | 36 | | |
| | | 37 | | /// <summary> |
| | | 38 | | /// Формулировки браузеров и прикладного кода для «до сервера не дошли». Список закрытый: |
| | | 39 | | /// прикладная ошибка с собственным текстом сюда не попадает и остаётся отказом Studio2. |
| | | 40 | | /// </summary> |
| | 1 | 41 | | private static readonly string[] ConnectionLossMessages = |
| | 1 | 42 | | [ |
| | 1 | 43 | | "Failed to fetch", |
| | 1 | 44 | | "NetworkError when attempting to fetch resource", |
| | 1 | 45 | | "The network connection was lost", |
| | 1 | 46 | | "Load failed", |
| | 1 | 47 | | "Нет соединения с сервером", |
| | 1 | 48 | | "net::ERR_", |
| | 1 | 49 | | "ERR_NETWORK", |
| | 1 | 50 | | "ERR_CONNECTION" |
| | 1 | 51 | | ]; |
| | | 52 | | |
| | | 53 | | /// <summary> |
| | | 54 | | /// Прикладной код нередко ловит ответ шлюза сам и пишет его в консоль своим текстом |
| | | 55 | | /// («Bitrix: HTTP 502 error», «GetLatestSnapshot HTTP error: 502»). Тогда статус приходит |
| | | 56 | | /// только внутри сообщения, поэтому распознаём его и там. |
| | | 57 | | /// </summary> |
| | 1 | 58 | | private static readonly Regex GatewayStatusInMessage = new( |
| | 1 | 59 | | @"HTTP\D{0,12}(502|503|504)\b", |
| | 1 | 60 | | RegexOptions.IgnoreCase | RegexOptions.CultureInvariant | RegexOptions.Compiled, |
| | 1 | 61 | | TimeSpan.FromMilliseconds(100)); |
| | | 62 | | |
| | | 63 | | /// <summary> |
| | | 64 | | /// Сообщения библиотеки SignalR и прикладных обработчиков при штатном переподключении, |
| | | 65 | | /// таймауте рукопожатия или смене транспорта. |
| | | 66 | | /// </summary> |
| | 1 | 67 | | private static readonly string[] SignalRTransientMessages = |
| | 1 | 68 | | [ |
| | 1 | 69 | | "Handshake was canceled", |
| | 1 | 70 | | "Server returned handshake error", |
| | 1 | 71 | | "Timeout from HTTP request", |
| | 1 | 72 | | "The page is being frozen", |
| | 1 | 73 | | "SignalR connection transient error", |
| | 1 | 74 | | "Transient SignalR connection error", |
| | 1 | 75 | | "WebSocket closed with status code: 1006", |
| | 1 | 76 | | "Failed to complete negotiation with the server", |
| | 1 | 77 | | "Failed to start the transport" |
| | 1 | 78 | | ]; |
| | | 79 | | |
| | | 80 | | /// <summary> |
| | | 81 | | /// Известный некритичный шум фронтенда (ResizeObserver в сторонних библиотеках вроде AG Grid, |
| | | 82 | | /// штатные ошибки валидации при пакетной печати этикеток, отмена диалогов пользователем и т.п.). |
| | | 83 | | /// </summary> |
| | 1 | 84 | | private static readonly string[] BenignClientNoiseMessages = |
| | 1 | 85 | | [ |
| | 1 | 86 | | "ResizeObserver loop completed with undelivered notifications", |
| | 1 | 87 | | "ResizeObserver loop limit exceeded", |
| | 1 | 88 | | "Multi-order print error:", |
| | 1 | 89 | | "Отменено пользователем", |
| | 1 | 90 | | "AG Grid: warning #2", |
| | 1 | 91 | | "ag-grid.com/javascript-data-grid/errors/2" |
| | 1 | 92 | | ]; |
| | | 93 | | |
| | | 94 | | /// <summary> |
| | | 95 | | /// Событие описывает недоступность сервера, обрыв сети или известный некритичный шум фронтенда. |
| | | 96 | | /// </summary> |
| | | 97 | | public static bool IsServerOutageNoise(ClientTelemetryEvent input) |
| | 33 | 98 | | => IsGatewayFailure(input.StatusCode) |
| | 33 | 99 | | || IsConnectionLossKind(input.Kind) |
| | 33 | 100 | | || ContainsConnectionLossMessage(input.Message) |
| | 33 | 101 | | || MentionsGatewayStatus(input.Message) |
| | 33 | 102 | | || IsBadgeHtmlResponseNoise(input.Message) |
| | 33 | 103 | | || IsSignalRTransientNoise(input.Message) |
| | 33 | 104 | | || IsBenignClientNoise(input.Message) |
| | 33 | 105 | | || IsWarmupNoise(input); |
| | | 106 | | |
| | | 107 | | private static bool IsWarmupNoise(ClientTelemetryEvent input) |
| | | 108 | | { |
| | 9 | 109 | | var target = input.TargetUrl; |
| | 9 | 110 | | if (!string.IsNullOrWhiteSpace(target) && target.Contains("/warmup", StringComparison.OrdinalIgnoreCase)) |
| | 2 | 111 | | return true; |
| | | 112 | | |
| | 7 | 113 | | var message = input.Message; |
| | 7 | 114 | | return !string.IsNullOrWhiteSpace(message) && message.Contains("/warmup", StringComparison.OrdinalIgnoreCase); |
| | | 115 | | } |
| | | 116 | | |
| | | 117 | | private static bool IsBadgeHtmlResponseNoise(string? message) |
| | | 118 | | { |
| | 23 | 119 | | if (string.IsNullOrWhiteSpace(message)) |
| | 0 | 120 | | return false; |
| | | 121 | | |
| | 23 | 122 | | var isJsonHtmlMismatch = message.Contains("is not valid JSON", StringComparison.OrdinalIgnoreCase) |
| | 23 | 123 | | || message.Contains("Unexpected token '<'", StringComparison.OrdinalIgnoreCase); |
| | | 124 | | |
| | 23 | 125 | | if (!isJsonHtmlMismatch) |
| | 20 | 126 | | return false; |
| | | 127 | | |
| | 3 | 128 | | return message.Contains("FidStat anomaly badge", StringComparison.OrdinalIgnoreCase) |
| | 3 | 129 | | || message.Contains("непрочитанных сообщений", StringComparison.OrdinalIgnoreCase) |
| | 3 | 130 | | || message.Contains("GetLatestSnapshot", StringComparison.OrdinalIgnoreCase) |
| | 3 | 131 | | || message.Contains("GetTotalUnreadCount", StringComparison.OrdinalIgnoreCase); |
| | | 132 | | } |
| | | 133 | | |
| | | 134 | | private static bool MentionsGatewayStatus(string? message) |
| | 26 | 135 | | => !string.IsNullOrWhiteSpace(message) && GatewayStatusInMessage.IsMatch(message); |
| | | 136 | | |
| | | 137 | | private static bool IsGatewayFailure(int? statusCode) |
| | 33 | 138 | | => statusCode is not null && Array.IndexOf(GatewayStatusCodes, statusCode.Value) >= 0; |
| | | 139 | | |
| | | 140 | | private static bool IsConnectionLossKind(string? kind) |
| | | 141 | | { |
| | 31 | 142 | | if (string.IsNullOrWhiteSpace(kind)) |
| | 0 | 143 | | return false; |
| | | 144 | | |
| | 239 | 145 | | foreach (var known in ConnectionLossKinds) |
| | | 146 | | { |
| | 90 | 147 | | if (string.Equals(kind, known, StringComparison.OrdinalIgnoreCase)) |
| | 3 | 148 | | return true; |
| | | 149 | | } |
| | | 150 | | |
| | 28 | 151 | | return false; |
| | | 152 | | } |
| | | 153 | | |
| | | 154 | | private static bool ContainsConnectionLossMessage(string? message) |
| | | 155 | | { |
| | 28 | 156 | | if (string.IsNullOrWhiteSpace(message)) |
| | 0 | 157 | | return false; |
| | | 158 | | |
| | 482 | 159 | | foreach (var marker in ConnectionLossMessages) |
| | | 160 | | { |
| | 214 | 161 | | if (message.Contains(marker, StringComparison.OrdinalIgnoreCase)) |
| | 2 | 162 | | return true; |
| | | 163 | | } |
| | | 164 | | |
| | 26 | 165 | | return false; |
| | | 166 | | } |
| | | 167 | | |
| | | 168 | | private static bool IsSignalRTransientNoise(string? message) |
| | | 169 | | { |
| | 21 | 170 | | if (string.IsNullOrWhiteSpace(message)) |
| | 0 | 171 | | return false; |
| | | 172 | | |
| | 349 | 173 | | foreach (var marker in SignalRTransientMessages) |
| | | 174 | | { |
| | 156 | 175 | | if (message.Contains(marker, StringComparison.OrdinalIgnoreCase)) |
| | 5 | 176 | | return true; |
| | | 177 | | } |
| | | 178 | | |
| | 16 | 179 | | return false; |
| | | 180 | | } |
| | | 181 | | |
| | | 182 | | private static bool IsBenignClientNoise(string? message) |
| | | 183 | | { |
| | 16 | 184 | | if (string.IsNullOrWhiteSpace(message)) |
| | 0 | 185 | | return false; |
| | | 186 | | |
| | 16 | 187 | | var trimmed = message.Trim(); |
| | 16 | 188 | | if (string.Equals(trimmed, "cancel", StringComparison.OrdinalIgnoreCase) |
| | 16 | 189 | | || string.Equals(trimmed, "canceled", StringComparison.OrdinalIgnoreCase) |
| | 16 | 190 | | || string.Equals(trimmed, "cancelled", StringComparison.OrdinalIgnoreCase) |
| | 16 | 191 | | || string.Equals(trimmed, "Error: cancel", StringComparison.OrdinalIgnoreCase)) |
| | | 192 | | { |
| | 1 | 193 | | return true; |
| | | 194 | | } |
| | | 195 | | |
| | 178 | 196 | | foreach (var marker in BenignClientNoiseMessages) |
| | | 197 | | { |
| | 77 | 198 | | if (message.Contains(marker, StringComparison.OrdinalIgnoreCase)) |
| | 6 | 199 | | return true; |
| | | 200 | | } |
| | | 201 | | |
| | 9 | 202 | | return false; |
| | | 203 | | } |
| | | 204 | | } |