Convalida i dati della risposta

Questo documento descrive come configurare un controllo di uptime per convalidare il codice di risposta HTTP e i dati di risposta inviati da una risorsa controllata. Per impostazione predefinita, i controlli di uptime HTTP verificano che il codice di risposta sia 2xx. Inoltre, per impostazione predefinita, i dati di risposta non vengono convalidati. Tuttavia, puoi modificare queste impostazioni. Ad esempio, puoi configurare un controllo di uptime HTTP in modo che accetti i codici di risposta 2xx e 3xx. Per tutti i controlli di uptime, puoi specificare un valore che i dati di risposta devono o non devono contenere affinché il controllo di uptime vada a buon fine.

Come convalidare i dati della risposta

Puoi configurare Cloud Monitoring per convalidare i dati di risposta di una risorsa controllata quando crei o modifichi un controllo di uptime.

Console Google Cloud

Per creare un controllo di uptime che convalidi i dati di risposta, segui questi passaggi:

  1. Nella console Google Cloud, vai alla pagina  Controlli di uptime:

    Vai a Controlli di uptime

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Fai clic su Crea controllo di uptime.
  3. Inserisci un Titolo e fai clic su Avanti.
  4. Inserisci il target e fai clic su Avanti.

  5. Configura la Convalida della risposta:

    • Per convalidare i dati della risposta, assicurati che sia visualizzata l'opzione Corrispondenza dei contenuti abilitata e poi compila i campi relativi alla convalida della risposta. Per informazioni su queste opzioni, consulta la sezione successiva di questo documento.
    • Per i controlli di uptime HTTP, configura i codici di risposta accettabili. Per impostazione predefinita, i controlli di uptime HTTP contrassegnano qualsiasi risposta2xx come risposta positiva.

  6. Fai clic su Avanti e completa la configurazione del controllo di uptime.

API Cloud Monitoring

Per configurare un controllo di uptime per convalidare i dati di risposta, compila l'array contentMatchers dell'oggetto UptimeCheckConfig.

Gli oggetti ContentMatcher contengono i seguenti campi:

  • matcher: descrive il modo in cui viene eseguito il confronto. Per un elenco dei valori, consulta ContentMatcherOption.

    Non utilizzare il valore CONTENT_MATCHER_OPTION_UNSPECIFIED.

  • content: memorizza il valore da cercare nei dati di risposta. Il valore è una stringa letterale o un'espressione regolare.

  • jsonPathMatcher: memorizza un oggetto JsonPathMatcher che descrive quale percorso JSON cercare e come eseguire il confronto.

    Ometti questo campo, a meno che il controllo di uptime non stia convalidando un percorso JSON specifico.

La parte rimanente di questo documento descrive come utilizzare le opzioni di corrispondenza dei contenuti.

Opzioni per convalidare i dati della risposta

Questa sezione descrive le strategie di corrispondenza delle stringhe che puoi utilizzare per convalidare la risposta inviata da una risorsa controllata. Per ogni strategia, specifichi un valore e se la ricerca di questo valore nei dati di risposta determina il superamento o il fallimento del controllo dell'uptime.

L'intera risposta di una risorsa controllata potrebbe non essere sottoposta a ricerca:

  • Controlli di uptime HTTP e HTTPS: vengono esaminati i primi 4 MB.
  • Controlli di uptime TCP: viene eseguito una ricerca nel primo MB.

Cerca una sottostringa letterale

Console Google Cloud

Per configurare il controllo di uptime in modo che venga superato quando i dati di risposta contengono una una sottostringa letterale, utilizza le seguenti impostazioni:

  1. Seleziona Contiene nel menu Tipo di corrispondenza dei contenuti della risposta.
  2. Inserisci la sottostringa letterale nel campo Contenuto risposta.
  3. Per verificare la configurazione, fai clic su Test.

Per configurare il controllo di uptime in modo che non vada a buon fine quando i dati di risposta contengono una sottostringa letterale, utilizza le seguenti impostazioni:

  1. Seleziona Non contiene nel menu Tipo di corrispondenza dei contenuti della risposta.
  2. Inserisci la sottostringa letterale nel campo Contenuto risposta.
  3. Per verificare la configurazione, fai clic su Test.

API Cloud Monitoring

Per configurare il controllo di uptime in modo che venga superato quando i dati di risposta contengono una una sottostringa letterale, utilizza i seguenti valori:

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

Per configurare il controllo di uptime in modo che non vada a buon fine quando i dati di risposta contengono una sottostringa letterale, utilizza i seguenti valori:

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

La seguente tabella mostra lo stato del controllo di uptime per diversi dati di risposta, stringhe di test e tipi di test:

Stato del controllo di uptime       
Dati di risposta Stringa di test Contiene Non contiene
abcd abcd superata non superata
abc abcd non superata superata
abc a superata non superata
Uptime Checks Uptime superata non superata
Uptime Checks uptime non superata superata

Nella tabella precedente, la colonna Dati di risposta descrive i dati restituito dalla risorsa selezionata, mentre la colonna Stringa di test elenca il letterale stringa. Le due colonne successive specificano il tipo di test e il risultato del controllo di uptime.

Ricerca utilizzando un'espressione regolare

Console Google Cloud

Per configurare il controllo di uptime in modo che venga superato quando i dati di risposta corrispondono a un'espressione regolare, utilizza le seguenti impostazioni:

  1. Seleziona Corrisponde all'espressione regolare nel menu Tipo di corrispondenza dei contenuti della risposta.
  2. Inserisci un'espressione regolare nel campo Contenuti della risposta.
  3. Per verificare la configurazione, fai clic su Test.

Per configurare il controllo di uptime in modo che non vada a buon fine quando i dati di risposta corrispondono a un'espressione regolare, utilizza le seguenti impostazioni:

  1. Seleziona Non corrisponde all'espressione regolare nel menu Tipo di corrispondenza dei contenuti della risposta.
  2. Inserisci un'espressione regolare nel campo Contenuti della risposta.
  3. Per verificare la configurazione, fai clic su Test.

API Cloud Monitoring

Per configurare il controllo di uptime in modo che venga superato quando i dati di risposta corrispondono a un'espressione regolare, utilizza i seguenti valori:

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

Per configurare il controllo dell'uptime in modo che non venga eseguito quando i dati di risposta corrispondono a un'espressione regolare, utilizza i seguenti valori:

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

La seguente tabella mostra lo stato del controllo dell'uptime per diversi dati di risposta, espressioni regolari e tipi di test:

Stato del controllo di uptime       
Dati di risposta Regex Corrisponde a espressione regolare Non corrisponde alla regex
abcd abcd superata non superata
Uptime Checks [uU]ptime superata non superata
Uptime Checks [a-z]{6} non superata superata
Uptime Checks [a-zA-Z]{6} superata non superata

Nella tabella precedente, la colonna Dati risposta descrive i dati restituito dalla risorsa controllata, mentre la colonna Regex elenca l'espressione regolare. Le due colonne successive specificano il tipo di test e il risultato del controllo di uptime.

Cercare un campo specifico in una risposta JSON

Puoi configurare un controllo di uptime per convalidare un percorso JSON. Quando selezioni un test JSONpath, il test confronta un valore del percorso con un numero, una stringa letterale o un'espressione regolare:

Quando specifichi un percorso JSON, devi specificare l'oggetto principale con $. e poi seguire con un identificatore di campo specifico. Quando la risposta JSON contiene un array di elementi, utilizza le parentesi [] per identificare l'elemento dell'array specifico da associare. Gli esempi riportati di seguito illustrano la sintassi del percorso:

  • $.type corrisponde al campo type di un oggetto principale.
  • $.[0].address.city corrisponde al campo city nell'oggetto address memorizzato nel primo elemento dell'array della risposta JSON.
  • $.content[0].phone corrisponde al campo phone del primo elemento dell'array del campo content. Il campo content è un elemento secondario dell'oggetto principale.

Puoi configurare un test di uptime in modo che corrisponda a più campi. Considera il seguente JSON:

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

Per trovare una corrispondenza con l'intero percorso del campo geo nel primo elemento dell'array, imposta JSONpath su $.[0].address.geo e inserisci il valore completo nel campo dei contenuti:

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

Se vuoi fare esperimenti con queste opzioni, trova un sito web pubblico che restituisce una risposta JSON. Ad esempio, consulta Test JSON.

Confronta JSONpath con un numero o un valore letterale di stringa

Console Google Cloud

Per configurare il controllo di uptime in modo che venga superato quando un percorso JSON specifico nei dati di risposta corrisponde a una stringa letterale, utilizza le seguenti impostazioni:

  1. Seleziona Corrispondenze su JSONPath nel menu Tipo di corrispondenza dei contenuti della risposta.
  2. Inserisci il percorso nel campo JSONPath.
  3. Inserisci il numero o la stringa letterale nel campo Contenuto risposta.
  4. Per verificare la configurazione, fai clic su Test.

Per configurare il controllo di uptime in modo che non vada a buon fine quando un percorso JSON specifico nei dati di risposta corrisponde a una stringa letterale, utilizza le seguenti impostazioni:

  1. Seleziona Non corrisponde a JSONPath nel menu Tipo di corrispondenza dei contenuti della risposta.
  2. Inserisci il percorso nel campo JSONPath.
  3. Inserisci il numero o la stringa letterale nel campo Contenuto risposta.
  4. Per verificare la configurazione, fai clic su Test.

API Cloud Monitoring

Per configurare il controllo dell'uptime in modo che venga superato quando un campo specifico della risposta in formato JSON corrisponde a un numero o a una stringa letterale, utilizza i seguenti valori per l'oggetto 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"
    }
],
...

Per configurare il controllo dell'uptime in modo che non venga eseguito quando un campo specifico della risposta in formato JSON corrisponde a un numero o a una stringa letterale, utilizza i seguenti valori per l'oggetto 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"
    }
],
...

Per illustrare il funzionamento dei test di corrispondenza delle stringhe JSONpath, considera i seguenti dati della risposta JSON:

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

La seguente tabella mostra lo stato del controllo dell'uptime della risposta precedente, ma per percorsi, valori di test e tipi di test diversi:

Stato del controllo di uptime       
JSONpath Valore test Corrispondenze JSONPath JSONPath non corrisponde
$.type "JSONpath" superata non superata
$.name "Sample" non superata superata
$.name "Sample Uptime Check" superata non superata
$.content[0].id 1 superata non superata
$.content[0].alias "Exact" superata non superata
$.content[0].enabled true superata non superata

Nella tabella precedente, la colonna JSONpath identifica l'elemento da testare e la colonna Valore test elenca il valore. Le due colonne successive specificano il tipo di test e il risultato del controllo di uptime.

Confrontare JSONPath con un'espressione regolare

Le corrispondenze delle espressioni regolari supportano la corrispondenza di una stringa, un numero, un valore booleano e valori JSON null.

Console Google Cloud

Per configurare il controllo di uptime in modo che venga superato quando un percorso JSON specifico nei dati di risposta corrisponde a un'espressione regolare, utilizza le seguenti impostazioni:

  1. Seleziona Corrispondenze su JSONPath nel menu Tipo di corrispondenza dei contenuti della risposta.
  2. Inserisci il percorso nel campo JSONPath.
  3. Inserisci l'espressione regolare nel campo Contenuti risposta.
  4. Per verificare la configurazione, fai clic su Test.

Per configurare il controllo di uptime in modo che non vada a buon fine quando un percorso JSON specifico nei dati di risposta corrisponde a un'espressione regolare, utilizza le seguenti impostazioni:

  1. Seleziona Non corrisponde a JSONPath nel menu Tipo di corrispondenza dei contenuti della risposta.
  2. Inserisci il percorso nel campo JSONPath.
  3. Inserisci l'espressione regolare nel campo Contenuti risposta.
  4. Per verificare la configurazione, fai clic su Test.

API Cloud Monitoring

Per configurare il controllo di uptime in modo che venga superato quando un campo specifico della risposta in formato JSON corrisponde a un'espressione regolare, utilizza i seguenti valori per l'oggetto ContentMatcher:

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

Per configurare il controllo di uptime in modo che non venga eseguito quando un campo specifico della risposta in formato JSON corrisponde a un'espressione regolare, utilizza i seguenti valori per l'oggetto 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"
    }
],
...

Per illustrare il funzionamento dei test delle espressioni regolari JSONpath, considera i seguenti dati di risposta JSON:

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

La tabella seguente mostra lo stato del controllo dell'uptime della risposta precedente, ma per percorsi, espressioni regolari e tipi di test diversi:

Stato del controllo di uptime       
JSONpath Regex JSONPath corrisponde a regex JSONpath non corrisponde all'espressione regolare
$.type [A-Z]{4}Path superata non superata
$.name Sample non superata superata
$.name .*Sample.* superata non superata
$.content[1].id 2 superata non superata
$.content[1].phone "[12345]{2}" superata non superata
$.content[1].enabled f.* superata non superata

Nella tabella precedente, la colonna JSONpath identifica l'elemento da testare e la colonna Regex elenca l'espressione regolare. Le due colonne successive specificano il tipo di test e il risultato del controllo di uptime.

Passaggi successivi