Skip to main content

Настройка доступа к метрикам

API метрик собирает информацию о компонентах ArcGIS Enterprise и компьютерах, на которых работают эти компоненты. Чтобы использовать информацию, предоставляемую API метрик, вам нужно создать ключ или токен для авторизации доступа к метрикам, настроить Prometheus для сбора метрик и, при необходимости, настроить Grafana для их визуализации.

Метрики включены по умолчанию, но вы можете отключить метрики при необходимости.

Настройка прав доступа

Перед сбором метрик убедитесь, что включены правильные права доступа.

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

Для развертывания ArcGIS Enterprise, включая любые интегрированные серверы, выполняйте аутентификацию запросов с помощью API-ключа. Для автономных сайтов ArcGIS Server выполняйте аутентификацию запросов с помощью административного токена.

Примечание:

Для успешной аутентификации и получения метрик любого компонента ArcGIS Enterprise необходим доступ к сервису Portal for ArcGIS. Аутентификация для получения метрик ArcGIS Data Store дополнительно требует доступа к хост-серверу.

Получение ключа API с помощью ArcGIS Enterprise

Чтобы использовать ArcGIS Enterprise для получения API-ключа, подходящего для доступа к API метрик, выполните следующие действия:

  1. Войдите в организацию как администратор.

  2. На вкладке Мои ресурсы на странице содержания щелкните Новый элемент и выберите Учетные данные разработчика.

  3. Выберите Далее данные ключа API и щелкните Далее.

  4. Выберите Частное приложение с выбранными правами и доступом и щелкните Далее.

  5. Выберите Без доступа к элементам и щелкните Далее.

  6. Выберите право Наблюдаемость и щелкните Далее.

  7. Выберите дату истечения срока действия и при необходимости URL-адреса источников перехода, затем щелкните Далее.

  8. Добавьте заголовок для элемента ключа API, а также при необходимости теги и краткое описание, затем щелкните Далее.

  9. Проверьте правильность конфигурации ключа API, затем щелкните Далее.

  10. Убедитесь, что выбрана опция Создать ключ API сейчас, затем щелкните Далее.

  11. Скопируйте ключ API.

Получение административного токена с помощью ArcGIS Server

Для автономных сайтов ArcGIS Server можно получить административный токен с помощью ArcGIS Server. Для интегрированных сайтов ArcGIS Server вместо этого получите ключ API.

  1. Войдите в каталог администратора ArcGIS Server как пользователь с административными правами.

  2. Щелкните generateToken.

  3. Укажите следующую информацию:

    • Имя пользователя — Имя пользователя с правами администратора

    • Пароль – Пароль для указанного имени пользователя

    • Клиент — HTTP-реферер.

    • HTTP-реферер — URL-адрес, соответствующий значению HTTP-реферера, указанному в конфигурации Prometheus. Пример конфигурации Prometheus использует ARCGIS.COM в качестве HTTP-реферера.

  4. При необходимости задайте срок действия в минутах.

    Примечание:

    По умолчанию срок действия составляет 60 минут. Максимальный срок действия по умолчанию составляет 1440 минут (24 часа). Чтобы создать токен с более длительным сроком действия, администратор должен перед его созданием изменить конфигурацию токенов, увеличив значение свойства longTimeout. Увеличивая значение longTimeout, убедитесь, что обновленное значение отвечает вашим требованиям безопасности.

  5. Щелкните Создать.

  6. Скопируйте токен.

Настройка сервера Prometheus

Чтобы добавить API метрик в качестве цели сбора, необходимо обновить конфигурацию Prometheus. Инструкции по развертыванию Prometheus см. в руководстве по развертыванию.

Настройте отдельное задание сбора для каждого компонента ArcGIS Enterprise, метрики которого необходимо получать. Для каждой конфигурации сбора требуется следующая информация:

  • job_name – Уникальное имя задания.

  • http_sd_configs — Конфигурация конечной точки обнаружения сервисов. Требуется следующая информация:

    • url — URL-адрес конечной точки обнаружения сервисов. URL-адрес будет иметь формат <scheme>://<machine fqdn>/<context>/monitoring/discovery.

      Для Portal for ArcGIS и ArcGIS Server рекомендуется использовать URL-адрес ArcGIS Web Adaptor или обратного прокси-сервера. Например, организация может использовать https://portal.example.com/portal/monitoring/discovery для обнаружения сервисов метрик портала или https://gisserver.example.com/server/monitoring/discovery для обнаружения сервисов сайта ArcGIS Server.

      Для ArcGIS Data Store необходимо указать компьютер, на котором установлен реляционное хранилище, и номер порта. Например, https://relational.example.com:2443/arcgis/monitoring/discovery

    • bearer_token или bearer_token_file— Созданный вами ключ API ArcGIS Enterprise или административный токен ArcGIS Server.

      Токен передается как часть http_sd_configs, чтобы выполнить аутентификацию для конечной точки обнаружения сервисов.

  • bearer_token или bearer_token_file— Созданный вами ключ API ArcGIS Enterprise или административный токен ArcGIS Server.

    Токен снова передается как часть конфигурации сбора для аутентификации при обращении к конечным точкам сбора метрик.

  • metrics_path — Значение должно быть /arcgis/monitoring/metrics

    Для сбора метрик компьютеров необходимо напрямую отправлять запросы на каждый отдельный компьютер. Эти запросы не проходят ни через один ArcGIS Web Adaptor или обратный прокси-сервер, которые вы настроили. Убедитесь, что сервер Prometheus может получить доступ к каждому компьютеру ArcGIS Server через порт 6443 и к каждому компьютеру Portal for ArcGIS через порт 7443.

  • scheme — http или https, в зависимости от того, настроен ли URL-адрес, указанный в https_sd_configs, для доступа по протоколу HTTP или HTTPS.

См. пример конфигурации Prometheus для файла шаблона YAML для сбора метрик ArcGIS Enterprise. После сбора метрик с помощью Prometheus можно использовать пример шаблона операционной панели для настройки их визуализации в Grafana.

Настройка интервала очистки метрик

Интервал очистки метрик из системы по умолчанию составляет 1 час, что подходит для большинства организаций. Дополнительные сведения о том, что следует учитывать при изменении интервала очистки, см. в разделе Очистка метрик.

Если вам нужно изменить интервал очистки, порядок действий зависит от компонента ArcGIS Enterprise.

Настройка интервала очистки метрик для ArcGIS Server

  1. Войдите в каталог администратора ArcGIS Server как пользователь с административными правами.

  2. Перейдите в раздел Система > Свойства > Обновить.

  3. В текстовом поле Свойства добавьте значение для ключа metricsClearingIntervalInHours в формате JSON.

    Например, чтобы установить интервал в два часа, используйте следующий JSON:

    {
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}

  4. Щелкните Обновить.

  5. Перезапустите сервис ArcGIS Server.

Настройка интервала очистки метрик для Portal for ArcGIS

  1. Войдите в Portal Administrator Directory в качестве администратора вашей организации.

  2. Щелкните Система > Свойства > Обновить свойства.

  3. В текстовом поле Свойства добавьте значение для ключа metricsClearingIntervalInHours в формате JSON.

    Например, чтобы установить интервал в два часа, используйте следующий JSON:

    {
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}

  4. Щелкните Обновить свойства.

    Эта операция автоматически перезапустит сервис Portal for ArcGIS.

Настройка интервала очистки метрик для хранилища данных ArcGIS

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

./datastoremetrics --enabled true --interval 2

datastoremetrics --enabled true --interval 2

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

Отключение метрик

Действия по отключению метрик зависят от компонента ArcGIS Enterprise.

Отключение метрик для сайта ArcGIS Server

  1. Войдите в каталог администратора ArcGIS Server как пользователь с административными правами.

  2. Перейдите в раздел Система > Свойства > Обновить.

  3. В текстовом поле Свойства установите для ключа isMetricsEnabled значение false:

    {"isMetricsEnabled": false}

  4. Щелкните Обновить.

  5. Перезапустите сервис ArcGIS Server.

Отключение метрик для Portal для ArcGIS

  1. Войдите в Portal Administrator Directory в качестве администратора вашей организации.

  2. Щелкните Система > Свойства > Обновить свойства.

  3. В текстовом поле Свойства установите для ключа isMetricsEnabled значение false:

    {"isMetricsEnabled": false}

  4. Щелкните Обновить свойства.

    Эта операция автоматически перезапустит сервис Portal for ArcGIS.

Отключение метрик для хранилища данных ArcGIS

Чтобы отключить метрики для ArcGIS Data Store, запустите утилиту datastoremetrics на компьютере, где установлено реляционное хранилище данных, используя следующую команду:

./datastoremetrics --enabled false

datastoremetrics --enabled false

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