Note sulla terminologia

Distinguere tra termini sovrapposti come name, type, kind, metric e resource ti aiuta a interpretare la documentazione di Cloud Monitoring e a fornire i campi corretti nelle richieste dell'API Cloud Monitoring. L'utilizzo casuale spesso confonde le differenze tra tipi di metriche, tipi di risorse monitorate, tipi di valori, tipi di metriche e nomi delle risorse API.

Termini sovrapposti comuni

I seguenti esempi illustrano come i termini e gli identificatori di Monitoring vengono spesso utilizzati in modo intercambiabile a seconda del contesto:

  • Il termine metrica può essere utilizzato, in contesti diversi, per fare riferimento a uno dei seguenti elementi:

    • Un "qualcosa" generico da misurare
    • Un tipo di metrica
    • Una serie temporale
    • Un insieme di serie temporali associate a un tipo di metrica
    • La struttura Metric incorporata in una struttura TimeSeries

  • Una stringa come storage.googleapis.com/api/request_count potrebbe essere indicata come:

    • Una metrica
    • Un nome di metrica
    • Un tipo di metrica
    • Un nome del tipo di metrica

  • Una stringa come gcs_bucket potrebbe essere indicata come:

    • Un nome della risorsa1
    • Una risorsa monitorata
    • Un tipo di risorsa monitorata
    • Un nome di risorsa monitorata

1 Il materiale di riferimento dell'API REST utilizza spesso anche il termine nome della risorsa, che di solito non ha nulla a che fare con le risorse monitorate. Questo termine è descritto in modo più dettagliato in Nomi delle risorse.

Il resto di questo documento fornisce alcune indicazioni sulla terminologia potenzialmente poco chiara.

Tipi e nomi

I descrittori per i tipi di metriche e le risorse monitorate hanno sia nomi sia tipi. Nell'uso comune, i termini vengono spesso utilizzati in modo intercambiabile.

Ad esempio, la stringa storage.googleapis.com/api/request_count è un tipo di metrica, anche se viene chiamata anche nome o nome del tipo.

Se esamini il descrittore per questo tipo di metrica, vedrai queste due coppie chiave-valore, name e type:

{
  "name": "projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count",
  ...
  "type": "storage.googleapis.com/api/request_count",
}

type in un descrittore della metrica è una stringa che codifica le informazioni sul servizio che genera i dati (ad esempio storage.googleapis.com) e su ciò che viene misurato (api/request_count).

In un descrittore della metrica, il valore del campo name è la versione completa del tipo di metrica; il valore name è il valore type con il prefisso di questa stringa:

projects/[PROJECT_ID]/metricDescriptors/

Un pattern simile vale per le risorse monitorate. type è un'etichetta per un tipo di risorsa e name è costituito dal valore type con il prefisso di questa stringa:

projects/[PROJECT_ID]/monitoredResourceDescriptors/

L'esempio seguente corrisponde alla voce api nell'elenco delle risorse monitorate:

{
  "type": "api",
  ...
  "name": "projects/[PROJECT_ID]/monitoredResourceDescriptors/api"
}

Il valore di name all'interno di un progetto è interamente prevedibile dal valore di type, ma non sono esattamente la stessa cosa. Tuttavia, i termini vengono spesso utilizzati in modo impreciso nelle discussioni informali.

Tipo di metrica e tipo di valore

Esistono altri due termini che possono essere confusi con "tipo di metrica":

  • Tipo di valore
  • Tipo di metrica

Questi termini non sono termini alternativi per "tipo di metrica".

"Tipo di valore" e "tipo di metrica" descrivono i dati raccolti. Entrambi sono correlati al concetto di programmazione "tipo di dati".

  • Il tipo di valore descrive i singoli valori.
  • Il tipo di metrica descrive la relazione tra i valori.

Per maggiori dettagli, consulta Tipi di valori e tipi di metriche.

Nomi delle risorse

Il pattern di creazione di un valore name aggiungendo una stringa come prefisso a un valore type (o altro) si estende ben oltre i tipi di metriche e risorse monitorate. Viene visualizzato con quasi tutto ciò che crea dati identificabili in modo univoco. Ad esempio, sia MetricDescriptor che AlertPolicy seguono questo pattern.

Il valore del campo name viene spesso descritto nella documentazione di riferimento come "nome della risorsa":

Nome della risorsa nel riferimento API

Ecco alcuni esempi di strutture con nomi delle risorse e come vengono derivati:

  • Descrittori delle metriche: unisci i valori del prefisso e del campo type:
    • Prefisso: projects/[PROJECT_ID]/metricDescriptors
    • type (esempio): storage.googleapis.com/api/request_count
    • name: projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
  • Descrittori delle risorse monitorate: unisci i valori del prefisso e del campo type:
    • Prefisso: projects/[PROJECT_ID]/monitoredResourceDescriptors
    • type (esempio): api
    • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
  • Policy di avviso: unisci i valori del prefisso e un ID generato:
    • Prefisso: projects/[PROJECT_ID]/alertPolicies
    • ID policy di avviso: un numero generato al momento della creazione della policy
    • name: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

Il termine "nome della risorsa" si riferisce a una risorsa nella gerarchia dell'API di un servizio e non è correlato in alcun modo al concetto di risorse monitorate. Per saperne di più sui nomi delle risorse nella progettazione di un'API, consulta Nomi delle risorse.