Назначение
Расширение "Логирование API" предназначена для решения следующих задач:
- Отладка API
- Мониторинг производительности
- Сбор логов
- Оценка качества API
- Идентификация медленных запросов
Функциональные возможности
Отладка API, мониторинг производительности, сбор логов и анализ качества
Отладка API
Позволяет разработчикам видеть, какие HTTP-запросы поступают на сервер, как они обрабатываются и какие ответы возвращаются. Это помогает выявлять ошибки и несоответствия в работе API.
Быстро получить параметры проблемного запроса, увидеть тело и ответ запроса, и воспроизвести проблемный запрос для анализа.
Мониторинг производительности
Предоставляет возможность измерять время выполнения операций, что позволяет оценить производительность API и выявить проблемные и долгие запросы, увидеть динамику скорости выполнения запросов в течение дня, недели, месяцев.
Сбор логов
Обеспечивает сбор и хранение информации о запросах и ответах, что может быть полезно для анализа работы системы, отладки и интеграции с другими системами.
Оценка качества API и идентификация медленных запросов
Оценка качества API: Позволяет оценить, насколько правильно построена API, какие запросы выполняются и в каком количестве. Это помогает оптимизировать работу API и улучшить ее производительность.
Идентификация медленных запросов: Доработка позволяет выявлять медленные API-запросы, что помогает разработчикам фокусироваться на оптимизации критически важных участков кода.
Технические требования
Проверено на конфигурации:
- 1С:Бухгалтерия предприятия, 3.0.193.19
-
платформе 1С:Предприятие 8.3.27.1936
- конфигурация не имеет значения, платформа - 8.3 и выше
Не гарантируется работа в 1С:Фреш, 1С:БО и облачных сервисах, где требуется аудит загружаемых разработок
Код открыт.
Как это работает
Доработка "Логирование API" работает следующим образом:
- Подключение: Доработка подключается как обычное расширение для 1С и интегрируется в любую конфигурацию.
- Сбор данных, подключение входящих запросов:
Первый способ: Простой сбор логов. Все HTTP-запросы и ответы фиксируются и записываются в лог (Через "изменение и контроль" или "После").
Код для снятия лога
/// Запрос- HTTPЗапрос
#Вставка
УидЗаписи = прк_ЛогАпи.НачатьЗаписьЛога("mobil",Запрос);
#КонецВставки
......... код процедуры...
/// Ответ - HTTPОтвет
#Вставка
прк_ЛогАпи.ДополнитьОтветПоУиду(УидЗаписи,Ответ);
#КонецВставки
Второй способ: Сбор логов с таймингом выполнения операций. Этот способ состоит из двух этапов: (Через "изменение и контроль")
Код за записи содержимого без фиксации ошибок и длительности вызова
#Вставка
прк_ЛогАпи.ЗаписатьЛогАпи("mobil",Запрос,Ответ);
#КонецВставки
- Просмотр данных: Собранные данные можно просмотреть в специальной форме, где они представлены в удобном для пользователя виде. Данные уже отформатированы и готовы к анализу.
Как внедрять
Для внедрения доработки "Логирование API" необходимо выполнить следующие 5 шагов:
1. Установка расширения
Подключите расширение к конфигурации 1С. Это базовая операция, которая интегрирует подсистему логирования в ваш рабочий контур.
2. Подключить процедуры
После установки расширения необходимо подключить экспортные процедуры в модулях вашей конфигурации для корректного перехвата и записи событий API.
3. Настроить права доступа
Добавьте профиль с правом "Доступ к подсистеме логов API (Логирование API)". Пользователям, которым разрешен доступ к логам, нужно добавить это право. Важно: пользователи с полными правами не имеют автоматического доступа.
4. Настройка сбора данных
Перейдите в раздел Сервис -> Настройки сбора логов. Здесь вы можете включить или отключить сбор данных через настройки расширения, выбрав нужные уровни детализации.
5. Анализ данных и оценка производительности
Просматривайте собранные данные в таблице логов регистра или в отчете "Оценка производительности", который также включает метрику APDEX для анализа удовлетворенности пользователей скоростью работы.
Остались вопросы?
Для получения дополнительной информации и помощи в настройке модуля под нужды вашего бизнеса — оставьте заявку
Проверено на следующих конфигурациях и релизах:
- Бухгалтерия предприятия, редакция 3.0, релизы 3.0.193.19
