Логирование: что это
Логирование — автоматическая запись событий в журнал: какой запрос пришёл, что ответил сервер, где произошла ошибка. Без логов поиск причины сбоя превращается в гадание.
Определение
Лог — это хронологический файл или таблица записей. У каждой записи есть время, уровень важности (информация, предупреждение, ошибка) и описание события. По ним восстанавливают, что происходило, и находят причину сбоя.
Пример из лидогенерации
Ваш сервер отправляет лиды в сеть. В логах стоит записывать: номер заявки в вашей системе (apiid), время запроса, HTTP-код ответа, поле code из тела и полученный lead_id. Тогда на вопрос «куда делась заявка» вы ответите за минуту.
Что писать
- Идентификаторы заявок, а не контакты людей.
- Коды ответов и причины отказов.
- Время ожидания и количество повторов.
- Изменения настроек и доступов.
Чего писать нельзя
Секретные ключи, пароли, токены и полные персональные данные пациентов в логах оставлять не стоит: файлы читает много людей, их копируют и пересылают. Телефон при необходимости маскируйте, например оставляя последние цифры. Для хранения логов задайте срок и ограничьте доступ.
Нюансы
Слишком подробные логи занимают место и маскируют важное, слишком скудные не помогают. Используйте уровни важности и единый формат. Следите, чтобы запись не замедляла основную работу. Если сбои повторяются, настройте оповещения, а не ждите, пока кто-то заглянет в файл.
Практический совет
Раз в квартал просматривайте, что реально попадает в ваши журналы, и удаляйте лишнее. Часто там обнаруживаются ключи и контакты, которых не должно быть.
Связанные понятия
Смежные понятия: журнал отправок в кабинете сети, HTTP-код ответа и повтор доставки. Правила обработки данных описаны в политике конфиденциальности.
Вопросы и ответы
Можно ли хранить телефоны в логах?
Лучше не хранить в открытом виде. Фиксируйте идентификатор заявки, а контакты маскируйте.
Как долго хранить логи?
Столько, сколько нужно для разбора сбоев, и не дольше. Срок определите заранее.