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

Получите полную видимость рабочих API GraphQL с помощью интегрированных возможностей мониторинга и ведения журнала Microsoft Fabric. Отслеживание метрик производительности в режиме реального времени, анализ шаблонов запросов, устранение ошибок и понимание взаимодействия клиентов с API-интерфейсами в рабочей области Fabric.

Основные возможности мониторинга:

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

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

Кто использует мониторинг и ведение журнала

Мониторинг и ведение логов GraphQL необходимы для:

• Администраторы рабочей области Fabric контролируют состояние API, производительность и потребление ресурсов в режиме реального времени
• Администраторы емкости Fabric отслеживают шаблоны использования и оптимизируют выделение емкости для рабочих нагрузок GraphQL
• Группы управления данными проверяют доступ к данным, обнаруживают аномалии и обеспечивают соответствие политикам данных
• Инженеры данных анализируют шаблоны запросов и оптимизируют доступ к Lakehouse Fabric и хранилищу
• Команды платформы понимают процесс внедрения API Fabric и принимают обоснованные данными решения относительно инвестиций в API

Используйте мониторинг и ведение журнала, если вам нужна видимость поведения API GraphQL, метрик производительности и аналитики использования.

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

• Необходимо включить мониторинг рабочей области и добавить хранилище событий для мониторинга. Дополнительные сведения о том, как включить его, см. в разделе "Обзор мониторинга рабочей области". Мониторинг рабочей области по умолчанию отключен.

  Заметка

  Если вы только что включили мониторинг рабочей области, вам может потребоваться обновить страницу, прежде чем продолжить настройку мониторинга GraphQL.

• У вас должен быть развернут API GraphQL в системе Fabric. Дополнительные сведения о развертывании см. в статье "Создание API для GraphQL в Fabric" и добавление данных.

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

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

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

   

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

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

   

   Заметка

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

4. Включите нужные параметры, переключив переключатели по одному на позицию "Вкл .".

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

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

На странице действий запроса API можно выбрать одну из следующих вкладок, чтобы просмотреть определенные данные мониторинга:

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

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

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

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

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

Индикаторы здоровья

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

  • Зеленый: 75-100% успешные запросы (нормальное состояние)

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

  • Красный: менее 50% успешных запросов (ненадежно)

    

• Частота успешности: процент успешных запросов и общих запросов в выбранном диапазоне времени

  

Метрики объемов данных

• Запросы API в секунду: представление тома запроса в режиме реального времени

  

• Общее количество запросов API: статистическое число всех запросов в выбранном диапазоне времени

  

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

  

Метрики производительности

• График задержки: тенденции времени отклика, показывающие производительность с течением времени

  

Параметры настройки

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

  

От общего к деталям

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

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

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

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

Это ведение журнала на уровне запроса дополняет метрики обзора панели мониторинга, предоставляя детализированные данные, необходимые для диагностики конкретных проблем, оптимизации медленных запросов и понимания шаблонов поведения клиента.

Запрос сведений

Каждый зарегистрированный запрос включает:

• Идентификатор запроса: уникальный идентификатор для отслеживания определенных операций
• Тип операции: классификация запросов или мутаций
• Транспортный протокол: метод HTTP, используемый для запроса
• Метка времени: точное время получения запроса
• Длительность: время выполнения запроса на ответ
• Размер ответа: размер данных, возвращенных клиенту
• Состояние: индикатор успеха или сбоя с подробными сведениями об ошибке

Средства просмотра данных

• Фильтрация диапазона времени: выбор из часов, дня, недели или месячных представлений (ограничение на 30 дней хранения)

  

• Расширенная сортировка: сортировка по метке времени или длительности в порядке возрастания или убывания

• Поиск и фильтрация: поиск конкретных запросов с помощью текстового поиска во всех сведениях о запросе

• Управление столбцами: изменение размера и изменение порядка столбцов для настройки представления таблицы

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

Устранение неполадок рабочих процессов

Используйте страницу ведения журнала, чтобы:

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

Связанное содержимое

• API Microsoft Fabric для GraphQL
• Обзор мониторинга рабочей области
• API для GraphQL в Fabric
• API Fabric для GraphQL редактора
• API Fabric для представления схемы GraphQL и обозревателя