Costrutti nell'API

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Questo documento introduce le strutture utilizzate per rappresentare i servizi e gli SLO nell'API SLO e li mappa ai concetti descritti in generale in Concetti nel monitoraggio dei servizi.

L'API SLO viene utilizzata per configurare gli obiettivi del livello di servizio (SLO) che possono essere utilizzati per monitorare l'integrità dei servizi.

Service Monitoring aggiunge le seguenti risorse all'API Monitoring:

Per informazioni su come richiamare l'API, consulta la pagina relativa all'utilizzo dell'API.

Servizi

Un servizio è rappresentato da un oggetto Service. Questo oggetto include i seguenti campi:

  • Un nome: un nome risorsa completo per questo servizio
  • Un nome visualizzato: un'etichetta da utilizzare nei componenti della console
  • Una struttura per uno dei tipi di BasicService.
  • Un oggetto di configurazione della telemetria fornito dal sistema

Per definire un servizio di base, devi specificare il tipo e fornire un insieme di etichette specifiche per i servizi:

{
   "serviceType": string,
   "serviceLabels": {
      string: string,
      ...
   }
}

Le sezioni seguenti forniscono esempi per ogni tipo di servizio.

Tipi di servizi di base

Questa sezione fornisce esempi di definizioni dei servizi basate sul tipo BasicService, in cui il valore del campo serviceType è uno dei seguenti:

  • APP_ENGINE
  • CLOUD_ENDPOINTS
  • CLUSTER_ISTIO
  • ISTIO_CANONICAL_SERVICE
  • CLOUD_RUN

Ciascuno di questi tipi di servizi utilizza l'indicatore del livello di servizio BasicSli.

App Engine

    {
      "displayName": "DISPLAY_NAME",
      "basicService": {
          "serviceType": "APP_ENGINE",
          "serviceLabels": {
            "module_id": "MODULE_ID"
          },
      },
    }

Cloud Endpoints

    {
      "displayName": "DISPLAY_NAME",
      "basicService": {
          "serviceType": "CLOUD_ENDPOINTS",
          "serviceLabels": {
            "service": "SERVICE"
          },
      },
    }

Cluster Istio

    {
      "displayName": "DISPLAY_NAME",
      "basicService": {
          "serviceType": "CLUSTER_ISTIO",
          "serviceLabels": {
            "location": "LOCATION",
            "cluster_name": "CLUSTER_NAME",
            "service_namespace": "SERVICE_NAMESPACE",
            "service_name": "SERVICE_NAME"
          },
      },
    }

Servizio canonico Istio

    {
      "displayName": "DISPLAY_NAME",
      "basicService": {
          "serviceType": "ISTIO_CANONICAL_SERVICE",
          "serviceLabels": {
            "mesh_uid": "MESH_UID",
            "canonical_service_namespace": "CANONICAL_SERVICE_NAMESPACE",
            "canonical_service": "CANONICAL_SERVICE"
          },
      },
    }

Cloud Run

    {
      "displayName": "DISPLAY_NAME",
      "basicService": {
          "serviceType": "CLOUD_RUN",
          "serviceLabels": {
            "service_name": "SERVICE_NAME",
            "location": "LOCATION"
          },
      },
    }

Tipi di servizi GKE di base

Questa sezione contiene esempi di definizioni di servizio GKE create sul tipo BasicService, in cui il valore del campo serviceType è uno dei seguenti:

  • GKE_NAMESPACE
  • GKE_WORKLOAD
  • GKE_SERVICE

Devi definire gli SLI per questi tipi di servizi. Non possono utilizzare gli indicatori del livello del servizio di BasicSli. Per scoprire di più, consulta Indicatori del livello del servizio.

Spazio dei nomi GKE

    {
      "displayName": "DISPLAY_NAME",
      "basicService": {
          "serviceType": "GKE_NAMESPACE",
          "serviceLabels": {
            "project_id": "PROJECT_ID",
            "location": "LOCATION",
            "cluster_name": "CLUSTER_NAME",
            "namespace_name": "NAMESPACE_NAME"
          }
      },
    }

Carico di lavoro GKE

    {
      "displayName": "DISPLAY_NAME",
      "basicService": {
          "serviceType": "GKE_WORKLOAD",
          "serviceLabels": {
            "project_id": "PROJECT_ID",
            "location": "LOCATION",
            "cluster_name": "CLUSTER_NAME",
            "namespace_name": "NAMESPACE_NAME",
            "top_level_controller_type": "TOPLEVEL_CONTROLLER_TYPE",
            "top_level_controller_name": "TOPLEVEL_CONTROLLER_NAME",
          }
      },
    }

Servizio GKE

    {
      "displayName": "DISPLAY_NAME",
      "basicService": {
          "serviceType": "GKE_SERVICE",
          "serviceLabels": {
            "project_id": "PROJECT_ID",
            "location": "LOCATION",
            "cluster_name": "CLUSTER_NAME",
            "namespace_name": "NAMESPACE_NAME",
            "service_name": "SERVICE_NAME"
          }
      },
    }

Servizi personalizzati

Puoi creare servizi personalizzati se nessuno dei tipi di servizio di base è adatto. Un servizio personalizzato ha il seguente aspetto:

    {
      "displayName": "DISPLAY_NAME",
      "custom": {}
    }

Devi definire gli SLI per questi tipi di servizi. Non possono utilizzare gli indicatori del livello del servizio di BasicSli. Per scoprire di più, consulta Indicatori del livello del servizio.

Indicatori del livello di servizio

Un indicatore del livello del servizio (SLI) fornisce una misurazione delle prestazioni di un servizio. Uno SLI si basa sulla metrica acquisita dal servizio. Il modo esatto in cui viene definito lo SLI dipende dal tipo di metrica utilizzata come metrica dell'indicatore, ma in genere si tratta di un confronto tra risultati accettabili e totali.

Uno SLI è rappresentato dall'oggetto ServiceLevelIndicator. Questo oggetto è un modo collettivo per fare riferimento ai tre tipi supportati di SLI:

  • Uno SLI di base, creato automaticamente per le istanze del tipo di servizio BasicService. Questo tipo di SLI è descritto in Obiettivi del livello di servizio ed è rappresentato da un oggetto BasicSli e misura disponibilità o latenza.

  • Uno SLI basato su richiesta, che puoi utilizzare per conteggiare gli eventi che rappresentano un servizio accettabile. L'utilizzo di questo tipo di SLI è descritto negli SLO basati su richiesta; è rappresentato da un oggetto RequestBasedSli.

  • Uno SLI basato su finestra che puoi utilizzare per conteggiare i periodi di tempo che soddisfano un determinato criterio di integrità. L'utilizzo di questo tipo di SLI è descritto negli SLO basati su Windows; è rappresentato da un oggetto WindowsBasedSli.

Ad esempio, quanto segue mostra uno SLI di disponibilità di base:

{
  "basicSli": {
    "availability": {},
    "location": [
      "us-central1-c"
    ]
  }
}

Strutture per gli SLI basati su richiesta

Uno SLI basato su richiesta si basa su una metrica che conteggia le unità di servizio come rapporto tra un determinato risultato e il totale. Ad esempio, se utilizzi una metrica che conteggia le richieste, puoi creare il rapporto tra il numero di richieste che restituiscono risultati e il numero totale di richieste.

Esistono due modi per creare uno SLI per richiesta:

  • Come TimeSeriesRatio, quando il rapporto tra buon servizio e servizio totale viene calcolato in base a due serie temporali i cui valori hanno un tipo di metrica DELTA o CUMULATIVE.
  • Come DistributionCut, quando la serie temporale ha un tipo di valore DISTRIBUTION e i cui valori hanno un tipo di metrica DELTA o CUMULATIVE. Il valore di buon servizio equivale al conteggio di elementi che rientrano nei bucket degli istogrammi in un intervallo specificato e il totale è il conteggio di tutti i valori nella distribuzione.

Di seguito è riportata la rappresentazione JSON di uno SLI che utilizza un rapporto serie temporale:

{
  "requestBased": {
    "goodTotalRatio": {
      "totalServiceFilter": "resource.type=https_lb_rule metric.type="loadbalancing.googleapis.com/https/request_count"",
      "goodServiceFilter": "resource.type=https_lb_rule metric.type="loadbalancing.googleapis.com/https/request_count" metric.label.response_code_class=200",
    }
  }
}

Le serie temporali in questo rapporto sono identificate dalla coppia di tipi di risorse e di metriche monitorate:

  • Risorsa: https_lb_rule
  • Tipo di metrica: loadbalancing.googleapis.com/https/request_count

Il valore di totalServiceFilter è rappresentato dalla coppia di metrica e tipo di risorsa. Il valore di goodServiceFilter è rappresentato dalla stessa coppia ma dove alcune etichette hanno un valore specifico; in questo caso, quando il valore dell'etichetta response_code_class è 200.

Il rapporto tra i filtri misura il numero di richieste che restituiscono uno stato HTTP 2xx rispetto al numero totale di richieste.

Di seguito è riportata la rappresentazione JSON di uno SLI che utilizza un taglio di distribuzione:

{
  "requestBased": {
    "distribution_cut": {
      "distribution_filter": "resource.type=https_lb_rule  metric.type="loadbalancing.googleapis.com/https/backend_latencies" metric.label.response_code_class=200",
      "range": {
        "min": "-Infinity",
        "max": 500.0
      }
    }
  }
}

Le serie temporali sono identificate dal tipo di risorsa monitorata, dal tipo di metrica e dal valore per un'etichetta della metrica:

  • Risorsa: https_lb_rule
  • Tipo di metrica: loadbalancing.googleapis.com/https/backend_latencies
  • Coppia valore-etichetta: response_code_class = 200

L'intervallo di latenze considerate valide è indicato nel campo range. Questo SLI calcola il rapporto di latenze di risposte di classe 2xx al di sotto di 500 rispetto alle latenze di tutte le risposte di classe 200.

Strutture per SLI basati su finestre

Uno SLI basato su finestre conteggia le finestre temporali in cui il servizio fornito è considerato buono. Il criterio per determinare come un buon servizio fa parte della definizione SLI.

Tutti gli SLI basati su finestre includono un periodo di finestra, 60-86.400 secondi (1 giorno).

Esistono due modi per specificare il criterio di servizio valido per uno SLI basato su Windows:

  • Crea una stringa di filtro, descritta in Filtri di monitoraggio che restituisce una serie temporale con valori booleani. Una finestra è buona se il suo valore è true. Questo filtro è chiamato goodBadMetricFilter.
  • Crea un oggetto PerformanceThreshold che rappresenti una soglia per le prestazioni accettabili. Questo oggetto è specificato come il valore di goodTotalRatioThreshold.

    Un oggetto PerformanceThreshold specifica un valore di soglia e uno SLI di prestazioni. Se il valore dello SLI di rendimento soddisfa o supera il valore della soglia, il periodo di tempo viene considerato valido.

    Esistono due modi per specificare lo SLI per le prestazioni:

Di seguito è riportata la rappresentazione JSON di uno SLI basato su finestre basato su una soglia di prestazioni per uno SLI di disponibilità di base:

{
  "windowsBased": {
     "goodTotalRatioThreshold": {
       "threshold": 0.9,
       "basicSliPerformance": {
         "availability": {},
         "location": [
           "us-central1-c"
         ]
       }
     },
     "windowPeriod": "300s"
   }
}

Questo SLI specifica buone prestazioni come una finestra di 5 minuti in cui la disponibilità raggiunge il 90% o più. La struttura di uno SLI di base viene mostrata negli indicatori del livello del servizio.

Puoi anche incorporare uno SLI basato su richiesta nello SLI basato su finestre. Per ulteriori informazioni sulle strutture incorporate, consulta la pagina Strutture per gli SLI basati su richiesta.

Obiettivi del livello di servizio

Un obiettivo del livello di servizio (SLO) è rappresentato da un oggetto ServiceLevelObjective. Questo oggetto include i seguenti campi:

  • Un nome
  • Il nome visualizzato
  • Lo SLI di destinazione; un oggetto ServiceLevelIndicator incorporato
  • L'obiettivo di prestazioni per lo SLI
  • Il periodo di conformità dello SLI

Di seguito è riportata la rappresentazione JSON di uno SLO che utilizza uno SLI di disponibilità di base come valore del campo serviceLevelIndicator:

{
   "name": "projects/PROJECT_NUMBER/services/PROJECT_ID-zone-us-central1-c-csm-main-default-currencyservice/serviceLevelObjectives/3kavNVTtTMuzL7KcXAxqCQ",
   "serviceLevelIndicator": {
     "basicSli": {
       "availability": {},
       "location": [
         "us-central1-c"
       ]
     }
   },
   "goal": 0.98,
   "calendarPeriod": "WEEK",
   "displayName": "98% Availability in Calendar Week"
}

Questo SLO imposta l'obiettivo di prestazioni al 98% di disponibilità su un periodo di una settimana.