Utilizar la API de métricas
La API de métricas permite supervisar y administrar aplicaciones e infraestructura. La API de métricas permite recopilar y agregar datos en tiempo real, y proporciona información sobre el rendimiento del sistema. Además, los equipos de DevOps pueden utilizar la API para configurar alertas, solucionar problemas y optimizar la asignación de recursos. Al exponer estas métricas de rendimiento, puede detectar mejor las anomalías y los cuellos de botella, así como ser más proactivo en lo que respecta al mantenimiento del sistema. Por último, la API de métricas permite la integración de una gran variedad de herramientas de supervisión y visualización, lo que mejora la capacidad de observar sistemas complejos.
Como administrador, puede usar la API de métricas con consultas PromQL para consultar y obtener directamente métricas sin procesar que puedan utilizar visores o aplicaciones gráficas de terceros, como Grafana, que pueden estar ejecutándose dentro o fuera del clúster.
La API de métricas recopila información sobre servicios, usuarios y elementos de contenido. La API de métricas utiliza el sistema de monitorización Prometheus para conservar la información recopilada en una base de datos de series temporales.
Consulte Métricas de servicio para obtener más información sobre el uso de la API de métricas con el fin de optimizar y resolver problemas de los servicios. Consulte Ver métricas para obtener más información sobre la visualización de información recopilada por la API de métricas.
Acceder a la API de métricas
La API de métricas se expone en la API usagestatistics del directorio de administrador de ArcGIS Enterprise. Para acceder a la API de métricas, siga estos pasos:
Vaya a la API usagestatistics en el directorio de administrador:
https://organization.example.com/<context>/admin/usagestatistics.Haga clic en API de métricas REST.
La aplicación API de métricas se abre en una pestaña nueva.
Inicie sesión en la página web Prometheus.
De forma predeterminada, las credenciales generadas por el sistema se utilizan para iniciar sesión. Antes de iniciar sesión en el cuadro de mando de Prometheus, configure su organización y actualice sus credenciales. Para actualizar estas credenciales, utilice la operación Actualizar credenciales en
admin/usagestatistics.
Información expuesta por la API de métricas
Puede utilizar Prometheus para obtener métricas para ArcGIS Enterprise. Las siguientes tablas resumen las métricas y etiquetas disponibles, que puede utilizar en consultas PromQL y filtros de resultados para acceder a la información que necesita.
Las métricas con el sufijo _created indican el tiempo Unix (en segundos) de los histogramas y resúmenes desde el momento en que se recopiló por primera vez la métrica correspondiente. Este valor ofrece información sobre el ciclo de vida de una métrica. Estas métricas no figuran en las tablas que se muestran a continuación.
Métricas de servicio
Se informa de las métricas de servicios para cada servicio publicado.
|
Nombre |
Descripción |
Tipo |
Etiquetas |
|---|---|---|---|
|
solicitudes_fallidas_totales |
Número de solicitudes fallidas |
counter |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_response_time_seconds_bucket |
Número acumulado de solicitudes observadas que se han completado en un tiempo igual o inferior al límite superior del intervalo, en segundos |
histograma |
apiType, folderName, instance, instancePool, job, le, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_count |
Número total de tiempos de respuesta de solicitudes observadas en todos los buckets |
histograma |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_sum |
Tiempo de respuesta acumulado de todas las solicitudes observadas, en segundos |
histograma |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_counter_total |
Suma del tiempo de respuesta de las solicitudes en segundos |
counter |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
solicitudes_correctas_totales |
Número de solicitudes completadas con éxito |
counter |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
solicitudes_totales |
Número de solicitudes |
counter |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
solicitudes_uso_tiempo_limite_totales |
Número de solicitudes que expiraron por exceder el tiempo máximo de uso |
counter |
apiType, folderName, nodeName, operation, podName, serviceName, serviceType, username |
|
requests_wait_time_seconds_bucket |
Número acumulado de solicitudes que tuvieron que esperar a ser procesadas durante un tiempo menor o igual al límite superior del bucket, en segundos |
counter |
apiType, folderName, instance, instancePool, job, le, nodeName, podName, serviceName, serviceType |
|
requests_wait_time_seconds_count |
Número total de tiempos de espera de solicitudes observadas en todos los buckets |
counter |
apiType, folderName, instance, instancePool, job, nodeName, podName, serviceName, serviceType |
|
requests_wait_time_seconds_sum |
Tiempo de espera acumulado de todas las solicitudes observadas, en segundos |
counter |
apiType, folderName, instance, instancePool, job, nodeName, podName, serviceName, serviceType |
|
solicitudes_espera_tiempo_limitado_totales |
Número de solicitudes que expiraron por exceder el tiempo máximo de espera |
counter |
apiType, folderName, nodeName, operation, podName, serviceName, serviceType, username |
|
up |
Pods en ejecución |
counter |
instance, job |
Métricas de organización
|
Nombre |
Descripción |
Tipo |
Etiquetas |
|---|---|---|---|
|
items_added_total |
Número total de elementos agregados |
counter |
componentName, instance, job, nodeName |
|
items_count |
Número total de elementos |
calibre |
componentName, instance, job, nodeName |
|
items_deleted_total |
Número total de elementos eliminados |
counter |
componentName, instance, job, nodeName |
|
items_updated_total |
Número total de elementos actualizados |
counter |
componentName, instance, job, nodeName |
|
items_viewed_total |
Número total de todos los elementos vistos |
counter |
componentName, instance, job, nodeName |
|
users_added_total |
Número total de usuarios agregados |
counter |
componentName, instance, job, nodeName |
|
users_count |
Número total de usuarios |
calibre |
componentName, instance, job, nodeName |
|
users_login_total |
Número total de inicios de sesión de usuario |
counter |
componentName, instance, job, nodeName |
|
users_logout_total |
Número total de cierres de sesión de usuario |
counter |
componentName, instance, job, nodeName |
Nota:
La métrica items_count no incluye elementos de contenido de Esri, como el contenido de Living Atlas.
Descripciones de etiqueta
| Nombre de etiqueta | Descripción |
|---|---|
| apiType | La API en la que se recopila la métrica. |
| folderName | El nombre de la carpeta donde se crea el servicio. |
| instance | La dirección IP del clúster y el puerto del pod de servicio que gestiona la solicitud. |
| instancePool | El conjunto de instancias utilizado por el servicio, ya sea compartido o dedicado. |
| job | El nombre del trabajo se define en la configuración de Prometheus. |
| le | Límite superior de un bucket en una métrica de histograma. |
| nodeName | Nombre del equipo con el que gestiona la solicitud. |
| operation | La operación solicitada, por ejemplo, una consulta o exportación. La información de operaciones solo está disponible para solicitudes REST. Las solicitudes SOAP solo devuelven un valor de soap. |
| podName | El nombre del pod de servicio que gestiona la solicitud. |
| responseCached | Indicador booleano para señalar si la respuesta se ha servido desde la caché. |
| serviceName | El nombre del servicio, incluido el nombre de la carpeta en la que reside el servicio. |
| serviceType | El tipo de servicio, por ejemplo, un MapService o FeatureService. |
| nombre de usuario | El nombre de usuario del usuario que realiza la solicitud. |