Crea un verificador de vínculos rotos

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

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

Acerca de los verificadores de vínculos rotos

Cada verificador de vínculos rotos prueba los vínculos de forma serial, 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 elementos de anclaje HTML con atributos href en el URI de origen.
• 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 como máximo 30 segundos por una respuesta. Cuando se recibe una respuesta, el verificador verifica que el estado de la respuesta HTTP sea 200, lo que indica que la respuesta se realizó correctamente. El verificador no realiza reintentos.

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

Los verificadores de vínculos rotos usan la plantilla broken-links-ok. El objeto options del archivo index.js especifica la configuración de un verificador de vínculos rotos. Si creas tu comprobador con el de la consola de Google Cloud, se te solicitará cada opción de configuración y la función de Cloud Run se actualiza por ti. Sin embargo, si utilizas la API de Cloud Monitoring o Terraform, debes propagar este objeto.

Luego de crear un verificador de vínculos rotos, actualiza la configuración options y vuelve a implementar la función de Cloud Run.

Antes de comenzar

1. Para 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)

   Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

   También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

2. Enable the Cloud Monitoring API, Artifact Registry API, Cloud Build API, Cloud Functions API, Cloud Logging API, Pub/Sub API, and Cloud Run Admin API APIs.

   Enable the APIs

3. Verifica que tu proyecto de Google Cloud contenga la instancia predeterminada de Compute Engine cuenta de servicio. 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 no existe la cuenta de servicio predeterminada de Compute Engine, haz clic en Crear cuenta de servicio y completa el cuadro de diálogo.

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

   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 permisos en el rol del agente de Cloud Trace (roles/cloudtrace.agent), otórgale este rol 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 Cómo crear y administrar canales de notificaciones y Cómo crear y administrar canales de notificaciones con la API.

Crear un verificador de vínculos rotos

Console

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

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

2. En la consola de Google Cloud, ve a  Supervisión sintética:

   Ve 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. Actualiza el Tiempo de espera de respuesta, la Frecuencia de verificación (opcional) y agregar etiquetas definidas por el usuario.

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

   Nota: Los valores de los campos de configuración de 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, para cambiar la configuración, edita el objeto Options. Para obtener más información, consulta Cómo editar un monitor sintético o una función de Cloud Run.

   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 prueban. El valor predeterminado de este campo es 10.

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

      De forma predeterminada, este campo se establece en a, que coincide con las anclas. Tú puedes ingresar valores como a, img, cuando quieras hacer coincidir ambas anclas imágenes.

   4. Opcional: En el campo Atributos HTML que se deben seguir, ingresa los atributos HTML que deseas que coincidan. Los valores separados por comas que ingreses se pasan de forma 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, busca el atributo src.

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

      1. Haz clic en Mostrar más opciones.

      2. Para configurar el verificador de vínculos rotos de modo que espere a que aparezca un selector específico en el URI antes de que se extraigan los vínculos, ingresa los selectores de CSS en el campo Wait for element selector. El valor que se ingresa se convierte en una cadena y luego se pasa al page.waitForSelector().

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

      3. Actualiza el orden en que se seleccionan los vínculos para la prueba.

      4. Configurar los reintentos

         De forma predeterminada, se envía una solicitud a cada vínculo y, si la la solicitud 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, entonces 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 fallido.

      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, sigue estos pasos: Haz clic en Add per-link option y completa el cuadro de diálogo.

8. Opcional: Configura si se deben recopilar capturas de pantalla de las respuestas y guardado. Si usas la configuración predeterminada, no se guardarán las capturas de pantalla. Si habilitas la recopilación de capturas de pantalla, puedes recopilarlas para todas las pruebas o solo para las que fallan. 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.

   Puedes usar un bucket de Cloud Storage existente.

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

   1. Haz clic en Crear función.

      Los valores de los campos de configuración de 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, para cambiar la configuración, edita el objeto Options.

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

      Nota: No incluyas una barra baja en el nombre de tu función de Cloud Run.

   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 esté seleccionada la opción Permitir todo el tráfico.

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

        Nota: La configuración predeterminada para la memoria asignada, la CPU y la seguridad podría no ser 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 notificaciones.

11. Haz clic en Crear.

    La función de Cloud Run que definiste se compila y se implementa como 2ª gen., y se crea el monitor sintético.

API

El proceso de crear un verificador de vínculos rotos con la API de Cloud Monitoring es idéntico al proceso de crear cualquier otro monitor sintético. Para obtener información sobre el uso de la API de Cloud Monitoring para crear un monitor sintético, consulta Crea un monitor sintético y selecciona el Pestaña Cloud Monitoring.

Nota: incluir un guion bajo en el nombre de la función de Cloud Run.

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

Cuando se define la estructura options.screenshot_options, se 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 cadena vacía, Monitoring crea un bucket de Cloud Storage y las capturas de pantalla se guardan en ese bucket. Monitoring usa la siguiente convención para nombrar 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 de tu 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 crear un verificador de vínculos rotos mediante el uso de Terraform es idéntico al proceso de crear cualquier otra monitor sintético. Para 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 Terraform.

Nota: incluir un guion bajo en el nombre de la función de Cloud Run.

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

Cuando se define la estructura options.screenshot_options, se 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 cadena vacía, Monitoring crea un bucket de Cloud Storage y las capturas de pantalla se guardan en ese bucket. Monitoring usa la siguiente convención para nombrar 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 del resumen incluye el URI de destino, la latencia, el estado y el identificador del elemento HTML. Por ejemplo, esta columna enumera a cuando se prueba un elemento de anclaje HTML Cuando la fila corresponde a el 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 configura.

Para obtener más información sobre cómo explorar los datos recopilados, consulta Cómo explorar los resultados del monitor sintético.

Solucionar problemas

En esta sección, se proporciona información que puedes usar para solucionar problemas 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 quieres para cambiar los elementos HTML que se prueban o si deseas 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 mostrar los campos de configuración.

Para resolver este error, haz lo siguiente:

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

   Ve 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. Busca el monitor sintético que quieres 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 sigue 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 una de las siguientes advertencias 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 función de Cloud Run. Para obtener más información, consulta Cómo encontrar registros.

• Verifica que la cuenta de servicio que se usa en el La función de Cloud Run tiene un rol de Identity and Access Management que le permite crear, acceder a los buckets de Cloud Storage y escribir en ellos.

¿Qué sigue?

• Muestras de monitores sintéticos
• Cómo administrar monitores sintéticos
• Explora los resultados de los monitores sintéticos