Как администратор, вы можете использовать API метрик с запросами PromQL для создания прямых запросов и получения необработанных показателей, которые могут использоваться сторонними средствами просмотра или графическими приложениями, такими как Grafana, которые могут работать внутри кластера или за его пределами.
Для сбора этих показателей из модулей ГИС-сервиса и сохранения соответствующей информации в базе данных временных рядов API метрик использует систему мониторинга Prometheus. Вьюер метрик регистрирует API метрик в качестве хранилища данных, поэтому он может опрашивать API метрик и получать статистику использования.
API метрик отображается в API usagestatistics в каталоге администратора. Для доступа к API метрик выполните следующие шаги:
- Перейдите к API usagestatistics в каталоге администратора: https://organization.example.com/<context>/admin/usagestatistics.
- Щелкните Rest Metrics API.
Приложение API метрик откроется в новой вкладке.
- Войдите на веб-страницу Prometheus.
По умолчанию для входа используются учетные данные, созданные системой. Прежде чем войти в операционную панель Prometheus, настройте свою организацию и обновите учетные данные. Для обновления этих учетных данных выполните в admin/usagestatistics операцию Обновление учетных данных. Новый пароль должен содержать не менее восьми символов и содержать по крайней мере по одному из следующих элементов:
- Буквы от А до Z (верхнего или нижнего регистров)
- Цифры от 0 до 9
- Поддерживаются специальные символы ( # ! % & , - . / : ; < = > @ _ ` ~ и пробел)
Внимание:
Эти специальные символы не поддерживаются: ^ ? \ * + \ | $
Необработанные метрики, собранные API метрик
Следующая таблица содержит сведения о необработанных показателях, собранных с помощью API метрик:
| № п/п | Наименование показателя | Описание | Тип |
|---|---|---|---|
1 | requests | Запросы, которые можно использовать для определения частоты запросов. | Счетчик |
2 | requests_succeeded | Успешные запросы, которые можно использовать для определения количества успешных запросов. | Счетчик |
3 | requests_failed | Неудавшиеся запросы, которые можно использовать для определения количества неудавшихся запросов. | Счетчик |
4 | requests_usage_timedout | Запросы с истекшим временем использования, которые можно использовать для определения количества запросов с истекшим временем использования. | Счетчик |
5 | requests_wait_timedout | Запросы с истекшим временем ожидания, которые можно использовать для определения количества запросов с истекшим временем ожидания. | Счетчик |
6 | requests_response_time_seconds | Время отклика в секундах Образцы, наблюдения и итоги включены в блоки: 0.05, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 и Inf. | Гистограмма |
7 | gp_job_wait_time_seconds | Время, затрачиваемое на выбор задания геообработки для выполнения, в секундах. Образцы, наблюдения и итоги включены в блоки: 0.05, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 и Inf. | Гистограмма |
Метки, полученные API метрик
Наряду с необработанными показателями, сбор которых выполняет API метрик, собираются также метки, описание которых содержится в представленной ниже таблице, которые могут использоваться для получения показателей с API метрик с использованием запросов PromQL и фильтрацией результатов:
| Название метки | Описание |
|---|---|
nodeName | Имя машины с модулем сервиса, обрабатывающим запрос. |
podName | Имя модуля сервиса, обрабатывающего запрос. |
apiType | API, в котором собираются показатели. Текущее возможное значение - service, что означает запрос к сервису. |
folderName | Имя папки, где создан сервис. |
serviceName | Имя сервиса, включая имя папки, в которой находится этот сервис. |
serviceType | Тип сервиса, например, MapService или FeatureService. |
Операция | Требуемая операция, например, запрос или экспорт. Примечание:Информация об операции доступна только для запросов REST. Запросы SOAP возвращают только значение soap. |
orgId | ID организации. |
username | Имя пользователя лица, отправляющего запрос. |