Использование метрик API
API метрик позволяет отслеживать и управлять приложениями и инфраструктурой. API метрик позволяет собирать и агрегировать данные в режиме реального времени, а также дает представление о производительности вашей системы. Кроме того, команды DevOps могут использовать API для настройки оповещений, устранения неполадок и оптимизации распределения ресурсов. Предоставляя доступ к этим показателям производительности, вы сможете лучше выявлять аномалии и узкие места и более активно обслуживать систему. Наконец, API метрик позволяет интегрировать широкий спектр инструментов мониторинга и визуализации, расширяя возможности наблюдения за сложными системами.
Как администратор, вы можете использовать API метрик с запросами PromQL для создания прямых запросов и получения необработанных показателей, которые могут использоваться сторонними средствами просмотра или графическими приложениями, такими как Grafana, которые могут работать внутри кластера или за его пределами.
API метрик собирает информацию о сервисах, пользователях и ресурсах. Система мониторинга Prometheus используется API метрик для сохранения собранной информации в базу данных временных рядов.
См. Метрики сервиса для получения дополнительной информации об использовании API метрик для оптимизации и устранения неполадок в работе сервисов. См. Просмотреть метрики для получения дополнительной информации о визуализации данных, собранных API метрик.
Использование API метрик
API метрик представлен в API статистики использования в ArcGIS Enterprise в Каталоге администратора. Для доступа к API метрик выполните следующие шаги:
Перейдите к API usagestatistics в каталоге администратора:
https://organization.example.com/<context>/admin/usagestatistics.Щелкните Rest Metrics API.
Приложение API метрик откроется в новой вкладке.
Войдите на веб-страницу Prometheus.
По умолчанию для входа используются учетные данные, созданные системой. Прежде чем войти в операционную панель Prometheus, настройте свою организацию и обновите учетные данные. Чтобы обновить эти учетные данные, используйте операцию Обновить учетные данные в
admin/usagestatistics.
Информация, предоставляемая API метрик
Вы можете использовать Prometheus для получения метрик для ArcGIS Enterprise. Следующие таблицы суммируют доступные метрики и метки, которые вы можете использовать в запросах PromQL и фильтрах результатов для доступа к нужной информации.
Метрики с суффиксом _created отражают unix-время (секунды) гистограмм и резюме с момента первого сбора соответствующей метрики. Это значение даёт представление о жизненном цикле метрики. Эти метрики не включены в таблицы ниже.
Метрики сервиса
Метрики сервиса предоставляются для каждого опубликованного сервиса.
|
Имя |
Описание |
Тип |
Подписи |
|---|---|---|---|
|
requests_failed_total |
Количество неудачных запросов |
счетчик |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_response_time_seconds_bucket |
Совокупное количество завершённых запросов за секунды — менее или равное верхней границе бакета, в секундах |
гистограмма |
apiType, folderName, instance, instancePool, job, le, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_count |
Число наблюдаемых времен отклика запросов по всем бакетам |
гистограмма |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_sum |
Накопленное время отклика на все обнаруженные запросы в секундах |
гистограмма |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_counter_total |
Сумма времени ответа запросов в секундах |
счетчик |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_succeeded_total |
Количество выполненных запросов |
счетчик |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_total |
Количество запросов |
счетчик |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_usage_timedout_total |
Число запросов, время ожидания которых истекло из-за превышения максимального времени использования |
счетчик |
apiType, folderName, nodeName, operation, podName, serviceName, serviceType, username |
|
requests_wait_time_seconds_бакет |
Накопленное число запросов, время ожидания обработки которых меньше или равно верхней границе бакета, в секундах |
счетчик |
apiType, folderName, instance, instancePool, job, le, nodeName, podName, serviceName, serviceType |
|
requests_wait_time_seconds_count |
Общее число наблюдаемых времен ожидания запросов по всем бакетам |
счетчик |
apiType, folderName, instance, instancePool, job, nodeName, podName, serviceName, serviceType |
|
requests_wait_time_seconds_sum |
Накопленное время ожидания всех наблюдаемых запросов, в секундах |
счетчик |
apiType, folderName, instance, instancePool, job, nodeName, podName, serviceName, serviceType |
|
requests_wait_timedout_total |
Число запросов, время ожидания которых превысило максимальное время ожидания |
счетчик |
apiType, folderName, nodeName, operation, podName, serviceName, serviceType, username |
|
up |
Запущенные модули |
счетчик |
instance, job |
Метрики организации
|
Имя |
Описание |
Тип |
Подписи |
|---|---|---|---|
|
items_added_total |
Общее количество добавленных элементов |
счетчик |
componentName, instance, job, nodeName |
|
items_count |
Общее количество элементов |
датчик |
componentName, instance, job, nodeName |
|
items_deleted_total |
Общее количество удаленных элементов |
счетчик |
componentName, instance, job, nodeName |
|
items_updated_total |
Общее количество обновлённых элементов |
счетчик |
componentName, instance, job, nodeName |
|
items_viewed_total |
Общее количество всех просмотренных элементов |
счетчик |
componentName, instance, job, nodeName |
|
users_added_total |
Общее количество добавленных пользователей |
счетчик |
componentName, instance, job, nodeName |
|
users_count |
Общее количество пользователей |
датчик |
componentName, instance, job, nodeName |
|
users_login_total |
Общее количество входов пользователей |
счетчик |
componentName, instance, job, nodeName |
|
users_logout_total |
Общее количество выходов пользователей |
счетчик |
componentName, instance, job, nodeName |
Примечание:
Метрика items_count не включает элементы ресурсов Esri, например, ресурсы Living Atlas.
Описания меток
| Название метки | Описание |
|---|---|
| apiType | API, в котором собираются показатели. |
| folderName | Имя папки, где создан сервис. |
| instance | IP-адрес кластера и порт модуля сервиса, обрабатывающего запрос. |
| instancePool | Пул экземпляров, используемый сервисом, общий или выделенный. |
| задание | Имя задания, определенное в конфигурации Prometheus. |
| le | Верхняя граница бакета в метрике гистограммы. |
| nodeName | Имя компьютера с сервисом, обрабатывающим запрос. |
| операция | Требуемая операция, например, запрос или экспорт. Информация об операции доступна только для запросов REST. Запросы SOAP возвращают только значение SOAP. |
| podName | Имя модуля сервиса, обрабатывающего запрос. |
| responseCached | Булев индикатор, определяющий, был ли ответ взят из кэша. |
| serviceName | Имя сервиса, включая имя папки, в которой находится этот сервис. |
| serviceType | Тип сервиса, например, MapService или FeatureService. |
| username | Имя пользователя, отправляющего запрос. |