Strumento per Cloud Trace

Questo documento fornisce una breve panoramica su come instrumentare la tua richiesta per Cloud Trace. Per istruzioni dettagliate sulla configurazione di Cloud Trace, consulta le pagine di configurazione specifiche per ogni lingua.

Cloud Trace fornisce dati di tracciamento distribuiti per le tue applicazioni. Dopo il giorno strumentalizzando la tua applicazione, puoi esaminare i dati di latenza per una singola richiesta e visualizzare la latenza aggregata per un'intera applicazione nella console Cloud Trace.

Quando instrumentare l'applicazione

Quando i dati di traccia non vengono acquisiti automaticamente, è necessario instrumentare alla tua applicazione per raccogliere questi dati.

Puoi instrumentare la tua applicazione in modo che raccolga specifiche per l'applicazione. Diversi contenuti open source di strumentazione ti consentono di raccogliere metriche, log dall'applicazione e inviare i dati a qualsiasi fornitore, incluso Google Cloud. Per instrumentare la tua applicazione, ti consigliamo di utilizzare una un framework di strumentazione neutrale dal fornitore e open source, come OpenTelemetry, anziché librerie client o API specifiche del fornitore e del prodotto.

Per informazioni sulla strumentazione delle applicazioni mediante di strumentazione indipendente dal fornitore, vedi Strumentazione e osservabilità.

Come instrumentare le applicazioni

Per instrumentare le applicazioni alla raccolta dei dati di traccia, puoi: uno qualsiasi dei seguenti elementi:

Quando creare gli intervalli

Le librerie client di Cloud Trace in genere mantengono una traccia globale contesto che contiene informazioni sull'intervallo attuale, incluso l'ID traccia e se la traccia è campionata. Queste librerie di solito creano intervalli su RPC confini. Tuttavia, potrebbe essere necessario creare intervalli se la creazione predefinita non è sufficiente per le tue esigenze.

L'intervallo attivo attuale è accessibile dal contesto della traccia globale, che è talvolta avvolte in un oggetto Tracer. Puoi aggiungere informazioni pertinenti alla tua applicazione utilizzando annotazioni e tag personalizzati a intervalli esistenti oppure puoi creare nuovi intervalli figlio con le proprie annotazioni e tag per tracciare il comportamento dell'applicazione con maggiore granularità. Poiché il contesto è un'applicazione globale multi-thread che aggiorna il contesto utilizzare un isolamento appropriato.

Quando fornire le credenziali di autenticazione

In genere non è necessario fornire le credenziali di autenticazione dell'applicazione o specificare l'ID progetto Google Cloud in esecuzione su Google Cloud. Per alcune lingue, devi specificare l'ID progetto Google Cloud anche se in esecuzione su Google Cloud. Inoltre, se usi la modalità Autopilot Google Kubernetes Engine o se abiliti Workload Identity, devi configurare l'applicazione per l'utilizzo di Workload Identity.

Se esegui l'esecuzione al di fuori di Google Cloud, devi fornire credenziali di autenticazione alla tua applicazione. Devi specificare anche all'ID progetto Google Cloud nell'applicazione.

Per informazioni dettagliate, vai alle pagine di configurazione specifiche per ogni lingua.

Come forzare il tracciamento di una richiesta

A meno che l'applicazione non campiona sempre ogni intervallo, non è possibile, in generale, forzare il tracciamento end-to-end di una richiesta poiché ogni componente di una richiesta end-to-end fa il proprio decisione sul campionamento. Tuttavia, puoi influenzare decisione aggiungendo all'intestazione di traccia un flag sampled, con questo flag impostato su true. Questa impostazione è un suggerimento per i componenti secondari per campionare la richiesta. Per ulteriori informazioni sulle intestazioni di traccia, consulta Protocolli per la propagazione del contesto.

Per i componenti downstream di cui possiedi il codice, devi determinare se la logica di strumentazione rispetta il flag sampled. Ad esempio, quando utilizzi OpenTelemetry per la strumentazione, puoi usare il campionatore ParentBased per garantire che il flag campionato padre venga rispettato.

Servizi Google Cloud che registrano le informazioni di tracciamento in Cloud Trace in genere accetta il flag di campionamento padre come suggerimento; tuttavia, la maggior parte e campionamento a limiti di frequenza. Ogni servizio Google Cloud determina se supporta il tracciamento, il modo in cui il campionamento padre e il limite di frequenza per il campionamento.

Come correlare i dati di metriche e traccia

Puoi correlare i dati delle metriche con valore di distribuzione con tracce mediante l'aggiunta di esempi ai punti dati delle metriche. A condizione che tu completi i passaggi di configurazione necessari, OpenTelemetry, la libreria di strumentazione consigliata, aggiunge automaticamente questi esemplari. Per ulteriori informazioni, vedi Correlare metriche e tracce utilizzando degli esempi.

Configura il progetto e la piattaforma

  1. Assicurati che l'Cloud Trace API sia abilitata.

    L'Cloud Trace API è abilitata per impostazione predefinita nei progetti Google Cloud e non è richiesta alcuna azione da parte tua. Tuttavia, i vincoli di sicurezza definiti dalla tua organizzazione potrebbero aver disabilitato l'API. Per la risoluzione dei problemi le informazioni, vedi Sviluppa applicazioni in un ambiente Google Cloud vincolato.

    Attiva l'API Cloud Trace.

    Abilita l'API

  2. Configura la tua piattaforma.

    Puoi utilizzare Cloud Trace su Google Cloud e altre piattaforme.

    • Google Cloud: quando l'applicazione è in esecuzione Google Cloud, non devi fornire credenziali di autenticazione nella libreria client sotto forma di account di servizio. Tuttavia, per assicurarti che la tua piattaforma Google Cloud disponga Ambito di accesso all'API Cloud Trace in un bucket con il controllo delle versioni attivo.

      Per le seguenti configurazioni, le impostazioni predefinite dell'ambito dell'accesso includi l'ambito di accesso all'Cloud Trace API:

      Se utilizzi ambiti di accesso personalizzati, devi assicurarti che L'ambito di accesso all'API Cloud Trace sia abilitato. Ad esempio, se utilizzi Google Cloud CLI per creare nel cluster GKE e, se specifichi il flag --scopes, quindi assicurati che l'ambito includa trace.append. Il comando seguente illustra l'impostazione del flag --scopes:

      gcloud container clusters create example-cluster-name --scopes=https://www.googleapis.com/auth/trace.append

    • Esecuzione in locale e altrove: se l'applicazione è in esecuzione all'esterno di Google Cloud, devi fornire le credenziali di autenticazione sotto forma di account di servizio alla libreria client. All'account di servizio deve essere concesso l'agente Cloud Trace (roles/cloudtrace.agent). Per informazioni sui ruoli, vedi Controllo dell'accesso con IAM.

      Le librerie client di Google Cloud utilizzano Credenziali predefinite dell'applicazione (ADC) per trovare le credenziali dell'applicazione. Puoi fornire queste credenziali in una delle seguenti opzioni: tre modi:

      • Esegui gcloud auth application-default login

      • Inserisci l'account di servizio in un percorso predefinito per il tuo sistema operativo. Di seguito sono elencati i percorsi predefiniti per Windows e Linux:

        • Windows: %APPDATA%/gcloud/application_default_credentials.json

        • Linux: $HOME/.config/gcloud/application_default_credentials.json

      • Imposta la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS su il percorso del tuo account di servizio:

        Linux/macOS

          export GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key

        Windows

          set GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key

        PowerShell:

          $env:GOOGLE_APPLICATION_CREDENTIALS="path-to-your-service-accounts-private-key"

Passaggi successivi

Per informazioni dettagliate sulla configurazione, esempi e link a GitHub e altri repository open source, vai alla pagina di configurazione della tua lingua.