Cómo administrar monitores sintéticos

En este documento, se describe cómo administrar tus monitores sintéticos. Puedes ver una lista de tus supervisores sintéticos y, para cada uno, puedes ver y modificar la configuración y el historial de ejecuciones y detalles sobre cada ejecución. Puedes administrar tus supervisores sintéticos mediante la consola de Google Cloud o la API de Cloud Monitoring.

Si quieres obtener información para explorar los resultados de la ejecución y las métricas y los registros de un monitor sintético, consulta Explora los resultados del monitor sintético.

Antes de comenzar

  • Si quieres obtener los permisos que necesitas para ver y modificar monitores sintéticos con la consola de Google Cloud, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

    Si quieres obtener más información para otorgar roles, consulta Administra el acceso.

    Es posible que también puedas obtener los permisos necesarios a través de funciones personalizadas o, también, otras funciones predefinidas.

  • Las instrucciones de la API que se incluyen en esta página son para el Explorador de APIs. Sin embargo, también puedes emitir un comando curl. El Explorador de APIs proporciona la sintaxis curl.

Mostrar lista de supervisores sintéticos

Consola

Para obtener una lista de los supervisores sintéticos de tu proyecto de Google Cloud, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Supervisión sintética:

    Ir a Supervisión sintética

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Opcional: Para restringir los monitores sintéticos que se enumeran, agrega filtros.

    Cada filtro se compone de un nombre y un valor. Puedes establecer que el valor sea una coincidencia exacta para un nombre de monitor sintético o una coincidencia parcial. Las coincidencias no distinguen mayúsculas de minúsculas. Por ejemplo, para enumerar todos los monitores sintéticos cuyo nombre contenga default, haz lo siguiente:

    • Haz clic en Filtrar tabla (Filter table) y selecciona Nombre visible (Display name).
    • Ingresa default y, luego, presiona la tecla Intro.

    Si tienes varios filtros, estos se unen de manera automática con un AND lógico, a menos que insertes un filtro OR. En el ejemplo anterior, se usa el filtro OR para que aparezca una verificación de tiempo de actividad si su nombre coincide con default o Testing check.

En la página Monitores sintéticos, se muestra lo siguiente para cada monitor sintético:

  • Estado de la ejecución más reciente.
  • Es un vínculo a información detallada sobre ese monitor sintético.
  • La tasa de éxito y el tiempo promedio de ejecución.
  • El número de políticas de alertas.
  • Para editar, copiar o borrar el monitor sintético y crear una política de alertas, usa el menú Más opciones.

gcloud

Para enumerar tus verificaciones de tiempo de actividad y los monitores sintéticos, ejecuta el comando gcloud monitoring uptime list-configs:

gcloud monitoring uptime list-configs

Entre los datos que se muestran, se incluyen los siguientes:

  • Nombre y nombre visible.
  • Verifica el identificador.
  • Recurso supervisado.
  • Período entre verificaciones.

Puedes configurar el comando de Google Cloud CLI para filtrar y ordenar los resultados.

API

Para obtener una lista de los supervisores sintéticos de tu proyecto de Google Cloud, incluidas las verificaciones de tiempo de actividad, llama al método projects.uptimeCheckConfigs.list:

  1. Haz clic en projects.uptimeCheckConfigs.list.

  2. Usa el Explorador de APIs.

    Configura el parent del método con el nombre del proyecto y asegúrate de usar el siguiente formato:

    projects/PROJECT_ID

    En la expresión anterior, PROJECT_ID es el ID del proyecto de Google Cloud.

Para un monitor sintético, el resultado contiene un campo etiquetado syntheticMonitor.

Ver detalles de un monitor sintético

Consola

Para ver los detalles de un monitor sintético en el proyecto de Google Cloud, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Supervisión sintética:

    Ir a Supervisión sintética

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Para abrir la página Detalles del monitor sintético, ubica el que deseas ver y haz clic en su nombre.

    Si deseas ver tu Cloud Function desde la página Detalles de las funciones que proporciona Cloud Functions, selecciona la pestaña Código y haz clic en el nombre de la función. La página Detalles de las funciones se abre en una ventana nueva. En las pestañas de esta página, puedes ver las métricas, los registros y la información de configuración.

gcloud

Para ver una lista de los detalles de una verificación de tiempo de actividad o un monitor sintético, ejecuta el comando gcloud monitoring uptime describe:

gcloud monitoring uptime describe CHECK_ID

Antes de ejecutar el comando anterior, reemplaza CHECK_ID por el identificador de la verificación de tiempo de actividad o del monitor sintético. Puedes encontrar el identificador ejecutando el comando gcloud monitoring uptime list-configs y examinando el campo name. Para obtener más información, consulta Encuentra el identificador único de un monitor sintético.

Los datos que se muestran para la verificación de tiempo de actividad incluyen lo siguiente:

  • Nombre y nombre visible.
  • Verifica el identificador.
  • Recurso supervisado.
  • Período entre verificaciones.

API

Para enumerar los detalles de un monitor sintético específico en tu proyecto de Google Cloud, llama al método projects.uptimeCheckConfigs.get:

  1. Haz clic en projects.uptimeCheckConfigs.get.

  2. Usa el Explorador de APIs.

    Configura el parent del método como el identificador del monitor sintético. Asegúrate de usar el siguiente formato:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    En la expresión anterior, PROJECT_ID es el ID del proyecto de Google Cloud y CHECK_ID es el ID del monitor sintético.

    Por ejemplo, el valor del campo superior podría ser el siguiente:

    projects/my-project/uptimeCheckConfigs/10863117100295372627

    Para encontrar el valor de CHECK_ID, puedes emitir el método projects.uptimeCheckConfigs.list. Para reducir la cantidad de resultados que se muestran, incluye un filtro. Por ejemplo, agrega el filtro displayName="MySyntheticMonitor".

Edita un monitor sintético o una Cloud Function

Consola

Para editar un monitor sintético o su Cloud Function mediante la página Detalles del monitor sintético, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Supervisión sintética:

    Ir a Supervisión sintética

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Ubica el monitor sintético que deseas editar, haz clic en Más opciones y, luego, selecciona Editar.

  3. Opcional: Para editar la Cloud Function, haz clic en Editar función, realiza los cambios y, luego, haz clic en Aplicar función.

    En el caso de los verificadores de vínculos rotos, para modificar el URI de origen o las opciones que definen qué vínculos se prueban, edita la Cloud Function y, luego, actualiza el objeto options en el archivo index.js. Para obtener información sobre los campos y la sintaxis de este objeto, consulta broken-links-ok/index.js.

  4. Para conservar las modificaciones, haz clic en Guardar. De lo contrario, haz clic en Cancelar.

gcloud

Para modificar una verificación de tiempo de actividad o un monitor sintético, ejecuta el comando gcloud monitoring uptime update:

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS

Antes de ejecutar el comando anterior, haz lo siguiente:

  • Reemplaza CHECK_ID por el identificador de la verificación de tiempo de actividad o el monitor sintético. Para encontrar el identificador, ejecuta el comando gcloud monitoring uptime list-configs y examina el campo name. Para obtener más información, consulta Encuentra el identificador único de una verificación de tiempo de actividad.

  • Define qué campos quieres modificar. En el caso de los supervisores sintéticos, solo puedes actualizar los siguientes campos:

    • Período
    • Nombre visible
    • Tiempo de espera
    • Etiquetas de usuario

Por ejemplo, para establecer el período de un monitor sintético en 10 minutos, ejecuta el siguiente comando:

gcloud monitoring uptime update CHECK_ID --period=10

API

Las políticas y funciones de alertas no están incluidas en un monitor sintético y, por lo tanto, no se pueden editar mediante el procedimiento descrito en esta sección:

Para editar un monitor sintético, llama al método projects.uptimeCheckConfigs.patch:

  1. Haz clic en projects.uptimeCheckConfigs.patch.

  2. Usa el Explorador de APIs.

    1. Configura el parent del método como el identificador del monitor sintético. Asegúrate de usar el siguiente formato:

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

      En la expresión anterior, PROJECT_ID es el ID del proyecto de Google Cloud y CHECK_ID es el ID del monitor sintético.

      Para encontrar el valor de CHECK_ID, puedes emitir el método projects.uptimeCheckConfigs.list. Para reducir la cantidad de resultados que se muestran, incluye un filtro. Por ejemplo, agrega el filtro displayName="MySyntheticMonitor".

    2. Establece el parámetro de consulta del método, updateMask, para identificar qué campos del objeto se modifican. Por ejemplo, para actualizar el valor de displayName, el parámetro de consulta es el siguiente:

      updateMask=displayName

Copia un monitor sintético

Consola

Para copiar un monitor sintético en tu proyecto de Google Cloud, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Supervisión sintética:

    Ir a Supervisión sintética

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Ubica el monitor sintético que deseas editar, haz clic en Más opciones y, luego, selecciona Copiar.

    Se abrirá el diálogo Copiar verificación sintética con campos prepropagados, incluida una copia de laCloud Functions.

  3. Haz clic en Crear función, actualízala según sea necesario y, luego, haz clic en Aplicar función.

  4. Para conservar tus modificaciones, haz clic en Crear. De lo contrario, haz clic en Cancelar.

    Cuando haces clic en Crear, se crea e implementa tu Cloud Function y, luego, se crea el monitor sintético.

gcloud

No existe un método de Google Cloud CLI que te permita copiar un monitor sintético.

API

No hay un método de API que te permita copiar un monitor sintético. Sin embargo, puedes crear una copia con los siguientes pasos:

  1. Llama al método projects.uptimeCheckConfigs.get y guarda la respuesta. Para obtener más información, consulta Visualiza los detalles de un monitor sintético.
  2. Edita la respuesta.
  3. Llama al método projects.uptimeCheckConfigs.create y pasa la respuesta editada al método.

Borrar un monitor sintético

Consola

Para borrar un monitor sintético y cualquier política de alertas asociada, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Supervisión sintética:

    Ir a Supervisión sintética

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Ubica el monitor sintético que deseas borrar y haz clic en el nombre.

  3. Opcional: Si deseas borrar la Cloud Function, selecciona la pestaña Code y haz clic en el nombre de la función. La página Detalles de las funciones se abre en una ventana nueva.

  4. En la página Detalles del monitor sintético, haz clic en Borrar y, luego, completa el diálogo.

    Ya borraste el monitor sintético.

  5. Para borrar la Cloud Function, ve a la página Detalles de las funciones, haz clic en Borrar y, luego, completa el cuadro de diálogo.

gcloud

Para borrar una verificación de tiempo de actividad o un monitor sintético, ejecuta el comando gcloud monitoring uptime delete:

gcloud monitoring uptime delete CHECK_ID

Antes de ejecutar el comando anterior, reemplaza CHECK_ID por el identificador de la verificación de tiempo de actividad o del monitor sintético. Puedes encontrar el identificador ejecutando el comando gcloud monitoring uptime list-configs y examinando el campo name. Para obtener más información, consulta Encuentra el identificador único de un monitor sintético.

API

Para borrar un monitor sintético y las políticas de alertas asociadas, llama al método projects.uptimeCheckConfigs.delete:

  1. Haz clic en projects.uptimeCheckConfigs.delete.

  2. Usa el Explorador de APIs.

    Configura el parent del método como el identificador del monitor sintético. Asegúrate de usar el siguiente formato:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    En la expresión anterior, PROJECT_ID es el ID del proyecto de Google Cloud y CHECK_ID es el ID del monitor sintético.

    Para encontrar el valor de CHECK_ID, puedes emitir el método projects.uptimeCheckConfigs.list. Para reducir la cantidad de resultados que se muestran, incluye un filtro. Por ejemplo, agrega el filtro displayName="MySyntheticMonitor".

Encuentra el identificador único de un monitor sintético

Cuando se crea el monitor sintético, Monitoring le asigna un identificador. Este identificador está incorporado en el nombre del recurso del monitor sintético y tiene el siguiente formato:

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

CHECK_ID se incluye en la respuesta de los métodos de Google Cloud CLI y la API de Cloud Monitoring que crean o enumeran supervisores sintéticos.

¿Qué sigue?