Crear un verificador de vínculos rotos

En este documento, se describe cómo configurar una prueba periódica de los vínculos contenidos en un URI mediante la creación de un monitor sintético. Especifica las opciones para la prueba, como el URI de origen, la cantidad de vínculos probados y la cantidad de reintentos, y, luego, implementa una Cloud Function preconfigurada. Para respaldar tus esfuerzos de solución de problemas y depuración, los supervisores sintéticos guardan información detallada sobre cada prueba, incluidas las capturas de pantalla. Las capturas de pantalla te permiten ver la respuesta exacta de los clientes de tu aplicación.

Para obtener más información sobre los monitores sintéticos, consulta Acerca de los monitores sintéticos.

Acerca de los verificadores de vínculos rotos

Cada verificador de vínculos rotos prueba los vínculos en serie, y hay un tiempo de espera sintético general que se puede configurar.

De forma predeterminada, un verificador de vínculos rotos hace lo siguiente:

• Busca el URI de origen en busca de elementos de anclaje HTML con atributos href.
• Prueba los primeros 10 vínculos que se encuentran en el URI de origen.
• Para cada vínculo, el verificador emite una solicitud y, luego, espera una respuesta como máximo 30 segundos. Cuando se recibe una respuesta, el verificador comprueba que el estado de la respuesta HTTP sea 200, lo que indica una respuesta correcta. El verificador no realiza reintentos.

Debes especificar el URI de origen. Puedes configurar qué elementos HTML busca el verificador de vínculos rotos, la cantidad máxima de elementos que se prueban, el tiempo de espera por prueba y si se realizan los reintentos. También puedes configurar verificadores de vínculo roto para que esperen a que aparezca un selector.

Los verificadores de vínculos rotos usan la plantilla broken-links-ok. La configuración de un verificador de vínculos rotos se especifica mediante el objeto options del archivo index.js. Si creas el verificador con la consola de Google Cloud, se te solicitará cada opción de configuración, y la Cloud Function se actualizará automáticamente. Sin embargo, si usas la API de Cloud Monitoring o Terraform, debes propagar este objeto.

Después de crear un verificador de vínculos rotos, actualiza el objeto options y vuelve a implementar la Cloud Function para modificar la configuración.

Antes de comenzar

1. 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:

   • Editor de Monitoring (roles/monitoring.editor)
   • Desarrollador de Cloud Functions (roles/cloudfunctions.developer)

   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.

2. Habilita las API de Cloud Monitoring API, Artifact Registry API, Cloud Build API, Cloud Functions API, Cloud Logging API, Pub/Sub API, and Cloud Run Admin API.

   Habilita las API

3. Verifica que el proyecto de Google Cloud contenga la cuenta de servicio predeterminada de Compute Engine. Esta cuenta de servicio se crea cuando habilitas la API de Compute Engine y tiene un nombre similar a [e-mail].

   En la consola de Google Cloud, ve a la página Cuentas de servicio:

   Ir a Cuentas de servicio

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

   Si la cuenta de servicio predeterminada de Compute Engine no existe, haz clic en Crear cuenta de servicio y completa el cuadro de diálogo.

4. Asegúrate de que a la cuenta de servicio predeterminada de Compute Engine, o a la cuenta de servicio que creaste, se le haya otorgado el rol de editor (roles/editor).

   Para ver los roles otorgados a tu cuenta de servicio, haz lo siguiente:

   1. En la consola de Google Cloud, ve a la página IAM:

      Ir a IAM

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

   2. Selecciona Incluir asignaciones de roles proporcionadas por Google.
   3. Si la cuenta de servicio que usa el monitor sintético no aparece en la lista o si no se le otorgó un rol que incluya los permisos en el rol de agente de Cloud Trace (roles/cloudtrace.agent), otorga este rol a tu cuenta de servicio.
5. Configura los canales de notificaciones que deseas usar para recibir notificaciones. Te recomendamos que crees varios tipos de canales de notificaciones. Para obtener más información, consulta Crea y administra canales de notificaciones y Crea y administra canales de notificaciones por API.

Crear un verificador de vínculos rotos

Consola

Cuando creas un monitor sintético con la consola de Google Cloud, se implementa una Cloud Function (2ª gen..) nueva y se crea el monitor para esa Cloud Function. No puedes crear un monitor sintético que supervise una Cloud Functiond existente.

1. Asegúrate de haber habilitado las API requeridas, de que tu proyecto contenga una cuenta de servicio predeterminada de Compute Engine y de que a esta cuenta se le haya otorgado la función de editor (roles/editor). Para obtener más información, consulta Antes de comenzar.

2. 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.

3. Selecciona Crear monitor sintético.
4. En la plantilla, selecciona Verificador de vínculos rotos.
5. Ingresa un nombre para el monitor sintético.

6. Opcional: Actualiza el Tiempo de espera de respuesta, la Frecuencia de verificación y agrega las etiquetas definidas por el usuario.

7. Configura el URI y los elementos que se probarán:

   Nota: Los valores en los campos de configuración del URI se copian en el objeto Options del archivo index.js cuando haces clic en Crear función. Después de hacer clic en Crear función, edita el objeto Options para cambiar la configuración. Para obtener más información, consulta Edita un monitor sintético o una Cloud Function.

   1. Haz clic en URI de origen y, luego, ingresa un URI que quieras probar. El valor que ingreses debe ser un extremo HTTP o HTTPS. Por ejemplo, puedes ingresar https://mywebsite.example.com.

   2. Opcional: En Cantidad de vínculos que se deben seguir, actualiza la cantidad máxima de vínculos que se evalúan. El valor predeterminado de este campo es 10.

   3. Opcional: En el campo Selector de elementos HTML, ingresa el elemento HTML que deseas que coincida, como una lista separada por comas. El valor que ingreses se convertirá en una string y, luego, se pasará al método Document: querySelectorAll().

      De forma predeterminada, este campo se establece en a, que coincide con los anclas. Puedes ingresar valores como a, img, cuando quieras hacer coincidir los anclas y las imágenes.

   4. Opcional: En el campo Atributos HTML que se seguirán, ingresa los atributos HTML que deseas que coincidan. Los valores separados por comas que ingreses se pasan de manera individual al método getAttribute().

      De forma predeterminada, este campo se establece en href, que especifica el URI del vínculo. Puedes ingresar varios atributos; por ejemplo, ingresa href, src. En este ejemplo, el código busca el atributo href y, luego, el atributo src.

   5. Opcional: Configura la espera del selector, el tiempo de espera por URI, los reintentos y los códigos de estado esperados:

      1. Haz clic en Mostrar más opciones.

      2. Si deseas configurar el verificador de vínculos rotos para que espere a que un selector específico aparezca en el URI antes de que se extraiga cualquier vínculo, ingresa los selectores de CSS en el campo Esperar el selector de elementos. El valor que ingreses se convertirá en una string y, luego, se pasará al método page.waitForSelector().

         Si el selector no aparece antes de que venza el tiempo de espera, la falla se registra en los registros.

      3. Actualiza el orden en que se seleccionan los vínculos para las pruebas.

      4. Configura los reintentos.

         De forma predeterminada, se envía una solicitud a cada vínculo y, si la solicitud inicial falla por algún motivo (por ejemplo, se agota el tiempo de espera del comando o el código de estado HTTP no es 200), el vínculo se marca como con errores.

         Este campo especifica la cantidad de veces que el verificador de vínculos rotos puede emitir una solicitud HTTP a un vínculo antes de marcarlo como con errores.

      5. Configura un tiempo de espera que se aplique a cada URI. De forma predeterminada, este valor se establece en 30 segundos.

      6. Para especificar el código de estado esperado y agotar el tiempo de espera de un URI específico, haz clic en Add per-link option y completa el diálogo.

8. Opcional: Configura si se recopilan y guardan las capturas de pantalla de las respuestas. Si utilizas la configuración predeterminada, las capturas de pantalla no se guardarán. Si habilitas la recopilación de capturas de pantalla, puedes recopilar capturas de pantalla de todas las pruebas o solo de las pruebas fallidas. Cloud Monitoring usa la siguiente convención para asignar un nombre al bucket de Cloud Storage:

   gcm-PROJECT_ID-synthetics-LOCATION
   

   En la expresión anterior:

   • PROJECT_ID: El ID del proyecto de Google Cloud.
   • LOCATION: Es la ubicación del bucket de Cloud Storage.

   Tienes la opción de usar un bucket de Cloud Storage existente.

9. Revisa tu configuración y asegúrate de que sea correcta y esté completa. Luego, crea tu Cloud Function:

   1. Haz clic en Crear función.

      Los valores en los campos de configuración del URI se copian en el objeto Options en el archivo index.js cuando haces clic en Crear función. Después de hacer clic en Crear función, edita el objeto Options para cambiar la configuración.

   2. Ingresa un nombre visible y selecciona una región. Los nombres deben ser únicos dentro de una región.

      Nota: No incluyas un guion bajo en el nombre de tu Cloud Function.

   3. En la sección Configuración del entorno de ejecución, la compilación, las conexiones y la seguridad, haz lo siguiente:

      • En la pestaña Conexiones, asegúrate de que la opción Permitir todo el tráfico esté seleccionada.

      • Revisa la configuración predeterminada y actualízala cuando sea necesario.

        Nota: Es posible que la configuración predeterminada para la memoria asignada, la CPU y la seguridad no sea suficiente. Recomendamos que la memoria se configure en al menos 2 GiB.

      • En el campo Cuenta de servicio del entorno de ejecución, selecciona una cuenta de servicio.

   4. Haz clic en Aplicar función.

10. Configura la política de alertas:

    1. Opcional: Actualiza el nombre de la política de alertas y la duración de la falla antes de que se envíen las notificaciones.

    2. Agrega los canales de notificación.

11. Haz clic en Crear.

    La Cloud Function que definiste se compila y se implementa como 2ª gen.., y se crea el monitor sintético.

API

El proceso de creación de un verificador de vínculos rotos con la API de Cloud Monitoring es idéntico al proceso de crear cualquier otro monitor sintético. Si quieres obtener información sobre cómo usar la API de Cloud Monitoring para crear un monitor sintético, consulta Crea un monitor sintético y selecciona la pestaña de Cloud Monitoring.

Nota: No incluyas un guion bajo en el nombre de tu Cloud Function.

Los verificadores de vínculos rotos usan la plantilla broken-links-ok. La configuración de un verificador de vínculos rotos se especifica mediante el objeto options del archivo index.js.

Cuando se define la estructura options.screenshot_options, el verificador de vínculos rotos recopila capturas de pantalla y las guarda en un bucket de Cloud Storage. Si el campo screenshot_options.storage_location no está definido o si el valor es una string vacía, Monitoring crea un bucket de Cloud Storage y se guardan las capturas de pantalla en ese bucket. Monitoring usa la siguiente convención para nombrar el bucket de Cloud Storage:

gcm-PROJECT_ID-synthetics-LOCATION

En la expresión anterior:

• PROJECT_ID: El ID del proyecto de Google Cloud.
• LOCATION: Es la ubicación del bucket de Cloud Storage.

Terraform

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform. Para obtener más información, consulta la documentación de referencia del proveedor de Terraform.

El proceso de creación de un verificador de vínculos rotos con Terraform es idéntico al proceso de crear cualquier otro monitor sintético. Si quieres obtener información sobre el uso de Terraform para crear un monitor sintético, consulta Crea un monitor sintético y selecciona la pestaña de Terraform.

Nota: No incluyas un guion bajo en el nombre de tu Cloud Function.

Los verificadores de vínculos rotos usan la plantilla broken-links-ok. La configuración de un verificador de vínculos rotos se especifica mediante el objeto options del archivo index.js.

Cuando se define la estructura options.screenshot_options, el verificador de vínculos rotos recopila capturas de pantalla y las guarda en un bucket de Cloud Storage. Si el campo screenshot_options.storage_location no está definido o si el valor es una string vacía, Monitoring crea un bucket de Cloud Storage y se guardan las capturas de pantalla en ese bucket. Monitoring usa la siguiente convención para nombrar el bucket de Cloud Storage:

gcm-PROJECT_ID-synthetics-LOCATION

En la expresión anterior:

• PROJECT_ID: El ID del proyecto de Google Cloud.
• LOCATION: Es la ubicación del bucket de Cloud Storage.

Explorar resultados

Para cada ejecución, un verificador de vínculos rotos hace lo siguiente:

• Genera una tabla, en la que cada fila proporciona información sobre la prueba de un URI específico. La información de resumen incluye el URI de destino, la latencia, el estado y el identificador del elemento HTML. Por ejemplo, esta columna muestra a cuando se prueba un elemento de anclaje HTML. Cuando la fila corresponde al URI de origen, el valor del identificador del elemento HTML es -.

• Recopila métricas, datos de seguimiento y datos de registro.

• Recopila capturas de pantalla cuando se configuran.

Si quieres obtener más información para explorar los datos recopilados, consulta Explora los resultados del monitor sintético.

Solucionar problemas

En esta sección, se proporciona información que puedes usar para solucionar problemas relacionados con los verificadores de vínculos rotos.

No se puede editar la configuración de un verificador de vínculos rotos

Creaste un verificador de vínculos rotos con la consola de Google Cloud y deseas cambiar los elementos HTML que se prueban o si deseas modificar el tiempo de espera del URI, los reintentos, la espera del selector y las opciones por vínculo. Sin embargo, cuando editas el verificador de vínculos rotos, la consola de Google Cloud no muestra los campos de configuración.

Para solucionar este error, 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. Haz clic en Editar función.

4. Edita el objeto options en el archivo index.js y, luego, haz clic en Aplicar función.

   Para obtener información sobre los campos y la sintaxis de este objeto, consulta broken-links-ok/index.js.

5. Haz clic en Guardar.

Pantallas de la consola de Google Cloud que fallan cuando se guardan las capturas de pantalla

Nota: Un monitor sintético que no puede guardar capturas de pantalla continúa probando los vínculos contenidos en un URI.

Creaste un verificador de vínculos rotos y lo configuraste para guardar capturas de pantalla. Sin embargo, la consola de Google Cloud muestra uno de los siguientes mensajes de advertencia junto con información más detallada:

• InvalidStorageLocation
• StorageValidationError
• BucketCreationError
• ScreenshotFileUploadError

Para solucionar estos errores, intenta lo siguiente:

• Si ves el mensaje InvalidStorageLocation, verifica la existencia del bucket de Cloud Storage especificado en el campo llamado options.screenshot_options.storage_location.

• Visualiza los registros relacionados con tu Cloud Function. Para obtener más información, consulta Busca registros.

• Verifica que la cuenta de servicio que se usa en la Cloud Function correspondiente tenga una función de Identity and Access Management que le permita crear y escribir buckets de Cloud Storage, así como acceder a ellos.

¿Qué sigue?

• Muestras para supervisores sintéticos
• Cómo administrar monitores sintéticos
• Explora los resultados del monitor sintético