public:logging_rules [Voklaf Wiki]

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

====== Правила логирования ======

  - Все данные, критически важные для выполнения ПО, персональные и финансовые данные (сокр. КД),  должны протоколироваться на уровне не ниже info
  - Фиксирование процесса исполнения так же важно, как и фиксирование ошибок
  - Функция, содержащая КД, должна протоколироваться целиком, от начала и до конца
  - Каждый протоколируемый блок кода (Например: функция) должен иметь уникальный идентификатор в логе и все записи в логе от этого блока должны начинаться с его идентификатора
  - Начало и конец протоколируемого кода необходимо обозначать одинаковыми, заранее оговоренными словами (например: catch, end)<code>
Mar 12 11:49:12 vsr-s1 crm[98875]: change_account_tel catch =========================================>
</code>
  - Фиксируются следующие переменные и их изменение:
    - используемые при проверки условий
    - содержащие КД<code>
Mar 12 11:49:12 vsr-s1 crm[98875]: change_account_tel account_id:        111216
</code>
  - Фиксируются результаты проверки условий (Например: отработало условие что клиент - мужчина)<code>
Mar 12 11:49:12 vsr-s1 crm[98875]: change_account_tel start client is man
</code>
  - Допускается использование добавочного идентификатора после основного чтобы идентифицировать вложенные блоки (Например: вложенный блок верификации )<code>
Mar 12 11:49:12 vsr-s1 crm[98875]: change_account_tel verification account_id:        111216
</code>
  - Если блок кода работает с каким либо идентификатором, который известен пользователю (Например: номер заявки), его рекомендуется фиксировать в логе как можно ближе к началу блока и называть идентификатором, единым для всех блоков кода.