Validar los datos de las respuestas

En este documento, se describe cómo configurar una verificación de tiempo de actividad para validar el código de respuesta HTTP y los datos de respuesta que envía un recurso verificado. De forma predeterminada, las verificaciones de tiempo de actividad HTTP verifican que el código de respuesta sea 2xx. Además, de forma predeterminada, los datos de respuesta no se validan. Sin embargo, puedes modificar estos parámetros. Por ejemplo, puedes configurar una verificación de tiempo de actividad HTTP para que acepte Códigos de respuesta 2xx y 3xx. Para todas las verificaciones de tiempo de actividad, puedes especificar un valor que los datos de la respuesta deben o no contener para que la verificación de tiempo de actividad se realice correctamente.

Cómo validar los datos de las respuestas

Puedes configurar Cloud Monitoring para validar los datos de respuesta de un recurso verificado cuando creas o editas una verificación de tiempo de actividad.

Consola de Google Cloud

Para crear una verificación de tiempo de actividad que valide los datos de respuesta, haz lo siguiente:

1. En la consola de Google Cloud, ve a la página  Verificaciones de tiempo de actividad:

   Ve a Verificaciones de tiempo de actividad

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

2. Haz clic en Crear una verificación de tiempo de actividad.
3. Ingresa un Título y haz clic en Siguiente.
4. Ingresa el objetivo y haz clic en Siguiente.

5. Configura la Validación de respuesta:

   • Para validar los datos de respuesta, asegúrate de que se muestre Coincidencia de contenido habilitada y, luego, completa los campos relacionados con la validación de la respuesta. Para obtener información sobre estas opciones, consulta la siguiente sección de este documento.
   • Para las verificaciones de tiempo de actividad HTTP, configura los códigos de respuesta aceptables. De forma predeterminada, las verificaciones de tiempo de actividad HTTP marcan cualquier respuesta 2xx como una respuesta correcta.

6. Haz clic en Siguiente y completa la configuración de la verificación del tiempo de actividad.

API de Cloud Monitoring

Para configurar una verificación de tiempo de actividad para validar los datos de respuesta, propaga el array contentMatchers del objeto UptimeCheckConfig.

Los objetos ContentMatcher contienen los siguientes campos:

• matcher: Describe cómo se realiza la comparación. Para obtener una lista de valores, consulta ContentMatcherOption

  No uses el valor CONTENT_MATCHER_OPTION_UNSPECIFIED.

• content: Almacena el valor que se debe buscar en los datos de respuesta. El value es un literal de string o una expresión regular.

• jsonPathMatcher: Almacena un objeto JsonPathMatcher que describe qué JSONpath se debe buscar y cómo realizar la comparación.

  Omite este campo, a menos que la verificación de tiempo de actividad valide un JSONPath específico.

En el resto de este documento, se describe cómo usar la herramienta de coincidencia de contenido opciones de estado.

Opciones para validar los datos de respuesta

En esta sección, se describen las estrategias de coincidencia de cadenas que puedes usar para validar la respuesta enviada por un recurso verificado. Para cada estrategia, debes especificar un valor y si encontrar ese valor en los datos de respuesta hace que la verificación de tiempo de actividad pase o falle.

Es posible que no se pueda buscar toda la respuesta de un recurso verificado:

• Verificaciones de tiempo de actividad de HTTP y HTTPS: Se buscan los primeros 4 MB.
• Verificaciones de tiempo de actividad de TCP: Se busca el primer 1 MB.

Busca una substring literal

Consola de Google Cloud

Para configurar la verificación de tiempo de actividad a fin de que se apruebe cuando los datos de respuesta contengan un una subcadena literal, usa la siguiente configuración:

1. Selecciona Contiene en el menú Tipo de concordancia del contenido de la respuesta.
2. Ingresa la subcadena literal en el campo Contenido de la respuesta.
3. Para verificar la configuración, haz clic en Probar.

Para configurar la verificación de tiempo de actividad de modo que falle cuando los datos de respuesta contengan una subcadena literal, usa la siguiente configuración:

1. Selecciona No contiene en el menú Tipo de concordancia del contenido de la respuesta.
2. Ingresa la subcadena literal en el campo Contenido de la respuesta.
3. Para verificar la configuración, haz clic en Probar.

API de Cloud Monitoring

Para configurar la verificación de tiempo de actividad a fin de que se apruebe cuando los datos de respuesta contengan un una subcadena literal, usa los siguientes valores:

...
"contentMatchers": [
    {
      "content": "Set to the string to be matched.",
      "matcher": "CONTAINS_STRING"
    }
],
...

Para configurar la verificación del tiempo de actividad de modo que falle cuando los datos de respuesta contengan una subcadena literal, usa los siguientes valores:

...
"contentMatchers": [
    {
      "content": "Set to the string to be matched.",
      "matcher": "NOT_CONTAINS_STRING"
    }
],
...

En la siguiente tabla, se muestra el estado de la verificación de tiempo de actividad para diferentes datos de respuesta, cadenas de prueba y tipos de prueba:

		Estado de la verificación de tiempo de actividad
Datos de respuesta	Cadena de prueba	Contiene	No contiene
abcd	abcd	pass	desaprobado
abc	abcd	desaprobado	pass
abc	a	pass	desaprobado
Uptime Checks	Uptime	pass	desaprobado
Uptime Checks	uptime	desaprobado	pass

En la tabla anterior, en la columna Datos de respuesta se describen los datos. que muestra el recurso verificado, mientras que la columna Test string enumera los literal de cadena. Las siguientes dos columnas especifican el tipo de prueba y la resultado de la verificación de tiempo de actividad.

Cómo realizar una búsqueda con una expresión regular

Consola de Google Cloud

Para configurar la verificación del tiempo de actividad para que se apruebe cuando los datos de respuesta coincidan con una expresión regular, usa la siguiente configuración:

1. Selecciona Coincide con la regex en el menú Tipo de concordancia del contenido de la respuesta.
2. Ingresa una expresión regular en el campo Contenido de la respuesta.
3. Para verificar la configuración, haz clic en Probar.

Para configurar la verificación del tiempo de actividad de modo que falle cuando los datos de respuesta coincidan con una expresión regular, usa la siguiente configuración:

1. Selecciona No coincide con la regex en el menú Tipo de concordancia del contenido de la respuesta.
2. Ingresa una expresión regular en el campo Contenido de la respuesta.
3. Para verificar la configuración, haz clic en Probar.

API de Cloud Monitoring

Para configurar la verificación de tiempo de actividad para que se apruebe cuando los datos de respuesta coincidan una expresión regular, utiliza los siguientes valores:

...
"contentMatchers": [
    {
      "content": "Set to the regular expression to be matched.",
      "matcher": "MATCHES_REGEX"
    }
],
...

Configurar la verificación de tiempo de actividad para que falle cuando coincidan los datos de respuesta una expresión regular, utiliza los siguientes valores:

...
"contentMatchers": [
    {
      "content": "Set to the regular expression to be matched.",
      "matcher": "NOT_MATCHES_REGEX"
    }
],
...

En la siguiente tabla, se muestra el estado de la verificación de tiempo de actividad de diferentes datos de respuesta, expresiones regulares y tipos de prueba:

		Estado de la verificación de tiempo de actividad
Datos de respuesta	Expresión regular	Coincide con la expresión regular	No coincide con la regex
abcd	abcd	pass	desaprobado
Uptime Checks	[uU]ptime	pass	desaprobado
Uptime Checks	[a-z]{6}	desaprobado	pass
Uptime Checks	[a-zA-Z]{6}	pass	desaprobado

En la tabla anterior, la columna Response data describe los datos que muestra el recurso verificado, mientras que la columna Regex enumera la expresión regular. Las siguientes dos columnas especifican el tipo de prueba y la resultado de la verificación de tiempo de actividad.

Busca un campo específico en una respuesta JSON

Puedes configurar una verificación de tiempo de actividad para validar un JSONPath. Cuando seleccionas una prueba de JSONPath, esta compara un valor de ruta con un número, una cadena literal o una expresión regular:

• Compara JSONPath con un número o una cadena literal
• Compara JSONpath con una expresión regular

Cuando especificas un JSONPath, debes especificar el objeto raíz con $. y, luego, seguir con un identificador de campo específico. Cuando la respuesta JSON contiene un array de elementos, usa corchetes, [], para identificar un elemento específico de array para que coincida. Los siguientes ejemplos ilustran el Sintaxis de ruta de acceso:

• $.type coincide con el campo type de un objeto raíz.
• $.[0].address.city coincide con el campo city en el objeto address almacenado en el primer elemento del array de la respuesta JSON.
• $.content[0].phone coincide con el campo phone del primer elemento del array del campo content. El campo content es un elemento secundario del objeto raíz.

Puedes configurar una prueba de tiempo de actividad para que coincida con varios campos. Considera el siguiente JSON:

[
  {
    ...
    "address": {
      ...
      "city": "Gwenborough",
      "geo": {
        "lat": "-37.3159",
        "lng": "81.1496"
      }
    },
  },
  ...
]

Para hacer coincidir toda la ruta del campo geo en el primer elemento del array, haz lo siguiente: establece la ruta JSON como $.[0].address.geo y, luego, ingresa el valor completo En el campo Contenido, haz lo siguiente:

{
  "lat": "-37.3159",
  "lng": "81.1496"
}

Si te interesa experimentar con estas opciones, busca un sitio web público que muestre una respuesta JSON. Por ejemplo, consulta Prueba de JSON.

Compara JSONpath con un número o literal de string

Consola de Google Cloud

Nota: En el campo Contenido de la respuesta, puedes ingresar números, valores booleanos de true y false, y cadenas. Para que se produzca una coincidencia, el valor que ingreses debe coincidir con la respuesta que recibe la verificación del tiempo de actividad. Por ejemplo, puedes ingresar el valor booleano true, el número 5 o una cadena como "true", "5" o "hello".

Para configurar la verificación de tiempo de actividad para que apruebe una ruta JSON específica en el datos de respuesta coinciden con un literal de string, usa la siguiente configuración:

1. Selecciona Coincidencias en JSONPath en el menú Tipo de concordancia del contenido de la respuesta.
2. Ingresa la ruta en el campo JSONPath.
3. Ingresa el número o el literal de string en el campo Contenido de la respuesta.
4. Para verificar la configuración, haz clic en Probar.

Para configurar la verificación de tiempo de actividad para que falle cuando una ruta JSON específica en el datos de respuesta coinciden con un literal de string, usa la siguiente configuración:

1. Selecciona No coincide en JSONPath en el menú Tipo de concordancia del contenido de la respuesta.
2. Ingresa la ruta en el campo JSONPath.
3. Ingresa el número o el literal de string en el campo Contenido de la respuesta.
4. Para verificar la configuración, haz clic en Probar.

API de Cloud Monitoring

Nota: Debido a que el valor del campo "content" debe ser una cadena, debes escribe el valor entre comillas. Cuando el valor es una cadena, debes escapar el citas internas. Por ejemplo, para que coincida el valor booleano true, establece el valor en "true" Del mismo modo, para que coincida con el número 5, establece el valor en "5". Por último, para hacer coincidir la cadena "5", ingresa "\"5\"".

Para configurar la verificación de tiempo de actividad para que se apruebe cuando un campo específico en la respuesta con formato JSON coincida con un número o una cadena literal, usa los siguientes valores para el objeto ContentMatcher:

...
"contentMatchers": [
    {
       "content" : "Set to a number, a boolean, or the string to be matched.",
       "matcher" : "MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "EXACT_MATCH"
    }
],
...

Para configurar la verificación de tiempo de actividad de modo que falle cuando un campo específico en la respuesta con formato JSON coincida con un número o una cadena literal, usa los siguientes valores para el objeto ContentMatcher:

...
"contentMatchers": [
    {
       "content" : "Set to a number, a boolean, or the string to be matched.",
       "matcher" : "NOT_MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "EXACT_MATCH"
    }
],
...

Para ilustrar cómo funcionan las pruebas de coincidencia de cadenas JSONpath, Considera los siguientes datos de respuesta JSON:

{
    "name": "Sample Uptime Check",
    "type": "JSONpath",
    "content": [
        {
            "id": 1,
            "phone": "1234567890",
            "alias": "Exact",
            "enabled": true,
        },
        {
            "id": 2,
            "phone": "1234512345",
            "alias": "Regex",
            "enabled": false,
        }
    ]
}

En la siguiente tabla, se muestra el estado de la verificación de tiempo de actividad de la respuesta anterior. pero para diferentes rutas, valores de prueba y tipos de prueba:

		Estado de la verificación de tiempo de actividad
JSONpath	Valor de prueba	Coincidencias de JSONPath	La ruta de JSON no coincide.
$.type	"JSONpath"	pass	desaprobado
$.name	"Sample"	desaprobado	pass
$.name	"Sample Uptime Check"	pass	desaprobado
$.content[0].id	1	pass	desaprobado
$.content[0].alias	"Exact"	pass	desaprobado
$.content[0].enabled	true	pass	desaprobado

En la tabla anterior, la columna JSONpath identifica a qué elemento se debe y la columna Valor de prueba detalla el valor. Las siguientes dos columnas especifican el tipo de prueba y el resultado de la verificación del tiempo de actividad.

Compara JSONpath con una expresión regular

Las coincidencias de expresiones regulares admiten la coincidencia de una cadena, un número, un valor booleano y valores JSON nulos.

Nota: La expresión que ingreses debe coincidir con todo el valor de JSONPath. Por ejemplo, si el valor de un campo es "North Pole", entonces .*North.* y ^North.* coinciden con el campo, mientras que North y "North" no coinciden.

Consola de Google Cloud

Para configurar la verificación de tiempo de actividad para que se apruebe cuando una ruta de acceso JSON específica en los datos de respuesta coincida con una expresión regular, usa la siguiente configuración:

1. Selecciona Coincidencias en JSONPath en el menú Tipo de concordancia del contenido de la respuesta.
2. Ingresa la ruta de acceso en el campo JSONPath.
3. Ingresa la expresión regular en el campo Contenido de la respuesta.
4. Para verificar la configuración, haz clic en Probar.

Para configurar la verificación de tiempo de actividad de modo que falle cuando una ruta de acceso JSON específica en los datos de respuesta coincida con una expresión regular, usa la siguiente configuración:

1. Selecciona No coincide en JSONPath en el menú Tipo de concordancia del contenido de la respuesta.
2. Ingresa la ruta en el campo JSONPath.
3. Ingresa la expresión regular en el campo Contenido de la respuesta.
4. Para verificar la configuración, haz clic en Probar.

API de Cloud Monitoring

Para configurar la verificación de tiempo de actividad para que se apruebe cuando un campo específico en la respuesta con formato JSON coincida con una expresión regular, usa los siguientes valores para el objeto ContentMatcher:

...
"contentMatchers": [
    {
       "content" : "Set to the regular expression to be matched."
       "matcher" : "MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "REGEX_MATCH"
    }
],
...

Para configurar la verificación de tiempo de actividad de modo que falle cuando un campo específico en la respuesta con formato JSON coincida con una expresión regular, usa los siguientes valores para el objeto ContentMatcher:

...
"contentMatchers": [
    {
       "content" : "Set to the regular expression to be matched.",
       "matcher" : "NOT_MATCHES_JSON_PATH",
       "jsonPathMatcher" : {
           "jsonPath" : "Set to the JSONpath.",
           "jsonMatcher" : "REGEX_MATCH"
    }
],
...

Para ilustrar cómo funcionan las pruebas de expresiones regulares de JSONPath, considera los siguientes datos de respuesta JSON:

{
    "name": "Sample Uptime Check",
    "type": "JSONpath",
    "content": [
        {
            "id": 1,
            "phone": "1234567890",
            "alias": "Exact",
            "enabled": true,
        },
        {
            "id": 2,
            "phone": "1234512345",
            "alias": "Regex",
            "enabled": false,
        }
    ]
}

En la siguiente tabla, se muestra el estado de la verificación del tiempo de actividad de la respuesta anterior, pero para diferentes rutas de acceso, expresiones regulares y tipos de prueba:

		Estado de la verificación de tiempo de actividad
JSONpath	Expresión regular	JSONPath coincide con regex	JSONpath no coincide con la regex
$.type	[A-Z]{4}Path	pass	desaprobado
$.name	Sample	desaprobado	pass
$.name	.*Sample.*	pass	desaprobado
$.content[1].id	2	pass	desaprobado
$.content[1].phone	"[12345]{2}"	pass	desaprobado
$.content[1].enabled	f.*	pass	desaprobado

En la tabla anterior, la columna JSONpath identifica qué elemento probar y la columna Regex enumera la expresión regular. Las siguientes dos columnas especificar el tipo de prueba y el resultado de la verificación de tiempo de actividad.

¿Qué sigue?

• Crea una verificación de tiempo de actividad
• Administra las verificaciones de tiempo de actividad
• Crea políticas de alertas para las verificaciones de tiempo de actividad