Поделиться через


Панель мониторинга GraphQL и ведение журнала (предварительная версия)

Заметка

Функция мониторинга мониторинга и ведения журнала для API Fabric для GraphQL находится в предварительной версии.

После развертывания API для GraphQL в Fabric может потребоваться понять, как API используется клиентами и устранять ошибки в случае возникновения проблем с API. Используйте панель мониторинга GraphQL Fabric для визуализации, мониторинга и устранения неполадок с действием запроса API GraphQL. Эта функция сейчас доступна в предварительной версии. В этой статье объясняется, как эффективно включить мониторинг и использовать компоненты панели мониторинга.

Необходимые условия

Заметка

  • Функция мониторинга вызывает дополнительные расходы для вашей емкости.
  • Мониторинг рабочей области по умолчанию отключен.
  • Хранение данных для мониторинга активности ограничено 30 дней.

Включение мониторинга API GraphQL

В этом разделе описаны действия, необходимые для мониторинга API для GraphQL. По умолчанию эта функция отключена.

  1. Чтобы включить метрики и (или) ведения журнала для каждого API для GraphQL в клиенте, откройте API GraphQL и щелкните значок параметров:

    снимок экрана: выбор API для параметров GraphQL.

  2. В окне параметров API выберите параметр Мониторинг (предварительная версия) в меню слева. Если мониторинг рабочей области еще не включен, вы увидите заметку, которая направит вас к параметрам рабочей области, чтобы включить ее.

    снимок экрана: выбор мониторинга из API для параметров GraphQL.

  3. После включения мониторинга для рабочей области вы увидите параметры для включения только метрик (панель мониторинга API), только ведения журнала (запросы API) или обоих. Метрики и журналы сохраняются в отдельных таблицах в Kusto, и вы можете включить каждую функцию отдельно в зависимости от вашего требования. По умолчанию оба варианта отключены:

    Снимок экрана переключателей метрик и ведения журнала из настройки мониторинга API для GraphQL.

Заметка

Метрики и данные журнала отправляются отдельно в базу данных Kusto, связанную с рабочей областью, что приводит к дополнительным расходам. Дополнительные сведения о затратах и использовании потребления см. в объявлении о мониторинге рабочей области.

Активность запросов API

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

снимок экрана вкладки активности запросов API на верхней панели.

Действие запроса API состоит из двух основных представлений:

  1. панель API(для метрик): на этой странице отображаются все счетчики и графики для указанного диапазона времени.
  2. запросы API (для ведения журнала): на этой странице перечислены запросы API в пределах указанного диапазона времени.

В следующих разделах описаны функциональные возможности каждого параметра.

Метрики (панель мониторинга API)

Панель мониторинга API предоставляет обзор действий API с различными метриками и визуальными элементами. Чтобы получить доступ, на странице действия запроса API выберите вкладку панели мониторинга API. Теперь вы можете сразу увидеть следующие параметры для определенного временного диапазона:

  • Общий индекс работоспособности API GraphQL, включающий:

    • Запросов API в секунду
    • Процент успешных случаев
    • Состояние здоровья
  • Количество запросов API

  • Задержка

  • Количество запросов на линейчатой диаграмме, иллюстрирующая количество успешных и ошибок

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

снимок экрана панели мониторинга API.

Ключевые функции метрик :

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

    снимок экрана панели мониторинга API с параметром диапазона времени.

  • запросы API/с: Вы можете просмотреть количество запросов API, сделанных каждую секунду в указанном временном диапазоне.

    снимок экрана: панель мониторинга API с количеством запросов API в секунду.

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

    снимок экрана: панель мониторинга API, показывающая частоту успешности.

  • Общий индекс работоспособности API GraphQL на основе уровня успешности каждого API.

    • Зеленый: 75 –100% запросов успешно (работоспособно)

    • Желтый: 50 – 74% запросов успешно (требуется внимание)

    • Красный: Меньше 50% успешных запросов (Неработоспособно)

      снимок экрана панели мониторинга API с индексом работоспособности.

  • общее количество запросов API: можно просмотреть общее количество запросов API в выбранном диапазоне времени. снимок экрана: панель мониторинга API с количеством запросов API.

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

    снимок экрана панели мониторинга API с линейчатой диаграммой задержки.

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

    снимок экрана панели мониторинга API со столбчатой диаграммой количества запросов.

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

Ведение журнала (запросы API)

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

снимок экрана страницы запроса API с списком запросов.

Ключевые особенности журналирования:

  • Выбор диапазона времени. Вы можете выбрать различные диапазоны времени для данных, отображаемых в списке запросов (час/день/неделя/месяц). Обратите внимание, что срок хранения 30 дней.

снимок экрана страницы запроса API с диапазоном времени для списка запросов.

  • Просмотрите список последних запросов API и прошлых запросов, перечисленных с идентификатором запроса.
  • Просмотр типа операции (запрос или мутация).
  • Просмотрите транспортный протокол, используемый запросом (HTTP).
  • Просмотр времени запроса.
  • Отсортируйте список запросов по возрастанию или убыванию.
  • Просмотр длительности запроса.
  • Отсортируйте список запросов по продолжительности в порядке возрастания или убывания.
  • Просмотр размера ответа.
  • Просмотр состояния (успешно или неудачно).
  • Просмотрите сведения о запросе, включая конкретные сообщения об ответе, предупреждении и ошибке.
  • Фильтрация и поиск определенных строк или предложений.
  • Измените размер столбцов и сортируйте столбцы (по возрастанию или убыванию) из таблицы отчета.