Просмотр аналитики API в организации

Вы можете просмотреть действия REST API для всей организации или определенных приложений и пользователей.

Кто может использовать эту функцию?

Organization owners and users with the "View organization API insights" permission.

Your organization must be on a GitHub Enterprise Cloud plan.

В этой статье

Note

Эта функция в настоящее время находится в public preview и подлежит изменению. Мы приветствуем ваши отзывы в этом обсуждении GitHub Community.

Сведения о аналитике API

Как владелец организации GitHub Enterprise Cloud вы и назначенные пользователи могут просматривать действия REST API для всей организации или определенных приложений и пользователей. Это поможет вам понять источники действий REST API и управлять ими по основным ограничениям скорости, обеспечивая видимость временных интервалов, приложений и конечных точек API. Дополнительные сведения о основных ограничениях скорости см. в разделе Ограничения скорости для REST API.

Note

В настоящее время эта функция поддерживает только core категорию конечных точек REST API и основных ограничений скорости. Действия API для поиска, GitHub Actions (с помощью секрета GITHUB_TOKEN ), а дополнительное ограничение скорости не поддерживается. Сведения о категориях API см. в разделе Конечные точки REST API для ограничений скорости. Дополнительные сведения об ограничениях первичной и вторичной скорости см. в разделе Ограничения скорости для REST API.

Включение доступа к аналитике API

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

Warning

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

Общие сведения об агрегации аналитики API

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

ПериодDescription
Последние 30 минутДанные за последние 30 минут до просмотра страницы.
Последний часДанные за последние 1 час до момента просмотра страницы.
Последние 3 часаДанные за последние 3 часа до момента просмотра страницы.
последние 12 часовДанные за последние 12 часов до момента просмотра страницы.
Последние 24 часа(по умолчанию) Данные за последние 24 часа до просмотра страницы.
За последние 7 днейДанные за последние 7 дней до момента просмотра страницы.
Последние 31 дн.Данные за последние 31 дней до момента просмотра страницы.
ПользовательскоеДанные из пользовательского диапазона даты и времени, который вы предоставляете. Пользовательские диапазоны должны начинаться в течение последних 31 дней.

Просмотр аналитики API для организации

  1. В правом верхнем углу GitHubвыберите свой фото профиля, а затем выберите Ваши организации.

  2. Щелкните название своей организации.

  3. Под именем организации щелкните Insights.

    Снимок экрана: горизонтальная панель навигации для организации. Вкладка, помеченная значком графа и "Аналитика", описывается в темно-оранжевый цвет.

  4. В меню навигации "Аналитика" щелкните REST API.

  5. При необходимости, чтобы выбрать период времени для просмотра аналитики API, выберите параметр в раскрывающемся меню "Период " в правом верхнем углу страницы. Дополнительные сведения см. в статье "Общие сведения об агрегации аналитики API".

  6. При необходимости для переключения между датами и временем в формате UTC или локальном часовом поясе, используемом браузером, выберите "UTC" или "Локальный" в раскрывающемся меню "Период " в правом верхнем углу страницы.

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

Выбранный период и интервал автоматически становятся частью URL-адреса страницы, чтобы при совместном использовании URL-адреса с кем-то они видели то же представление.

Просмотр аналитики API для приложений и пользователей организации

В таблице "Субъекты" отображаются GitHub Apps и пользователи, которые запрашивали REST API в текущей организации в течение выбранного периода времени. Таблица не обновляется автоматически, чтобы отобразить новое действие.

  1. Во-первых, просмотрите аналитику API для организации, выполнив описанные выше действия в разделе "Просмотр аналитики API для организации".
  2. Фильтрация приложений и пользователей, отображаемых в таблице "Субъекты".
    1. Чтобы отфильтровать по имени, введите первые несколько букв имени в поле поиска над таблицей "Субъекты". Нажмите клавишу ввода.
    2. Чтобы отфильтровать по типу субъекта (приложения или пользователя), выберите параметр в раскрывающемся меню "Тип " в правом верхнем углу таблицы "Субъекты".
    3. Чтобы отфильтровать по типу запроса (все или ограниченные по скорости), выберите параметр в раскрывающемся меню "Запросы " в правом верхнем углу таблицы "Субъекты".

Просмотр аналитических сведений API для конкретного приложения или пользователя в организации

  1. Во-первых, просмотрите аналитику API для организации, выполнив описанные выше действия в разделе "Просмотр аналитики API для организации".
  2. При необходимости выберите приложение в таблице "Субъекты", чтобы отобразить его действие REST API и любое ограничение скорости первичной частоты. Полученное представление будет зависит от выбранного приложения и отобразит конечные точки API, к ним доступ.
  3. При необходимости выберите пользователя в таблице "Субъекты", чтобы отобразить свое личное действие REST API. Полученное представление будет зависеть от выбранного пользователя и будет отображать действие API своих personal access tokens и запросов, сделанных OAuth apps от их имени. Оба вносят свой вклад в личный основной предел скорости пользователя. Сведения об ограничениях основной частоты для пользователей и OAuth apps, которые действуют от их имени, см. в разделе Ограничения скорости для REST API.
    1. При необходимости в представлении для конкретного пользователя щелкните personal access token или OAuth app для просмотра действия REST API от имени пользователя.