C++ e OpenTelemetry

Questa pagina è rivolta agli sviluppatori di applicazioni che vogliono raccogliere dati di Cloud Trace per applicazioni C++ utilizzando OpenTelemetry. OpenTelemetry è un framework di strumentazione indipendente dal fornitore che puoi utilizzare per raccogliere dati di traccia e metriche. Per informazioni sulla strumentazione del codice, vedi Strumentazione e osservabilità.

Questa pagina ti guida attraverso i seguenti passaggi:

  • Installa i pacchetti OpenTelemetry.
  • Configura l'applicazione per esportare gli span in Cloud Trace.
  • Configura la tua piattaforma.

Per informazioni sulle release, consulta le seguenti risorse:

Per i contenuti di riferimento di OpenTelemetry, consulta quanto segue:

Per i dettagli più recenti su OpenTelemetry per C++, insieme a documentazione ed esempi aggiuntivi, consulta OpenTelemetry.

Prima di iniziare

Enable the Cloud Trace API.

Enable the API

Installa i pacchetti OpenTelemetry

Configura l'esportazione degli span in Cloud Trace

Per configurare l'esportazione dei dati di traccia, chiama il metodo google::cloud::otel::ConfigureBasicTracing(...) nel metodo main():

namespace gc = ::google::cloud;
[](std::string project_id) {
  auto project = gc::Project(std::move(project_id));
  auto configuration = gc::otel::ConfigureBasicTracing(project);

  MyApplicationCode();
}

Il campo project_id è il progetto Google Cloud in cui vuoi archiviare le tracce.

Il metodo ConfigureBasicTracing(...) crea un'istanza di un oggetto TracerProvider che implementa un esportatore Cloud Trace. Se l'oggetto restituito dalla chiamata a ConfigureBasicTracing(...) esce dall'ambito, l'oggetto TracerProvider precedente viene reintegrato, se esistente.

Configurare la frequenza di campionamento

Le applicazioni potrebbero generare un volume elevato di dati di traccia. Il seguente esempio mostra come configurare la frequenza di campionamento:

namespace gc = ::google::cloud;
[](std::string project_id) {
  auto project = gc::Project(std::move(project_id));
  auto options = gc::Options{}.set<gc::otel::BasicTracingRateOption>(.001);
  auto configuration = gc::otel::ConfigureBasicTracing(project, options);

  MyApplicationCode();
}

Esportare in Cloud Trace con un TracerProvider personalizzato

Potresti avere casi d'uso che richiedono un oggetto TracerProvider personalizzato. Ad esempio, se vuoi utilizzare più esportatori contemporaneamente, devi creare un oggetto TracerProvider personalizzato. In questi casi, puoi utilizzare direttamente l'esportatore Cloud Trace:

namespace gc = ::google::cloud;
using ::opentelemetry::trace::Scope;
[](std::string project_id) {
  // Use the Cloud Trace Exporter directly.
  auto project = gc::Project(std::move(project_id));
  auto exporter = gc::otel::MakeTraceExporter(project);

  // Advanced use cases may need to create their own tracer provider, e.g. to
  // export to Cloud Trace and another backend simultaneously. In this
  // example, we just tweak some OpenTelemetry settings that google-cloud-cpp
  // does not expose.
  opentelemetry::sdk::trace::BatchSpanProcessorOptions options;
  options.schedule_delay_millis = std::chrono::milliseconds(1000);
  auto processor =
      opentelemetry::sdk::trace::BatchSpanProcessorFactory::Create(
          std::move(exporter), options);

  // Create a tracer provider and set it as the global trace provider
  opentelemetry::trace::Provider::SetTracerProvider(
      std::shared_ptr<opentelemetry::trace::TracerProvider>(
          opentelemetry::sdk::trace::TracerProviderFactory::Create(
              std::move(processor))));

  MyApplicationCode();

  // Clear the global trace provider
  opentelemetry::trace::Provider::SetTracerProvider(
      opentelemetry::nostd::shared_ptr<
          opentelemetry::trace::TracerProvider>());
}

Instrumentare la tua applicazione

Per informazioni su come configurare l'applicazione per acquisire gli span di traccia, vedi Tracciamento OpenTelemetry. Questa pagina descrive come eseguire tutte le seguenti operazioni:

  • Crea un intervallo
  • Creare intervalli nidificati
  • Imposta gli attributi span
  • Creare intervalli con eventi
  • Creare intervalli con link
// For more details on the OpenTelemetry code in this sample, see:
//     https://opentelemetry.io/docs/instrumentation/cpp/manual/
namespace gc = ::google::cloud;
using ::opentelemetry::trace::Scope;
[](std::string project_id) {
  auto project = gc::Project(std::move(project_id));
  auto configuration = gc::otel::ConfigureBasicTracing(project);

  // Initialize the `Tracer`. This would typically be done once.
  auto provider = opentelemetry::trace::Provider::GetTracerProvider();
  auto tracer = provider->GetTracer("my-application");

  // If your application makes multiple client calls that are logically
  // connected, you may want to instrument your application.
  auto my_function = [tracer] {
    // Start an active span. The span is ended when the `Scope` object is
    // destroyed.
    auto scope = Scope(tracer->StartSpan("my-function-span"));

    // Any spans created by the client library will be children of
    // "my-function-span". i.e. In the distributed trace, the client calls are
    // sub-units of work of `my_function()`, and will be displayed as such in
    // Cloud Trace.
    Client client;
    client.CreateFoo();
    client.DeleteFoo();
  };

  // As an example, start a span to cover both calls to `my_function()`.
  auto scope = Scope(tracer->StartSpan("my-application-span"));
  my_function();
  my_function();
}

Applicazione di esempio

Per un'applicazione di esempio, consulta la guida rapida.

Configura la tua piattaforma

Puoi utilizzare Cloud Trace su Google Cloud e altre piattaforme.

In esecuzione su Google Cloud

Quando l'applicazione viene eseguita su Google Cloud, non è necessario fornire le credenziali di autenticazione sotto forma diaccount di serviziot alla libreria client. Tuttavia, devi assicurarti che la tua Google Cloud piattaforma abbia l'ambito di accesso dell'API Cloud Trace abilitato.

Per un elenco degli ambienti Google Cloud supportati, consulta la sezione Supporto degli ambienti.

Per le seguenti configurazioni, le impostazioni predefinite dell'ambito di accesso abilitano l&#39Cloud Trace APIe:

Se utilizzi ambiti di accesso personalizzati, devi assicurarti che l'ambito di accesso all'API Cloud Trace sia abilitato:

  • Per informazioni su come configurare gli ambiti di accesso per il tuo ambiente utilizzando la console Google Cloud , consulta Configurazione del progetto Google Cloud .

  • Per gli utenti gcloud, specifica gli ambiti di accesso utilizzando il flag --scopes e includi l'ambito di accesso all&#39Cloud Trace APIe trace.append. Ad esempio, per creare un cluster GKE con solo l'Cloud Trace API abilitata, procedi nel seguente modo:

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

Esecuzione in locale e altrove

Se la tua applicazione viene eseguita al di fuori di Google Cloud, devi fornire le credenziali di autenticazione sotto forma diaccount di serviziot alla libreria client. Il account di servizio deve contenere il ruolo Agente Cloud Trace. Per le istruzioni, vedi Creare un service account.

Le librerie clientGoogle Cloud utilizzano le Credenziali predefinite dell'applicazione (ADC) per trovare le credenziali della tua applicazione.

Puoi fornire queste credenziali in tre modi:

  • Esegui gcloud auth application-default login

  • Posiziona il 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 sul percorso del 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"

Visualizza tracce

Nella Google Cloud console, vai alla pagina Esplora tracce:

Vai a Trace Explorer

Puoi trovare questa pagina anche utilizzando la barra di ricerca.

Risoluzione dei problemi

Per informazioni sulla risoluzione dei problemi relativi a Cloud Trace, vai alla pagina di risoluzione dei problemi.

Per eseguire il debug dell'esportatore C++ Cloud Trace, consulta la sezione Risoluzione dei problemi della documentazione di riferimento.

Risorse