Skip to main content

Configurar el acceso a métricas

La API de métricas recopila información sobre los componentes de ArcGIS Enterprise y los equipos en los que se ejecutan esos componentes. Para aprovechar la información que ofrece la API de métricas, deberá crear una clave o un token para autorizar el acceso a las métricas, configurar Prometheus para que recopile las métricas y, si lo desea, configurar Grafana para visualizar las métricas.

Las métricas están habilitadas por defecto, pero puede deshabilitar las métricas en caso necesario.

Configurar permisos de acceso

Antes de extraer las métricas, asegúrese de habilitar los permisos de acceso correctos.

La cuenta que ejecuta cada componente de software debe formar parte del grupo de monitorización de rendimiento para recopilar métricas del equipo.

Para implementaciones de ArcGIS Enterprise, incluido cualquier servidor federado, autentique las solicitudes con una clave API. En el caso de los sitios independientes de ArcGIS Server, autentique las solicitudes mediante un token administrativo.

Nota:

Para que la autenticación se realice correctamente y se puedan obtener métricas de cualquier componente de ArcGIS Enterprise, es necesario que el servicio de Portal for ArcGIS esté disponible. La autenticación para las métricas de ArcGIS Data Store requiere además que se pueda acceder al servidor de alojamiento.

Obtener una clave API usando ArcGIS Enterprise

Para usar ArcGIS Enterprise y obtener una clave API adecuada para acceder a la API de métricas, complete los siguientes pasos:

  1. Inicie sesión en la organización como administrador.

  2. En la pestaña Mi contenido de la página de contenido, haga clic en Nuevo elemento y en Credenciales de desarrollador.

  3. Seleccione las credenciales de la clave de API y, a continuación, haga clic en Siguiente.

  4. Seleccione Aplicación privada con los privilegios y el acceso seleccionados y, a continuación, haga clic en Siguiente.

  5. Seleccione Sin acceso a elementos y, a continuación, haga clic en Siguiente.

  6. Seleccione el privilegio Observabilidad y, a continuación, haga clic en Siguiente.

  7. Seleccione una fecha de caducidad y, si lo desea, las URL de referencia y, a continuación, haga clic en Siguiente.

  8. Agregue un título para el elemento de clave de API y, si lo desea, etiquetas y un resumen; a continuación, haga clic en Siguiente.

  9. Consulte la configuración de la clave de API para garantizar la precisión y, a continuación, haga clic en Siguiente.

  10. Asegúrese de que la opción Generar la clave de API ahora esté seleccionada y, a continuación, haga clic en Siguiente.

  11. Copie la clave de API.

Obtener un token administrativo mediante ArcGIS Server

En el caso de los sitios independientes de ArcGIS Server, puede obtener un token administrativo mediante ArcGIS Server. En el caso de los sitios federados de ArcGIS Server, obtenga una clave de API en su lugar.

  1. Inicie sesión en el Directorio de administrador de ArcGIS Server como usuario con privilegios administrativos.

  2. Haga clic en generateToken.

  3. Proporcione la información siguiente:

    • Nombre de usuario: el nombre de usuario de un usuario con privilegios de administrador

    • Contraseña: la contraseña correspondiente al nombre de usuario especificado

    • Cliente: referencia HTTP

    • Referencia HTTP: una URL que coincide con la referencia especificada en su configuración de Prometheus. La configuración de ejemplo de Prometheus utiliza ARCGIS.COM como referencia.

  4. Si lo desea, establezca un tiempo de caducidad en minutos.

    Nota:

    El tiempo de caducidad predeterminado es de 60 minutos. El tiempo máximo de caducidad predeterminado es de 1.440 minutos (24 horas). Para generar un token de mayor duración, el administrador debe actualizar la configuración del token y aumentar la propiedad longTimeout antes de generar un token. Actúe con precaución al aumentar el valor de longTimeout para asegurarse de que el valor actualizado cumple con sus requisitos de seguridad.

  5. Haga clic en Generar.

  6. Copie el token.

Configurar el servidor Prometheus

Para agregar la API de métricas como destino de recopilación, deberá actualizar su configuración de Prometheus. Para obtener instrucciones sobre cómo implementar Prometheus, consulte la guía de implementación.

Configure una tarea de recopilación independiente para cada componente de ArcGIS Enterprise del que desee obtener métricas. Para cada configuración de recopilación se requiere la siguiente información:

  • job_name: un nombre único para el trabajo.

  • http_sd_configs: la configuración del extremo de detección de servicios. Se requiere la siguiente información:

    • url: la URL del extremo de detección de servicios. Tendrá el formato <scheme>://<machine fqdn>/<context>/monitoring/discovery.

      En el caso de Portal for ArcGIS y ArcGIS Server, se recomienda utilizar la URL del ArcGIS Web Adaptor o del proxy inverso. Por ejemplo, una organización podría utilizar https://portal.example.com/portal/monitoring/discovery para la detección de servicios relacionados con las métricas del portal o https://gisserver.example.com/server/monitoring/discovery para la detección de servicios de un sitio de ArcGIS Server.

      En el caso de ArcGIS Data Store, debe especificar el equipo en el que está instalado el almacén relacional y el número de puerto. Por ejemplo, https://relational.example.com:2443/arcgis/monitoring/discovery

    • bearer_token o bearer_token_file: la clave de API de ArcGIS Enterprise o el token administrativo de ArcGIS Server creado.

      El token se proporciona como parte de http_sd_configs para autenticar el extremo de detección de servicios.

  • bearer_token o bearer_token_file: la clave de API de ArcGIS Enterprise o el token administrativo de ArcGIS Server creado.

    El token se vuelve a proporcionar como parte de la configuración de la extracción para autenticar los extremos de recopilación de métricas.

  • metrics_path: el valor debe ser /arcgis/monitoring/metrics

    Para extraer las métricas de los equipos, es necesario enviar solicitudes directamente a cada uno de ellos. Estas solicitudes no pasan por ningún ArcGIS Web Adaptor ni por ningún proxy inverso que haya configurado. Asegúrese de que el servidor Prometheus pueda acceder a cada equipo de ArcGIS Server a través del puerto 6443 y a cada equipo de Portal for ArcGIS a través del puerto 7443.

  • scheme: o bien http o bien https, dependiendo de si la URL especificada en https_sd_configs está configurada para ser accesible a través de http o https.

Consulte el ejemplo de configuración de Prometheus para ver un archivo de plantilla YAML destinado a recopilar métricas de ArcGIS Enterprise. Puedes usar la plantilla de ejemplo del cuadro de mando para configurar Grafana y visualizar las métricas después de recopilarlas con Prometheus.

Configurar el intervalo de limpieza de métricas

El intervalo predeterminado para limpiar las métricas del sistema es de 1 hora, lo cual es apropiado para la mayoría de las organizaciones. Consulte Borrar métricas para conocer los aspectos que debe tener en cuenta al modificar el intervalo de limpieza.

Si necesita modificar el intervalo de limpieza, los pasos a seguir dependen del componente de ArcGIS Enterprise.

Configurar el intervalo de limpieza de métricas para ArcGIS Server

  1. Inicie sesión en el Directorio de administrador de ArcGIS Server como usuario con privilegios administrativos.

  2. Vaya a Sistema > Propiedades > Actualizar.

  3. En el cuadro de texto Propiedades, agregue un valor para la clave metricsClearingIntervalInHours como JSON.

    Por ejemplo, para establecer un intervalo de dos horas, utilice el siguiente JSON:

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

  4. Haga clic en Actualizar.

  5. Reinicie el servicio de ArcGIS Server.

Configurar el intervalo de limpieza de métricas para Portal for ArcGIS

  1. Inicie sesión en el Directorio de administrador del portal como administrador de su organización.

  2. Vaya a Sistema > Propiedades > Actualizar propiedades.

  3. En el cuadro de texto Propiedades, agregue un valor para la clave metricsClearingIntervalInHours como JSON.

    Por ejemplo, para establecer un intervalo de dos horas, utilice el siguiente JSON:

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

  4. Haga clic en Actualizar propiedades.

    Esta operación reiniciará automáticamente el servicio de Portal for ArcGIS.

Configurar el intervalo de limpieza de métricas para ArcGIS Data Store

Ejecute la utilidad datastoremetrics en el equipo en el que está instalado el almacén relacional y especifique el parámetro interval. Por ejemplo, para establecer un intervalo de dos horas, utilice el siguiente comando:

./datastoremetrics --enabled true --interval 2

datastoremetrics --enabled true --interval 2

Para modificar el intervalo de limpieza de métricas tanto en el almacén relacional principal como en el de reserva, debe ejecutar la utilidad en ambos.

Deshabilitar métricas

Los pasos para deshabilitar las métricas dependen del componente ArcGIS Enterprise.

Deshabilitar métricas para un sitio de ArcGIS Server

  1. Inicie sesión en el Directorio de administrador de ArcGIS Server como usuario con privilegios administrativos.

  2. Vaya a Sistema > Propiedades > Actualizar.

  3. En el cuadro de texto Propiedades, establezca la clave isMetricsEnabled en false:

    {"isMetricsEnabled": false}

  4. Haga clic en Actualizar.

  5. Reinicie el servicio de ArcGIS Server.

Deshabilitar métricas para Portal for ArcGIS

  1. Inicie sesión en el Directorio de administrador del portal como administrador de su organización.

  2. Vaya a Sistema > Propiedades > Actualizar propiedades.

  3. En el cuadro de texto Propiedades, establezca la clave isMetricsEnabled en false:

    {"isMetricsEnabled": false}

  4. Haga clic en Actualizar propiedades.

    Esta operación reiniciará automáticamente el servicio de Portal for ArcGIS.

Deshabilitar métricas para ArcGIS Data Store

Para deshabilitar las métricas de ArcGIS Data Store, ejecute la utilidad datastoremetrics en el equipo en el que esté instalado el almacén relacional utilizando el siguiente comando:

./datastoremetrics --enabled false

datastoremetrics --enabled false

Para deshabilitar las métricas tanto en el almacén relacional principal como en el de reserva, debe ejecutar la utilidad en ambos.