Различия

Показаны различия между двумя версиями страницы.

--- public:logging_rules [2021/03/12 17:15] – voklaf
+++ public:logging_rules [2021/03/12 17:53] (текущий) – voklaf
@@ Строка 1: / Строка 1: @@
 ====== Правила логирования ======
-  - Все данные, критически важные для выполнения ПО, пользовательские и финансовые данные (сокр. КД),  должны протоколироваться на уровне не ниже info
+  - Все данные, критически важные для выполнения ПО, персональные и финансовые данные (сокр. КД),  должны протоколироваться на уровне не ниже info
-  - Функция, содержащая такие данные, должна протоколироваться целиком, от начала и до конца
+  - Фиксирование процесса исполнения так же важно, как и фиксирование ошибок
-  - Начало и конец протоколируемого кода необходимо обозначать одинаковыми, заранее оговоренными словами (например: catch, end)
+  - Функция, содержащая КД, должна протоколироваться целиком, от начала и до конца
-  - В процессе выполнения фиксируются следующие переменные и их изменение:
+  - Каждый протоколируемый блок кода (Например: функция) должен иметь уникальный идентификатор в логе и все записи в логе от этого блока должны начинаться с его идентификатора
+  - Начало и конец протоколируемого кода необходимо обозначать одинаковыми, заранее оговоренными словами (например: 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>
+  - Если блок кода работает с каким либо идентификатором, который известен пользователю (Например: номер заявки), его рекомендуется фиксировать в логе как можно ближе к началу блока и называть идентификатором, единым для всех блоков кода.