Сообщение об ошибке, от которого не горит

Мне тут бомбануло на днях. А блог, как известно, нужен для того, чтобы туда ныть, когда бомбануло, собственно — оттуда и пост.

Сижу, значит, программирую, внезапно консоль заливает красным, и вылезает вот это:

Uncaught Error: Bad dependency path or symbol.
  // стектрейс из скомпилированного (!) кода...
  // стектрейс из внутренних библиотечных функций...
  //
  // скомпилированного... напомню, это dev-режим.

Да, это сообщение об ошибке.
Да, это всё сообщение.
И да, это плохое сообщение.

Дальше — простыня, почему оно плохое.

Как надо

Хорошее сообщение об ошибке следует двум главным принципам:

  1. Оно опирается на факт, что всё горит, и починить ошибку надо немедленно.
  2. Заботится о разработчике, а не обвиняет его в глупости.

Из этих принципов я бы вывел 4 правила, что хорошее сообщение:

  1. Говорит, что именно сломалось — какой модуль, функция и т. д.
  2. Где именно сломалось — как ошибку найти.
  3. Почему оно сломалось — как ошибку воспроизвести, что не сходится.
  4. Как это починить — что на что заменить, чтобы заработало.

Говорит, что именно сломалось

— Ваше приложение не работает.
— Да, но почему?
— Потому что оно сломалось
¯\_(ツ)_/¯

То, что приложение не работает, я уже знаю — оно, блин, не работает. Мне как бы нужно понять из‑за чего.

В ошибке выше, вроде, даже написано, что сломалось, вот — Bad dependency path or symbol. Но что именно‑то: bad dependency path или bad symbol? Если символ, то какой? Если путь до зависимости, то до какой?

Почему бы, например, не сделать так?

Bad dependency path.
  Cannot find module "superModule".

Указывает, где сломалось

Чтобы что‑то починить, надо исправить код. Чтобы в коде что‑то исправить, надо найти, что
— Ваш Кэп

В эпоху до сборки фронтенда (помните, IE7, FTP, jQuery, эх!..) всё было просто. Стектрейс сам говорил, на какой строке беда. Сейчас браузерный стектрейс может не помочь.

Указывать на ошибку в скомпилированном (а тем более минифицированном) коде — бесполезно чуть более, чем полностью. Рассказывать надо об исходниках: модуль, функция, строка, символ — вот что нужно, чтобы быстро найти ошибку.

Bad dependency path at line 42, character 88 in "entryPoint.js".
  Cannot find module "superModule".

Объясняет, почему оно сломалось

С любовью, вечно ваш «undefined is not a function»

Да, если произошла низкоуровневая ошибка, синтаксическая например, надо об этом написать. Но undefined is not whatever как бы так сказать, is not enough. Ткните, пожалуйста, носом в то место, которое не работает: в поле объекта, название функции, метода.

Если произошла высокоуровневая ошибка, объясните, что именно пошло не так: почему здесь нужен другой аргумент, зачем указывать абсолютный путь и т. д. Дайте ссылку на документацию, это полезно. Даже если документация скудная. Даже если API в ней не нуждается.

Bad dependency path at line 42, character 88 in "entryPoint.js".
  Cannot find module "superModule".
  Expected one of extensions: "js", "jsx", "ts", "tsx", "mjs", but tried to import "".

Инструктирует, как починить

— Хм, а как это починить?
— Ну вы держитесь здесь, вам всего доброго, хорошего настроения и здоровья

Допустим, стало понятно, что именно сломалось. Если сообщение об ошибке рассказывает, как чинить — это прекрасно.

Самый человечный, но и самый ресурсозатратный способ — рассказать по шагам, что надо сделать, чтобы ошибка исчезла. Так, например, делает React в режиме разработки.

Ещё один хороший способ — показать примеры работы функции, что она вернёт при каких аргументах. Так делает Lodash в jsdoc и многие модули Python в docstring.

Да, это запарно. Но разработчики скажут спасибо.

Bad dependency at line 42, character 88 in "entryPoint.js".
  Cannot find module "superModule".
  Expected one of extensions: "js", "jsx", "ts", "tsx", "mjs", but tried to import "".
  Check your import extension and make sure file exists.
  Note that this lib supports only imports with direct link to a file with its extension.

Опирается на факт, что всё горит

Тут всё как у Ситника в докладе о продвижении проектов.

Разработчики не читают логи с ошибками в кресле под уютным пледиком. Дайте нужное, кратко, точно, с примерами.

Заботится о разработчике

Даже если все пункты выше соблюдены, но сообщение об ошибке обвиняет разработчиков, что те «тупые, лол», то никому нафиг не упало такое сообщение.

Разработчики не тупые. Им может не хватать контекста, знаний, опыта. А ещё бывает, что другой third‑party код конфликтует с вашим, или браузер лагает, или интерпретатор, или сеть, или железо… ну вы поняли.

Ну и вообще…

Это всё — просто эффективная коммуникация и желание помочь. Ильяхов в Правилах деловой переписки писал подобное. А сообщение об ошибке — чем не переписка?

В общем, с каждым заботливым и полезным сообщением об ошибках на Земле становится на одного плачущего разработчика меньше.

Ссылки в конце поста

Из моего блога:

Из внешнего интернета:

С кодом:

Прага, август 2019

Летняя Прага круче зимней.

Первое, что бросилось в глаза — вода. Зимой Влтава не притягивает взгляд так, как она это делает летом. Вы только посмотрите:

Вид на Влтаву с Карлова моста

Ну и в целом город летом почему‑то интереснее разглядывать. То ли деталей больше видно, то ли просто тепло и не надо никуда бежать греться:

Вид на берег реки
Вид на Пороховую башню снизу
Площадь перед Астрономическими часами
Трамваи на фоне Пражского Града

О транспортной системе я задвигал уже в прошлый раз. Сегодня покажу музей общественного транспорта.

Музей находится на месте старого трамвайного депо. Трамваи в нём на ходу, раз в год устраивают фестиваль, и их прокатывают по городу.

Трамваи в музее — 1
Трамваи в музее — 2
Трамваи в музее — 3
Трамваи в музее — 4

С транспортом там вообще кайф. Например, фуникулёр до Вышеграда тоже считается общественным транспортом, поэтому на него отдельный билет не нужен.

Сам Вышеград не особо интересен, если только не забираться на смотровую площадку. Оттуда иногда между деревьев можно разглядеть интересное:

Вид на Прагу со смотровой площадки в Вышеграде

А вот место, от которого я совсем ничего не ожидал, оказалось самым офигенным — Летенские сады.

Летенские сады — 1
Летенские сады — 2

Парк — на возвышении, рядом с рекой, оттуда открывается отличный вид на весь город. Ночью там диджеи фигачат отличную музыку. Не знаю, насколько фотография сможет передать атмосферу:

Вид на город и фестиваль одновременно

Из мест, куда не особо рекомендую, — музей Кафки. Ну там типа такое, ачивка разве что.

Музей Кафки — 1
Музей Кафки — 2

Относительно хороший — музей современного искусства.

Музей современного искусства

Он умело «разговаривает» с посетителями:

Навигация в музее

Да и экспозиция была норм:

Экспозиция — 1
Экспозиция — 2

— Вот, собрал из говна и палок.
— Но это же просто палка, воткнутая в говно!
— Ну да…

(Спёр отсюда.)

Палка, воткнутая в говно

Классно там в общем — прилетайте.

Мир

Паттерны отказоустойчивых приложений. Часть 2

В прошлый раз мы прочитали главы 1–4 и рассмотрели понятия отказоустойчивости, принципы отказоустойчивого дизайна и архитектурные паттерны.

В этой части рассмотрим паттерны обнаружения ошибок, восстановления от них, снижения их вероятности и «замазывания брешей».

Глава 5. Паттерны обнаружения ошибок

Ошибки и неисправности должны быть обнаружены. Есть два распространённых механизма для обнаружения ошибок. Первый — проверить, что возвращает функция, есть ли там коды ошибок. Второй — использовать встроенные в язык исключения и конструкции try‑catch. Когда ошибки обнаружены, они должны быть изолированы, чтобы не распространиться по системе.

5.12. Соотношение отказов (Fault correlation)

Какой отказ проявляется?

Определите уникальные признаки ошибки, чтобы понять категорию отказа. Как только ошибка определена, вокруг неё необходимо построить Барьер содержащий ошибку (Error containment barrier), чтобы предотвратить распространение.

5.13. Барьер, содержащий ошибку (Error containment barrier)

Что система должна сделать в первую очередь при обнаружении ошибки?

Последствия ошибки не всегда могут быть предсказаны заранее. Как и не все потенциальные ошибки могут быть предсказаны. Ошибки перемещаются от компонента к компоненту системы, если для этого нет ограничений. В программах барьер для распространения — это Блок уменьшения риска (Unit of mitigation).

5.14. Полное сравнение (Complete parameter checking)

Как может быть уменьшено время от появления отказа до обнаружения ошибки?

Создавайте проверки для данных, аргументов функций и результатов вычислений. Любая проверка повышает надёжность системы и уменьшает время между появлением отказа и обнаружением ошибки. В то же время проверки снижают производительность.

(Это, кстати, напоминает контрактное программирование.)

5.15. Мониторинг системы (System Monitor)

Как одна часть системы может понять, что другая часть жива и функционирует?

Если при наступлении отказа часть системы может уведомить остальные части о своём состоянии, восстановление может начаться быстрее. Можно положиться на Сообщения подтверждения (Acknowledgement messages) — это сообщения, которые компоненты системы передают друг другу в ответ на какие‑то события. Другой способ — создать часть системы, которая будет смотреть за состоянием компонентов сама.

Когда наблюдаемый компонент перестаёт функционировать, об этом следует сообщить Наблюдателю отказов. При внедрении Мониторинга системы (System monitoring) необходимо определить, задержку после которой сообщение об отказе будет отправлено Наблюдателю отказов.

5.16. Пульс (Heartbeat)

Как Мониторинг системы может быть уверен, что конкретная наблюдаемая задача всё ещё работает?

Иногда компонент, за которым наблюдают, понятия не имеет, что за ним наблюдают. В таких случаях Мониторинг системы (System monitoring) должен запросить отчёт о состоянии, Пульс (Heartbeat). Проверьте, чтобы у Пульса не было нежелаемых побочных эффектов.

5.17. Подтверждение (Acknowledgement)

При общении двух компонентов какой самый простой способ для одного из них определить, что другой жив и функционирует?

Один из способов — добавить подтверждающую информацию в ответ, который будет отправлен другому компоненту. Минус в том, что если к компоненту нет запросов, то от него нет и ответов, а стало быть — и подтверждающей информации.

5.18. Сторожевой пёс (Watchdog)

Как определить, что компонент жив и функционирует, если добавить Подтверждение нельзя?

Один из способов — наблюдать за действиями, которые происходят регулярно. Второй способ — проставить временную метку о начале операции и проверить, что операция закончилась в удовлетворительный отрезок времени.

5.19. Реалистичный порог (Realistic Threshold)

Как много времени должно пройти, прежде чем Мониторинг системы отправит сообщение об отказе?

Здесь нам интересны два отрезка: задержка обнаружения (detection latency) и задержка сообщений (messaging latency). Первая — сколько времени Мониторинг системы должен ждать ответа от компонента. Вторая — время между запросами, которое определяет статус компонента. Неадекватно подобранные значения снизят производительность.

Выставляйте задержку сообщений (messaging latency), исходя из худшего возможного времени коммуникации + время на обработку Пульса. Выставляйте задержку обнаружения (detection latency), исходя из критичности компонента.

5.20. Существующие метрики (Existing Metrics)

Как система может измерить интенсивность перегрузки, не увеличивая перегрузку?

Используйте встроенные механизмы индикации перегрузки системы ¯\_(ツ)_/¯

5.21. Голосование (Voting)

Получилось несколько вариантов результатов. Какой использовать?

Разработайте стратегию голосования, чтобы выбрать ответ. Пропишите веса для каждого из ответов. Можно сделать предположение, что активный элемент — тот, чьему результату можно доверять с большей вероятностью. Если ответы слишком большие, чтобы проверить их полностью, можно использовать Чексумму (Checksum).

Аккуратнее с результатами, которые могут быть разными, но в то же время правильными. Для таких ответов надо проверять не «правильность», а корректность.

5.22. Рутинное тех. обслуживание (Routine Maintenance)

Как сделать, чтобы ошибки, которые можно предотвратить, не случались?

Проводите рутинное, превентивное обслуживание системы. Корректировочные аудиты (Correcting audits) сохранят данные чистыми и без ошибок. Периодично повторяемые, они становятся Рутинными аудитами (Routine audtis).

5.23. Рутинные упражнения (Routine Exercises)

Как удостовериться, что избыточные элементы начнут работать при наступлении ошибки?

Время от времени запускайте систему в режиме, при котором избыточные элементы должны начинать работать. Это поможет определить элементы со скрытыми отказами.

5.24. Рутинные аудиты (Routine audtis)

Данные с ошибками могут находиться в памяти очень долго до того, как приведут к отказу.

Время от времени проверяйте сохранённые данные на скрытые ошибки. Проверки должны проводиться во время, когда система не под нагрузкой.

5.25. Чексумма (Checksum)

Как определить, что полученное значение некорректно?

Добавьте Чексумму для значения или группы значений, используйте её, как подтверждение, что данные корректны.

5.27. Дырявое ведро (Leaky bucket counter)

Как система может определить, постоянная это ошибка или временная?

Внутри каждого Блока уменьшения риска используйте счётчик, который увеличивается при появлении ошибки. Периодически счётчик уменьшается, но не становится меньше, чем его исходное значение. Если счётчик достигает определённого предела, значит ошибка постоянная и появляется часто.

Глава 6. Паттерны восстановления от ошибок

Восстановление по большей части состоит из двух частей: отменить нежелаемые эффекты ошибки, воссоздать безошибочное окружение для системы, чтобы она смогла продолжить функционировать.

6.28. Карантин (Quarantine)

Как система может оградить ошибку от распространения?

Создайте барьер, который оградит систему от негативного влияния ошибки на полезную работу и от распространения ошибки в другие части системы.

6.29. Интенсивное восстановление (Concentrate recovery)

Как системе уменьшить время, в которое она недоступна, при восстановлении от ошибки?

Сконцентрируйте все доступные и необходимые ресурсы на задаче восстановления, чтобы уменьшить время восстановления.

6.30. Обработчик ошибок (Error handler)

Обработка ошибок увеличивает сложность и дороговизну разработки и поддержки программы.

Обработка ошибок — это не та работа, ради которой система создавалась. Принято считать, что время, затраченное на обработку ошибок, — время, в которое система недоступна.

Выделяйте код обработки ошибок в специальные блоки. Это проще в поддержке и добавлении новых обработчиков.

6.31. Перезагрузка (Restart)

Как возобновить работу, когда восстановиться от ошибки невозможно?

Перезагрузите приложение ¯\_(ツ)_/¯

Холодная перезагрузка (cold restart) — при которой все системы начинают функционировать «с нуля», как будто бы систему только что включили. Подогретая перезагрузка (warm restart) — может пропустить некоторые шаги.

6.32. Откат назад (Rollback)

Откуда именно возобновлять работу после восстановления от ошибки?

Возвращайтесь к точке до появления ошибки, где работа может быть синхронизирована между компонентами. Ограничивайте количество попыток через Ограничение повторов (Limit retries).

6.33. Откат вперёд (Roll‑forward)

Откуда именно возобновлять работу после восстановления от ошибки?

Если система событийно‑ориентирована, значит, она реагирует на внешние стимулы при работе. В этом случае можно восстановиться в точке после ошибки, где ожидается появление следующего стимула. Считайте все операции до ошибки не выполненными.

6.34. Возврат к опорной точке (Return to Reference Point)

Откуда возобновить работу, если для возникшей ошибки нет соответствующих точек Отката назад и вперёд?

Опорные точки — не то же самое, что точки отката. Точки отката — динамические. Опорные точки — статичные, и всегда доступны в качестве точек восстановления. Точно известно, что в них восстановление безопасно.

6.35. Ограничение повторов (Limit retries)

Отказы детерминированы. Одна и та же ошибка может приводить к одному и тому же результату. Попытка восстановления от ошибки может приводить к зацикленности.

Применяйте стратегии для подсчёта сообщений и сигналов, которые приводят к одинаковым результатам. Ограничивайте количество попыток обработать один и тот же сигнал.

6.36. Фейловер (Failover)

Активный элемент содержит ошибку. Как система может продолжить исправно функционировать?

В идеале избыточный элемент должен мгновенно заменить активный, в котором появилась ошибка. Этим должен заниматься Ответственный (Someone in charge). Стратегию нельзя использовать, если избыточные элементы уже делят общую рабочую нагрузку.

6.37. Чекпоинт (Checkpoint)

Незавершённая работа может быть потеряна при восстановлении.

Сохраняйте состояние системы время от времени. Предусмотрите возможность восстанавливаться из сохранённого состояния без необходимости повторять все действия, приведшие к этому состоянию.

6.38. Что сохранять (What to save)

Что должно содержаться в Чекпоинте?

Сохраняйте информацию, которая важна всем процессам, а также информацию, которую надо хранить долго.

6.39. Удалённое хранилище (Remote storage)

Где хранить Чекпоинты, чтобы уменьшить время восстановления из сохранённого состояния?

Храните их в центрально‑доступном хранилище.

6.41. Сброс данных (Data reset)

Что делать, если в данных невоспроизводимая и некорректируемая ошибка?

Сбросьте данные до их начальных значений. Начальное — то, которое было валидным в прошлом.

Глава 7. Паттерны снижения ошибок

Эти паттерны рассказывают, как уменьшить негативные эффекты ошибок без изменения приложения или состояния системы.

7.43. Отложенная работа (Deferred work)

Какую работу система может отложить на потом?

Делайте рутинные задачи откладываемыми.

7.44. Переоценка решений о перегрузке (Reassess Overload Decision)

Что делать, если выбранная стратегия уменьшения перегрузки не срабатывает?

Создайте канал обратной связи, который позволит заново определиться с решениями относительно Соотношения отказов (Fault correlation).

7.46. Очередь за ресурсами (Resource queue)

Что делать с запросами к ресурсам, которые не могут быть обработаны прямо сейчас?

Сохраните запросы в очереди. Определите её конечную длину.

7.47. Расширяемый автоматический контроль (Expansive Automatic Controls)

Как избежать перегрузки от обработки всех запросов, которые нельзя обработать сразу, и одновременно возросшего времени ответа?

Определите некоторые ресурсы как те, что будут распределяться только в случае перегрузки. Создайте для системы дополнительные способы выполнения основной работы, которые будут либо использовать резервные ресурсы, либо потребляя меньше ресурсов.

7.48. Защитный автоматический контроль (Protective Automatic Controls)

Что система может сделать, чтобы не закопаться навсегда в ответах на всё возрастающее количество запросов?

Заранее определите лимиты на обрабатываемые запросы, чтобы защитить способность системы выполнять её основную работу.

7.53. Замедление (Slow down)

Что делать, если появляется такое количество запросов, которое система не может даже потенциально обработать эффективно?

Используйте Эскалацию (Escalation), чтобы использовать заранее определённые лимиты на потребление ресурсов. Каждый следующий шаг более суров и экономичен, чем предыдущие. Цель — замедлить всё настолько, чтобы система была в состоянии справиться с хоть какой‑либо нагрузкой.

7.56. Меченые данные (Marked data)

Что сделать, чтобы предотвратить распространение ошибки, когда система находит данные с ошибкой?

Пометьте данные с ошибкой так, чтобы их невозможно было использовать нигде в системе. Определите правила для всех кмопнентов, которые будут рассказывать, что делать с такими данными.

Глава 8. Паттерны «замазывания брешей»

После того, как ошибка обработана, необходимо предотвратить её повторное появление.

8.60. Воспроизводимая ошибка

Необходимо скорректировать настоящую ошибку, а не потратить время впустую.

Воспроизведите ошибку в контролируемой среде, чтобы убедиться, что отказ действительно был связан с этой ошибкой.

8.61. Заплатки (Small patches)

Какой шаблон Обновления программы (Software update) наименее вероятно принесёт с собой новые ошибки?

Используйте маленькие обновления частей. Обновляйте и заменяйте только то, что необходимо.

8.62. Анализ причин (Root cause Analysis)

Что именно чинить? Как именно чинить?

Спрашивайте себя «Почему это произошло» до тех пор, пока не докопаетесь до настоящей причины отказа.

Процесс проектирования отказоустойчивой системы

В приложении к книге есть алгоритм разработки отказоустойчивой системы, расписанный по шагам.

Шаг 1. Определите, что может пойти не так

Чётко‑определённые спецификации помогут выявить и определить, какие ситуации считать отказами.

Шаг 2. Определите, как уменьшить риски

Определите паттерны, которые помогут уменьшить риск возникновения отказов из шага 1.

Шаг 3. Определите необходимую избыточность

Избыточность — базовое свойство отказоустойчивой системы. Сравните технические данные проектируемой системы с требованиями доступности, надёжности и покрытия. Введите необходимые избыточные элементы в систему.

Шаг 4. Определите ключевые архитектурные решения

Продумайте, какие именно паттерны могут быть и будут использованы в конкретной реализации.

Шаг 5. Определите возможности уменьшения рисков

Определите стратегии уменьшения рисков, которым проектируемая система будет следовать.

Шаг 6. Взаимодействие системы с людьми

Продумайте и спроектируйте, кто и как должен будет взаимодействовать с системой: кто основные пользователи, как будет проводиться обслуживание, обновление и т. д.

Ссылки по теме

Паттерны отказоустойчивых приложений. Роберт Ганмер

Это книга о технике обработки ошибок, которая делает работу с ними проще.

В первой части мы прочитаем введение и главы 1–4. Рассмотрим понятия отказоустойчивости, принципы отказоучтойчивого дизайна и архитектурные паттерны.

Введение

Мы не живём в идеальном мире. Во всех системах есть ошибки, которые приводят к отказам. Задача разработчиков — минимизировать количество этих ошибок и их негативное воздействие на систему и пользователей.

Шаблоны — это не панацея. Они решают проблемы внутри определённого контекста. После решения проблемы они могут оставить систему в новом контексте с новыми проблемами.

Глава 1. Введение в отказоусточивость

Неисправность, ошибка и отказ — три разных термина.

  • Неисправность (fault) — дефект в системе, причина ошибки (error).
  • Ошибка (error) — неправильное поведение системы, которое приводит к отказу (failure).
  • Отказ (failure) — поведение системы, которое не соответствует спецификациям.

Причинно‑следственная цепочка выглядит так: fault → error → failure.

Ошибки и неисправности важны для отказоустойчивой системы, потому что могут быть замечены раньше, чем наступит отказ.

Отказы бывают нескольких видов.

  • Тихий отказ (fail‑silent failure) — такой, при котором отказавшая часть либо не предоставляет результата работы, либо предоставляет правильный результат.
  • Аварийный отказ (crash failure) — при котором отказавшая часть прекращает работу после первого тихого отказа.
  • Отказ с остановкой (fail‑stop failure) — такой аварийный отказ, который виден остальным частям системы.

Также отказы можно поделить на последовательные и непоследовательные. Первые проявляются одинаково для всех частей системы. Вторые могут проявляться по‑разному для разных наблюдателей. Например, могут представлять правильные результаты частям, которые следят за ошибками, и неправильные — для остальных частей.

Покрытие (coverage) — условная вероятность, что система восстановится после ошибки автоматически в заданный отрезок времени. Надёжные (reliable) и доступные (available) системы стремятся к покрытию не меньше, чем 0.95.

Надёжность (reliability) — вероятность, что система будет работать без сбоев в течение заданного промежутка времени. Надёжность описывают:

  • среднее время до отказа, MTTF (mean time to failure) — от старта до первого отказа;
  • среднее время до восстановления, MTTR (mean time to repair) — с момента отказа до полного восстановления;
  • среднее время между отказами, MTBF (mean time between failures) — сумма MTTF и MTTR.

Доступность (availability) — доля времени, в которое система способна выполнять свою функцию. Аптайм (uptime) — время, когда система доступна, даунтайм (downtime) — когда не доступна.

Отказоустойчивая система спроектирована так, чтобы эффективно справляться с нормальной рабочей нагрузкой и изящно (gracefully) справляться с перегрузками.

Глава 2. Отказоустойчивое мышление

Ключевой вопрос при разработке отказоустойчивых приложений — «Что может пойти не так?».

Отказоустойчивость (fault tolerance) — это способность системы нормально функционировать даже при наличии отказов. Также это способность ограничить вред от ошибки, возникшей в системе. Качество (quality) — насколько хорошо система может работать без отказов.

Стремление к отказоустойчивости может привести к технологическому и архитектурному оверхеду. Чрезмерное увеличение сложности для обнаружения и исправления ошибок с большой вероятностью приведёт к ещё большему количеству ошибок. Применяйте KISS.

Важные допущения, проверки и предположения:

  • Не полагайтесь слепо на данные из хранилища, они могут содержать ошибки — проверяйте все данные перед использованием.
  • Утечка памяти — частая и высоковероятная ошибка.
  • Проектируйте структуры данных так, чтобы их можно было проверять и валидировать, а также, чтобы невалидные можно было откорректировать.

Для разработки системы полезно использовать N‑version programming. Это подход, при котором систему независимо проектируют несколько команд. Плюс в том, что команды, скорее всего, будут использовать разные алгоритмы, структуры и подходы. Это увеличит количество альтернатив, из которых можно выбрать содержащую минимальное количество неисправностей.

Тестирование и верификация — ключевые свойства отказоустойчивой системы. Они показывают, успешны ли предотвращение неисправностей и исправление ошибок. Тестирование внедрением ошибок (Fault Insertion Testing) — единственный способ определить покрытие (coverage).

Методология отказоустойчивого дизайна:

  • определить, что может пойти не так;
  • определить стратегии смягчения рисков, какие действия могут предотвратить появление потенциальных неисправностей;
  • создать модель системы, выделяя ключевые точки системы и способы применения избыточности (modes of redundancy);
  • внести ключевые архитектурные решения;
  • внедрить в архитектуру способы уменьшения рисков;
  • учесть необходимость в администрировании людьми всех систем, неважно, насколько они отказоустойчивы.

Глава 3. Введение в паттерны

Жизненный цикл отказа состоит из 4 фаз:

  • обнаружение ошибки (error detection);
  • восстановление (error recovery);
  • уменьшение ошибок (error mitigation);
  • обработка отказа (fault treatment).

Системы без внутреннего состояния (stateless) как правило содержат меньше ошибок, чем системы с внутренним состоянием (stateful). Если в системе есть операции, занимающие продолжительное время, её принято считать стейтфул‑системой. Когда стейтфул‑система теряет внутреннее состояние, она теряет способность продолжать функционировать.

Разработка отказоустойчивой системы — дорогая. Готовьтесь вложить больше ресурсов по сравнению с разработкой обычной системы.

Глава 4. Архитектурные паттерны

Архитектурные паттерны рассказывают, как проектировать систему с оглядкой на отказоустойчивость.

4.1 Блоки уменьшения риска (Units of mitigation)

При разработке вам хочется уменьшить риск полного отключения системы. Как сохранить систему работоспособной при наступлении отказа?

Монолит не подходит — если происходит ошибка, монолит не работает полностью. Интерфейсы между блоками уменьшения риска должны быть обозначены чётко и понятно. Граница между частями системы должна быть чёткой и делить систему на понятные части. Такое разделение — способ предотвратить распространение ошибки от одной части системы к другим.

Блоки уменьшения риска…

  • могут быть продублированы, чтобы обеспечить избыточность;
  • это рантайм‑сущности, потому что выполняют работу во время выполнения программы;
  • могут представлять собой сгруппированные модули;
  • должны быть в состоянии проводить самоконтроль, когда есть подозрение на неправильную работу;
  • обязаны быть непреодолимым барьером для ошибок.

4.2. Корректировочные аудиты (Correcting audits)

Ошибки в данных могут и будут возникать.

Данные должны восприниматься неразрывно от их контекста. (1984 может быть валидным годом, но не может быть валидным количеством лет пользователя.) Ошибки в данных приводят к тому, что:

  • вычисления, опирающиеся на эти данные, будут неправильными;
  • может возникнуть ошибка в данных, связанных с ними;
  • может полностью отказать выполнение какой‑либо операции.

Аудиты позволяют выявить некорректные данные.

  • Проверьте структурные свойства. Например, что связанные списки — действительно связанные.
  • Проверьте известные соотношения. Например, температуру в градусах Фаренгейта можно перепроверить значением в градуах Цельсия.
  • Проверьте, что данные не противоречат здравому смыслу. Вряд ли 1984 — валидное количество лет пользователя.
  • Проверьте данные прямым сравнением. Если есть отдельная копия тех же данных, проверьте их на соответствие.

Для каждой структуры данных предусмотрите, что может пойти с ней не так. Когда появляется ошибка в данных, хорошим тоном считается:

  • скорректировать их;
  • записать в логи, что произошло;
  • восстановить выполнение программы с того места, когда данные в последний раз были корректными.

Старайтесь обнаружить и исправить ошибки в данных как можно раньше; проверяйте связанные данные, записывайте все случаи в логи.

4.3. Избыточность (Redundancy)

Как уменьшить время между обнаружением ошибки и возврату к нормальной работе после восстановления?

Всё время, пока система не восстановила нормальную работу после ошибки, она недоступна. Уменьшение этого периода времени увеличивает доступность. Один из способов ускорить процесс восстановления — выполнять только самое необходимое для обработки ошибки. Всё остальное — отложить на период после восстановления.

Избыточность (redundancy) бывает нескольких типов:

  • пространственная;
  • временнáя;
  • информационная.

Избыточные элементы не обязательно имеют одинаковую функциональность, всё что нужно — чтобы избыточный элемент мог выполнить какую‑нибудь часть работы дублируемого элемента. Разнообразие — хороший инструмент в борьбе с распространением ошибок в системе.

Избыточность — не бесплатна.

Есть несколько способов обеспечить пространственную избыточность:

  • метод «Active‑Active» — полное дублирование функциональности дублируемого элемента; скорейшее восстановление, большие издержки;
  • метод «Active‑Standby» — то же, но дублирующий не выполняет полезную функцию сразу; чуть меньшее время восстановления, чуть меньшие издержки;
  • «N+M» — есть М активных элементов, есть N избыточных, которые готовы заменить любой из M элементов при появлении отказа.

4.4. Блоки восстановления (Recovery blocks)

В программах бывают скрытые ошибки. Как удостовериться, что результат работы безошибочен?

Программа с блоками восстановления (recovery blocks) состоит из частей с главным блоком и побочными. Если результат работы главного блока не проходит приёмочный тест, полезную работу проводят побочные блоки до тех пор, пока результат не пройдёт тест. Если тест всё равно не проходит, то ошибка регистрируется в Обработчике ошибок (Error Handler).

Общепринятая схема для построения побочных блоков — делать каждый последующий более простым, чем предыдущий. Будьте готовы, что информации может потеряться по пути, так как каждый последующий блок выполняет меньше действий, чем предыдущие.

Избегайте создания слишком большого количества побочных блоков. Используйте Ограничение повторов (Limit retries), чтобы не допустить зацикливания системы.

4.5. Минимизировать человеческое вмешательство (Minimize Human Intervention)

Люди — частая причина множества ошибок. Как оградить людей от выполнения неправильных действий, которые приводят к ошибкам?

Кроме ошибок с железом и софтом существуют процедурные ошибки — которые появляются в результате действий персонала. Проектируйте систему так, чтобы сократить количество возможных процедурных ошибок. Людям быстро становится скучно, и они перестают уделять внимание рутинным и монотонным задачам.

Система должна давать чёткие и однозначные инструкции, что делать, если наступил отказ. Но при этом персонал не должен быть необходим для разрешения ошибки.

4.6. Максимизировать человеческое участие (Maximize Human Participation)

Должна ли система игнорировать людей в принципе?

Для многих типов систем (например, авионика) возможность оператора перебить или изменить обработку ошибки — жизненно‑необходима. Такие системы могут входить в «безопасный режим» (safe mode) и перестать выполнять автоматические действия, ждя человеческого вмешательства.

Определите, для кого проектируется система. Создавайте способы для квалифицированных пользователей участвовать в обработке ошибок, если требуется.

4.7. Интерфейс тех. обслуживания (Maintenance Interface)

Должны ли сигналы приложения и сигналы тех. обслуживания быть смешаны?

Нет, они должны быть разделены. Сигналы обслуживания должны быть обработаны даже тогда, когда система перегружена. Кроме того, смешение сигналов может привести к дырам в безопасности.

4.8. Ответственный (Someone in charge)

Что угодно может пойти не так, даже во время обработки ошибки. Система может перестать выполнять не только основную функцию, но и перестать обрабатывать ошибки.

Когда система знает, что она должна выполнять в конкретный момент времени, она более крепкая. Часть системы, которая может определить, что что‑то не работает, или работает не правильно, называется Наблюдатель отказов (Fault observer).

Для каждого отдельного действия, связанного с обработкой ошибок, должна быть одна чётко определённая сущность.

4.9. Эскалация (Escalation)

Что делать системе, если её попытки обработать ошибку не достигли желаемого результата?

Применять методы обработки со следующих уровней. Поднимать ошибку «наверх» в иерархии системы. Отдавать сигнал на «подъём» должен Ответственный (Someone in charge).

4.10. Наблюдатель отказов (Fault observer)

Система не падает после ошибки, а обрабатывает их автоматически. Как нам понять, какие ошибки и когда произошли?

Наблюдатель отказов уведомляет персонал о случившихся ошибках через Интерфейс тех. обслуживания. Наблюдатель отказов не обязательно должен быть внутренней частью системы, он может быть внешним сервисом.

Сообщайте обо всех ошибках Наблюдателю. Он позаботится о том, чтобы все заинтересованные стороны узнали об ошибках, которые произошли.

4.11. Обновление программы (Software update)

Система не должна останавливать свою работу даже для того, чтобы обновиться.

Внедряйте способность вносить изменения, патчи, обновления в архитектуру с первого релиза. Не надейтесь, что даже после этого обновление будет простой задачей в будущем.

Что дальше?

В следующей части проичтаем главы 5–8. Рассмотрим паттерны обнаружения ошибок, восстановления от них, снижения их вероятности и «замазывания брешей».

Ссылки

Немного о Солидбуке

Мы с Артёмом Самофаловым сделали книгу об ООП. Для нетерпиливых — сразу ссылка.

У нас с Артёмом зудит, когда мы ищем материалы по какой‑то теме и не можем найти достаточно годноты. Нам не хочется искать кучу разрозненных статей по разным углам интернета, а хочется, чтобы всё было удобно, в одном месте и написано понятным языком. В последний раз такое случилось с ООП.

Объектно‑ориентированное программирование — старо как мир, по нему есть куча книг, но они толстые и заумные. Статьи о нём либо слишком академические, либо слишком простые и не покрывают сложных проблем, которые нам интересны. Источников на русском языке вообще раз, два и хабр.

В общем, нам бомбануло, и мы написали Солидбук. Это книга, в которой мы рассказываем о принципах SOLID, как их применять, чем они полезны.

Мы перелопатили кучу источников: книг, статей, научных работ, примеров. Для каждого принципа подобрали случаи из реальных проектов, с которыми работали. Нашли подходящие примеры из «идеального мира». Подобрали шаблоны проектирования и приёмы рефакторинга, которые помогают эти принципы соблюдать. Отобрали антипаттерны, которых советуют избегать. А ещё для каждого принципа мы приготовили вопросы и тесты для самопроверки!

Если книга вам зашла, пошарьте её в соцсетях и блогах или полайкайте на гитхабе. Мы будем благодарны! А если эта книга или другие статьи‑проекты‑что‑то‑ещё вам очень‑очень зашли, то вы можете поддержать нас на Патреоне.

Раньше ↓