Validar dados de resposta

Neste documento, descrevemos como configurar uma verificação de tempo de atividade para validar o código de resposta HTTP e os dados de resposta enviados por um recurso verificado. Por padrão, as verificações de tempo de atividade HTTP conferem se o código de resposta é 2xx. Além disso, por padrão, os dados de resposta não são validados. No entanto, você pode modificar essas configurações. Por exemplo, é possível configurar uma verificação de tempo de atividade HTTP para aceitar códigos de resposta 2xx e 3xx. Para todas as verificações de tempo de atividade, é possível especificar um valor que os dados de resposta precisam ou não conter para que elas sejam bem-sucedidas.

Como validar os dados da resposta

É possível configurar o Cloud Monitoring para validar os dados de resposta de um recurso verificado ao criar ou editar uma verificação de tempo de atividade.

Console do Google Cloud

Para criar uma verificação de tempo de atividade que valide os dados de resposta, faça o seguinte:

  1. No painel de navegação do console do Google Cloud, selecione Monitoramento e  Verificações de tempo de atividade:

    Acesse Verificações de tempo de atividade

  2. Clique em Criar verificação de tempo de atividade.
  3. Digite um Título e clique em Próxima.
  4. Insira o Destino e clique em Avançar.

  5. Configure a Validação da resposta:

    • Para validar os dados de resposta, verifique se a opção Correspondência de conteúdo está ativada é exibida e, em seguida, preencha os campos relacionados à validação da resposta. Para mais informações sobre essas opções, consulte a próxima seção deste documento.
    • Para as verificações de tempo de atividade HTTP, configure os códigos de resposta aceitáveis. Por padrão, as verificações de tempo de atividade HTTP marcam qualquer resposta 2xx como bem-sucedida.

  6. Clique em Próxima e conclua a configuração da verificação de tempo de atividade.

API Cloud Monitoring

Para configurar uma verificação de tempo de atividade para validar os dados de resposta, preencha a matriz contentMatchers do objeto UptimeCheckConfig.

Os objetos ContentMatcher contêm os campos abaixo:

  • matcher: descreve como a comparação é realizada. Para conferir uma lista de valores, consulte ContentMatcherOption.

    Não use o valor CONTENT_MATCHER_OPTION_UNSPECIFIED.

  • content: armazena o valor a ser pesquisado nos dados de resposta. O valor é um literal de string ou uma expressão regular.

  • jsonPathMatcher: armazena um objeto JsonPathMatcher que descreve qual JSONpath pesquisar e como realizar a comparação.

    Omita esse campo, a menos que a verificação de tempo de atividade esteja validando um JSONpath específico.

O restante deste documento descreve como usar as opções de correspondência de conteúdo.

Opções para validar os dados de resposta

Nesta seção, descrevemos as estratégias de correspondência de strings que podem ser usadas para validar a resposta enviada por um recurso verificado. Para cada estratégia, especifique um valor e indique se encontrar esse valor nos dados de resposta resulta na aprovação ou falha da verificação de tempo de atividade.

A resposta inteira de um recurso marcado pode não ser pesquisada:

  • Verificações de tempo de atividade HTTP e HTTPS: os primeiros 4 MB são pesquisados.
  • Verificações de tempo de atividade TCP: o primeiro 1 MB é pesquisado.

Pesquisar uma substring literal

Console do Google Cloud

Para configurar a verificação de tempo de atividade para ser aprovada quando os dados da resposta contiverem uma substring literal, use as seguintes configurações:

  1. Selecione Contém no menu Tipo de correspondência de conteúdo de resposta.
  2. Insira a substring literal no campo Conteúdo da resposta.
  3. Para verificar a configuração, clique em Testar.

Para que a verificação de tempo de atividade falhe quando os dados de resposta contiverem uma substring literal, use as seguintes configurações:

  1. Selecione Não contém no menu Tipo de correspondência do conteúdo de resposta.
  2. Insira a substring literal no campo Conteúdo da resposta.
  3. Para verificar a configuração, clique em Testar.

API Cloud Monitoring

Para configurar a verificação de tempo de atividade para ser aprovada quando os dados da resposta contiverem uma substring literal, use os seguintes valores:

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

Para configurar a falha da verificação de tempo de atividade quando os dados da resposta contiverem uma substring literal, use os seguintes valores:

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

A tabela a seguir exibe o status da verificação de tempo de atividade para diferentes dados de resposta, strings e tipos de teste:

Status da verificação de tempo de atividade       
Dados de resposta String de teste Contém Não contém
abcd abcd pass errada
abc abcd errada pass
abc a pass errada
Uptime Checks Uptime pass errada
Uptime Checks uptime errada pass

Na tabela anterior, a coluna Dados de resposta descreve os dados retornados pelo recurso verificado, enquanto a coluna String de teste lista o literal de string. As próximas duas colunas especificam o tipo de teste e o resultado da verificação de tempo de atividade.

Pesquisar usando uma expressão regular

Console do Google Cloud

Para configurar a verificação de tempo de atividade para ser aprovada quando os dados de resposta corresponderem a uma expressão regular, use as seguintes configurações:

  1. Selecione Corresponde ao regex no menu Tipo de correspondência do conteúdo da resposta.
  2. Insira uma expressão regular no campo Conteúdo da resposta.
  3. Para verificar a configuração, clique em Testar.

Para que a verificação de tempo de atividade falhe quando os dados de resposta corresponderem a uma expressão regular, use as configurações a seguir:

  1. Selecione Não corresponde ao regex no menu Tipo de correspondência do conteúdo da resposta.
  2. Insira uma expressão regular no campo Conteúdo da resposta.
  3. Para verificar a configuração, clique em Testar.

API Cloud Monitoring

Para configurar a verificação de tempo de atividade para ser aprovada quando os dados de resposta corresponderem a uma expressão regular, use os seguintes valores:

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

Para que a verificação de tempo de atividade falhe quando os dados de resposta corresponderem a uma expressão regular, use os seguintes valores:

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

A tabela a seguir exibe o status da verificação de tempo de atividade para diferentes dados de resposta, expressões regulares e tipos de teste:

Status da verificação de tempo de atividade       
Dados de resposta Regex Corresponde ao regex Não corresponde à RegEx
abcd abcd pass errada
Uptime Checks [uU]ptime pass errada
Uptime Checks [a-z]{6} errada pass
Uptime Checks [a-zA-Z]{6} pass errada

Na tabela anterior, a coluna Dados de resposta descreve os dados retornados pelo recurso verificado, enquanto a coluna Regex lista a expressão regular. As próximas duas colunas especificam o tipo de teste e o resultado da verificação de tempo de atividade.

Pesquisar um campo específico em uma resposta JSON

É possível configurar uma verificação de tempo de atividade para validar um JSONpath. Quando você seleciona um teste JSONpath, o teste compara um valor de caminho com um número, um literal de string ou uma expressão regular:

Ao definir um JSONpath, especifique o objeto raiz com $. e, em seguida, insira um identificador de campo específico. Quando a resposta JSON contém uma matriz de elementos, use colchetes, [], para identificar o elemento de matriz específico a ser correspondido. Os exemplos a seguir ilustram a sintaxe do caminho:

  • $.type corresponde ao campo type de um objeto raiz.
  • $.[0].address.city corresponde ao campo city no objeto address armazenado no primeiro elemento da matriz da resposta JSON.
  • $.content[0].phone corresponde ao campo phone do primeiro elemento da matriz do campo content. O campo content é um filho do objeto raiz.

Você pode configurar um teste de tempo de atividade para corresponder a vários campos. Considere o seguinte JSON:

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

Para fazer a correspondência de todo o caminho do campo geo no primeiro elemento da matriz, defina o JSONpath como $.[0].address.geo e insira o valor completo no campo de conteúdo:

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

Se você tiver interesse em testar essas opções, encontre um site público que retorne uma resposta JSON. Por exemplo, consulte Teste JSON.

Comparar JSONpath a um literal de número ou string

Console do Google Cloud

Para configurar a verificação de tempo de atividade para ser aprovada quando um JSONpath específico nos dados de resposta corresponder a um literal de string, use as seguintes configurações:

  1. Selecione Corresponde no JSONPath no menu Tipo de correspondência do conteúdo de resposta.
  2. Digite o caminho no campo JSONPath.
  3. Insira o número ou o literal de string no campo Conteúdo da resposta.
  4. Para verificar a configuração, clique em Testar.

Para que a verificação de tempo de atividade falhe quando um JSONpath específico nos dados de resposta corresponder a um literal de string, use as seguintes configurações:

  1. Selecione Não corresponde no JSONPath no menu Tipo de correspondência do conteúdo de resposta.
  2. Digite o caminho no campo JSONPath.
  3. Insira o número ou o literal de string no campo Conteúdo da resposta.
  4. Para verificar a configuração, clique em Testar.

API Cloud Monitoring

Para configurar a verificação de tempo de atividade para ser aprovada quando um campo específico na resposta formatada em JSON corresponder a um número ou literal de string, use os seguintes valores para o 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 a verificação de tempo de atividade para falhar quando um campo específico na resposta formatada em JSON corresponder a um número ou literal de string, use os seguintes valores para o 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 como funcionam os testes de correspondência de string JSONpath, considere os seguintes dados de resposta JSON:

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

A tabela a seguir exibe o status da verificação de tempo de atividade da resposta anterior, mas para diferentes caminhos, valores e tipos de teste:

Status da verificação de tempo de atividade       
JSONpath Valor de teste Correspondências de JSONpath Não há correspondências para o JSONpath
$.type "JSONpath" pass errada
$.name "Sample" errada pass
$.name "Sample Uptime Check" pass errada
$.content[0].id 1 pass errada
$.content[0].alias "Exact" pass errada
$.content[0].enabled true pass errada

Na tabela anterior, a coluna JSONpath identifica o elemento a ser testado, e a coluna Valor de teste lista o valor. As próximas duas colunas especificam o tipo de teste e o resultado da verificação de tempo de atividade.

Comparar JSONpath a uma expressão regular

As correspondências de expressões regulares são compatíveis com valores de string, número, booleano e JSON nulo.

Console do Google Cloud

Para configurar a verificação de tempo de atividade para ser aprovada quando um JSONpath específico nos dados de resposta corresponder a uma expressão regular, use as seguintes configurações:

  1. Selecione Corresponde no JSONPath no menu Tipo de correspondência do conteúdo de resposta.
  2. Digite o caminho no campo JSONPath.
  3. Insira a expressão regular no campo Conteúdo da resposta.
  4. Para verificar a configuração, clique em Testar.

Para que a verificação de tempo de atividade falhe quando um JSONpath específico nos dados de resposta corresponder a uma expressão regular, use as seguintes configurações:

  1. Selecione Não corresponde no JSONPath no menu Tipo de correspondência do conteúdo de resposta.
  2. Digite o caminho no campo JSONPath.
  3. Insira a expressão regular no campo Conteúdo da resposta.
  4. Para verificar a configuração, clique em Testar.

API Cloud Monitoring

Para configurar a verificação de tempo de atividade para ser aprovada quando um campo específico na resposta formatada em JSON corresponder a uma expressão regular, use os seguintes valores para o 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 a verificação de tempo de atividade para falhar quando um campo específico na resposta formatada em JSON corresponder a uma expressão regular, use os seguintes valores para o 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 como funcionam os testes de expressão regular JSONpath, considere os seguintes dados de resposta JSON:

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

A tabela a seguir exibe o status da verificação de tempo de atividade da resposta anterior, mas para diferentes caminhos, expressões regulares e tipos de teste:

Status da verificação de tempo de atividade       
JSONpath Regex JSONpath corresponde ao regex O JSONpath não corresponde ao regex
$.type [A-Z]{4}Path pass errada
$.name Sample errada pass
$.name .*Sample.* pass errada
$.content[1].id 2 pass errada
$.content[1].phone "[12345]{2}" pass errada
$.content[1].enabled f.* pass errada

Na tabela anterior, a coluna JSONpath identifica o elemento que será testado, e a coluna Regex lista a expressão regular. As próximas duas colunas especificam o tipo de teste e o resultado da verificação de tempo de atividade.

A seguir