Tracciamento dell'API

OpenAPI   |  gRPC

Dopo aver eseguito il deployment di Extensible Service Proxy (ESP) o Extensible Service Proxy V2 (ESPv2) e del codice di backend dell'API, il proxy intercetta tutte le richieste ed esegue i controlli necessari prima di inoltrarle al backend dell'API. Quando il backend risponde, il proxy raccoglie e segnala la telemetria. Un elemento dei dati di telemetria acquisiti dal proxy è il tracciamento, tramite Cloud Trace.

Questa pagina spiega come:

• Visualizza le tracce nella console Google Cloud .
• Stima il costo di Trace.
• Configura il proxy per disattivare il campionamento delle tracce.

Visualizzazione delle tracce

Una traccia monitora una richiesta in entrata alla tua API e i vari eventi (come chiamate RPC o sezioni di codice strumentate), insieme ai tempi precisi di ogni evento. Questi eventi sono rappresentati come intervalli nella traccia.

Per visualizzare le tracce del tuo progetto, vai alla pagina Cloud Trace in Google Cloud console:

Vai a Trace

Nella pagina Esplora tracce, puoi visualizzare in dettaglio una singola traccia e gli intervalli che ESP crea in una traccia. Puoi utilizzare il filtro per visualizzare le tracce per una singola API o operazione.

Le tracce e gli intervalli creati per la tua API variano a seconda che la tua API utilizzi ESPv2 o ESP. Di seguito è riportato un riepilogo dei formati di traccia per ogni implementazione.

Per saperne di più sulla pagina Esplora tracce, consulta Trovare ed esplorare le tracce.

Span creati da ESPv2

ESPv2 crea tracce nel seguente formato:

Come minimo, ESPv2 crea due intervalli per traccia:

• Uno span ingress OPERATION_NAME per l'intera richiesta e risposta.
• Un intervallo router BACKEND egress per il tempo in cui ESPv2 attende che il backend elabori la richiesta e risponda. Ciò include l'hop di rete tra ESPv2 e il backend.

A seconda della configurazione dell'API, ESPv2 potrebbe creare span aggiuntive:

• Se la tua API richiede l'autenticazione, ESPv2 memorizza nella cache la chiave pubblica necessaria per l'autenticazione per 5 minuti. Se la chiave pubblica non è nella cache, ESPv2 la recupera e la memorizza nella cache e crea uno span JWT Remote PubKey Fetch.
• Se la tua API richiede una chiave API, ESPv2 memorizza nella cache le informazioni necessarie per convalidare la chiave API. Se le informazioni non sono nella cache, ESPv2 chiama Service Control e crea uno span Service Control remote call: Check.

In generale, ESPv2 crea span solo per le chiamate di rete che bloccano la richiesta in entrata. Le richieste non bloccanti non verranno tracciate. Qualsiasi elaborazione locale creerà eventi temporali anziché intervalli. Ad esempio:

• L'applicazione delle quote richiede chiamate remote, ma queste non si verificano nel percorso di una richiesta API e non avranno intervalli associati nella traccia.
• Le chiavi API vengono memorizzate nella cache di ESPv2 per un breve periodo di tempo. Tutte le richieste che utilizzano la cache avranno un evento temporale associato nella traccia.

Intervalli creati dal fornitore di servizi email

Avviso: ESP non fornisce informazioni dettagliate per gli intervalli. Crea anche intervalli aggiuntivi che non sono significativi. Esegui la migrazione a ESPv2 per visualizzare tracce dettagliate che seguono le best practice per la tracciamento.

ESP crea tracce nel seguente formato:

Come minimo, ESP crea quattro intervalli per traccia:

• Uno span per l'intera richiesta e risposta.
• Uno span CheckServiceControl per la chiamata al metodo Service Control services.check per ottenere la configurazione della tua API.
• Un intervallo QuotaControl per verificare se è configurata una quota nella tua API.
• Uno span Backend che tiene traccia del tempo trascorso nel codice backend della tua API.

A seconda della configurazione dell'API, ESP crea span aggiuntive:

• Se la tua API richiede l'autenticazione, ESP crea uno span CheckAuth in ogni traccia. Per autenticare una richiesta, ESP memorizza nella cache la chiave pubblica necessaria per l'autenticazione per 5 minuti. Se la chiave pubblica non è nella cache, ESP la recupera e la memorizza nella cache e crea un intervallo HttpFetch.
• Se la tua API richiede una chiave API, ESP crea uno span CheckServiceControlCache in ogni traccia. ESP memorizza nella cache le informazioni necessarie per convalidare la chiave API. Se le informazioni non sono nella cache, ESP chiama Service Control e crea uno span Call ServiceControl server.
• Se hai impostato una quota per la tua API, ESP crea uno span QuotaServiceControlCache in ogni traccia. ESP memorizza nella cache le informazioni necessarie per controllare la quota. Se le informazioni non sono nella cache, ESP chiama Service Control e crea uno span Call ServiceControl server.

Frequenza di campionamento delle Trace

ESP esegue il campionamento di un numero ridotto di richieste alla tua API per ottenere dati di traccia. Per controllare la frequenza di campionamento, ESP gestisce un contatore delle richieste e un timer. Il numero di richieste al secondo alla tua API determina la frequenza di campionamento. Se non ci sono richieste entro un secondo, ESP non invia una traccia.

Se il numero di richieste in un secondo è:

• Minore o uguale a 999, ESP invia una traccia.
• Tra 1000 e 1999, ESP invia 2 tracce.
• Tra 2000 e 2999, ESP invia 3 tracce.
• e così via.

In sintesi, puoi stimare la frequenza di campionamento con la funzione ceiling: ceiling(requests per second/1000)

Stima del costo di Trace

Per stimare il costo di Trace, devi stimare il numero di intervalli che l'ESP invia a Trace in un mese.

Per stimare il numero di intervalli al mese:

1. Stima il numero di richieste al secondo alla tua API. Per ottenere questa stima, puoi utilizzare il grafico Richieste nella pagina Endpoint > Servizi o Cloud Logging. Per saperne di più, consulta Monitoraggio dell'API.
2. Calcola il numero di tracce che ESP invia a Trace al secondo: ceiling(requests per second/1000)
3. Stima il numero di intervalli in una traccia. Per ottenere questa stima, puoi utilizzare le informazioni riportate in Intervalli creati da ESP o visualizzare la pagina Elenco tracce per vedere le tracce della tua API.
4. Stima il numero di secondi al mese in cui la tua API riceve traffico. Ad esempio, alcune API ricevono richieste solo in determinati orari del giorno, mentre altre API ricevono richieste sporadiche.
5. Moltiplica il numero di secondi del mese per il numero di intervalli.

Ad esempio:

1. Supponiamo che il numero massimo di richieste al secondo per un'API sia 5.
2. La frequenza di campionamento delle tracce è pari a ceiling (5/1000) = 1
3. L'API non ha una quota configurata, non richiede una chiave API e non richiede l'autenticazione. Pertanto, il numero di intervalli che ESP crea per traccia è 4.
4. Questa API riceve richieste solo durante l'orario di ufficio, dal lunedì al venerdì. Il numero di secondi in un mese in cui l'API riceve traffico è approssimativamente: 3600 X 8 X 20 = 576.000
5. Il numero di intervalli al mese è di circa 576.000 x 4 = 2.304.000

Dopo aver calcolato il numero approssimativo di intervalli in un mese, consulta la pagina Prezzi di Trace per informazioni dettagliate sui prezzi.

Disattivare il campionamento delle tracce

Se vuoi impedire a ESP di campionare le richieste e inviare le tracce, puoi impostare un'opzione di avvio di ESP e riavviare ESP. Le tracce inviate da ESP a Cloud Trace sono indipendenti dai grafici visualizzati nella pagina Endpoint > Servizi. I grafici continuano a essere disponibili se disattivi il campionamento delle tracce.

La sezione seguente presuppone che tu abbia già eseguito il deployment dell'API e dell'ESP o che tu abbia familiarità con la procedura di deployment. Per saperne di più, consulta Esegui il deployment del backend dell'API.

App Engine

Per disattivare il campionamento delle tracce ESP nell'ambiente flessibile di App Engine:

1. Modifica il file app.yaml. Nella sezione endpoints_api_service, aggiungi l'opzione trace_sampling e imposta il valore su false. Ad esempio:

   endpoints_api_service:
     name: example-project-12345.appspot.com
     rollout_strategy: managed
     trace_sampling: false

   Se la tua applicazione è basata su microservizi, devi includere trace_sampling: false in ogni file app.yaml.

2. Se non hai aggiornato Google Cloud CLI di recente, esegui questo comando:

   gcloud components update

3. Salva il file (o i file) app.yaml.
4. Esegui il deployment del codice backend e di ESP in App Engine:

   gcloud app deploy

Per riattivare il campionamento delle tracce:

1. Rimuovi l'opzione trace_sampling da app.yaml.
2. Esegui il deployment del codice backend e di ESP in App Engine:

   gcloud app deploy

Compute Engine

Per disattivare il campionamento delle tracce ESP in Compute Engine con Docker:

1. Connettiti all'istanza VM:

   gcloud compute ssh [INSTANCE_NAME]

2. Nei flag ESP per il comando docker run, aggiungi l'opzione --disable_cloud_trace_auto_sampling:

   sudo docker run \
       --name=esp \
       --detach \
       --publish=80:8080 \
       --net=esp_net \
       gcr.io/endpoints-release/endpoints-runtime:1 \
       --service=[SERVICE_NAME] \
       --rollout_strategy=managed \
       --backend=[YOUR_API_CONTAINER_NAME]:8080 \
       --disable_cloud_trace_auto_sampling

3. Esegui il comando docker run per riavviare ESP.

Per riattivare il campionamento delle tracce:

1. Rimuovi --disable_cloud_trace_auto_sampling.
2. Esegui il comando docker run per riavviare ESP.

GKE

Per disabilitare il campionamento delle tracce ESP in GKE:

1. Apri il file manifest del deployment, denominato deployment.yaml, e aggiungi quanto segue alla sezione containers:

   containers:
   - name: esp
     image: gcr.io/endpoints-release/endpoints-runtime:1
     args: [
       "--http_port=8081",
       "--backend=127.0.0.1:8080",
       "--service=[SERVICE_NAME]",
       "--rollout_strategy=managed",
       "--disable_cloud_trace_auto_sampling"
     ]

2. Avvia il servizio Kubernetes utilizzando il comando kubectl create:

   kubectl create -f deployment.yaml

Per riattivare il campionamento delle tracce:

1. Rimuovi l'opzione --disable_cloud_trace_auto_sampling.
2. Avvia il servizio Kubernetes:

   kubectl create -f deployment.yaml

Se esegui ESP su un'istanza VM di Compute Engine senza un container Docker, non esiste una coppia chiave-valore di metadati dell'istanza VM equivalente per l'opzione --disable_cloud_trace_auto_sampling. Se vuoi disattivare il campionamento delle tracce, devi eseguire ESP in un container.

Un client può forzare la tracciabilità di una richiesta aggiungendo l'intestazione X-Cloud-Trace-Context alla richiesta, come descritto in Forzare la tracciabilità di una richiesta. Se una richiesta contiene l'intestazione X-Cloud-Trace-Context, ESP invia i dati di traccia a Trace anche se hai disattivato il campionamento delle tracce.

Propagazione del contesto di traccia

Per la tracciabilità distribuita, un'intestazione della richiesta può contenere un contesto di traccia che specifica un ID traccia. L'ID traccia viene utilizzato quando ESPv2 crea nuovi intervalli di traccia e li invia a Cloud Trace. L'ID traccia viene utilizzato per cercare tutte le tracce e unire gli span per una singola richiesta. Se nella richiesta non viene specificato alcun contesto di traccia e la traccia è abilitata, viene generato un ID traccia casuale per tutti gli intervalli di traccia.

Nell'esempio seguente, Cloud Trace correla gli span creati da ESPv2 (1) con gli span creati dal backend (2) per una singola richiesta. Questo aiuta a eseguire il debug dei problemi di latenza nell'intero sistema:

Per maggiori dettagli, leggi Concetti principali di OpenTelemetry: propagazione del contesto.

Nota: la tracciabilità distribuita richiede che i tuoi client e/o i tuoi backend supportino la tracciabilità. Questo argomento non rientra nell'ambito di questa documentazione. Ti consigliamo di utilizzare OpenTelemetry.

Intestazioni supportate

ESPv2 supporta le seguenti intestazioni di propagazione del contesto di traccia:

• traceparent: L'intestazione di propagazione del contesto di traccia standard W3C. Supportato dalla maggior parte dei framework di tracciamento moderni.
• x-cloud-trace-context: l'intestazione di propagazione del contesto di traccia di GCP. Supportato da framework di tracciamento precedenti e dalle librerie di Google, ma specifico del fornitore.
• grpc-trace-bin: Trace di propagazione del contesto di tracciamento utilizzata dai backend gRPC con la libreria di tracciamento OpenCensus.

Se stai creando una nuova applicazione, ti consigliamo di utilizzare la propagazione del contesto di traccia traceparent. ESPv2 estrae e propaga questa intestazione per impostazione predefinita. Per maggiori dettagli sulla modifica del comportamento predefinito, consulta Opzioni di avvio della tracciabilità ESPv2.

Nota: a differenza di ESPv2, la propagazione del contesto di traccia in ESP deve essere attivata manualmente tramite le opzioni di avvio. Il fornitore di servizi email non supporta l'intestazione traceparent.