Questo documento mostra come eseguire OpenTelemetry Collecting in un cluster GKE per raccogliere log, metriche e tracce OTLP dalle applicazioni strumentate ed esportare questi dati in Google Cloud.
Prima di iniziare
L'esecuzione del raccoglitore OpenTelemetry su GKE richiede le seguenti risorse:
Un progetto Google Cloud con le API Cloud Monitoring, Cloud Trace API e API Cloud Logging abilitate.
Se non hai un progetto Google Cloud, segui questi passaggi:
Nella console Google Cloud, vai a Nuovo progetto:
Nel campo Nome progetto, inserisci un nome per il progetto, quindi fai clic su Crea.
Vai a Fatturazione:
Seleziona il progetto appena creato se non è già selezionato nella parte superiore della pagina.
Ti viene chiesto di scegliere un profilo pagamenti esistente o di crearne uno nuovo.
L'API Monitoring, l'API Trace e l'API Logging sono abilitate per impostazione predefinita per i nuovi progetti.
Se hai già un progetto Google Cloud, assicurati che le API Monitoring, Trace e API Logging siano abilitate:
Vai ad API e servizi:
Seleziona il progetto.
Fai clic su add Abilita API e servizi.
Cerca ogni API per nome.
Nei risultati di ricerca, fai clic sull'API denominata. L'API Monitoring viene visualizzata come "API Stackdriver Monitoring".
Se non viene visualizzato il messaggio "API abilitata", fai clic sul pulsante Attiva.
Un cluster Kubernetes. Se non hai un cluster Kubernetes, segui le istruzioni riportate nella guida rapida per GKE.
I seguenti strumenti a riga di comando:
gcloud
kubectl
Gli strumenti
gcloud
ekubectl
fanno parte dell'interfaccia a riga di comando Google Cloud. Per informazioni sull'installazione, consulta Gestire i componenti dell'interfaccia a riga di comando Google Cloud. Per visualizzare i componenti gcloud CLI che hai installato, esegui il seguente comando:gcloud components list
Configurare le autorizzazioni per il raccoglitore
Se hai disattivato l'identità del carico di lavoro GKE, puoi saltare questa sezione.
Per assicurarti che l'account di servizio Kubernetes del collector OpenTelemetry disponga delle autorizzazioni necessarie per esportare la telemetria, chiedi all'amministratore di concedere all'account di servizio Kubernetes del collector OpenTelemetry i seguenti ruoli IAM nel tuo progetto:
-
Monitoring Metric Writer (
roles/monitoring.metricWriter
) -
Logging Log Writer (
roles/logging.logWriter
) -
Agente di tracciamento (
roles/cloutrace.agent
)
Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.
L'amministratore potrebbe anche essere in grado di concedere all'account di servizio Kubernetes del collector OpenTelemetry le autorizzazioni richieste tramite ruoli personalizzati o altri ruoli predefiniti.
Per configurare le autorizzazioni, utilizza il comando add-iam-policy-binding
:
gcloud projects add-iam-policy-binding projects/PROJECT_ID \ --role=roles/logging.logWriter \ --member=principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/PROJECT_ID.svc.id.goog/subject/ns/opentelemetry/sa/opentelemetry-collector gcloud projects add-iam-policy-binding projects/PROJECT_ID \ --role=roles/monitoring.metricWriter \ --member=principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/PROJECT_ID.svc.id.goog/subject/ns/opentelemetry/sa/opentelemetry-collector gcloud projects add-iam-policy-binding projects/PROJECT_ID \ --role=roles/cloudtrace.agent \ --member=principal://iam.googleapis.com/projects/PROJECT_NUMBER/locations/global/workloadIdentityPools/PROJECT_ID.svc.id.goog/subject/ns/opentelemetry/sa/opentelemetry-collector
Prima di eseguire il comando, aggiorna i seguenti campi:
- PROJECT_ID: l'identificatore del progetto.
- PROJECT_NUMBER: il numero del progetto Google Cloud.
Esegui il deployment del raccoglitore
La pipeline del Collector può essere implementata direttamente da GitHub con i seguenti comandi dopo aver sostituito PROJECT_ID con l'ID del tuo progetto Google Cloud:
export GCLOUD_PROJECT=PROJECT_ID kubectl kustomize https://github.com/GoogleCloudPlatform/otlp-k8s-ingest.git/k8s/base | envsubst | kubectl apply -f -
Monitora ed esegui il debug del raccoglitore
OpenTelemetry Collector fornisce immediatamente le metriche di auto-osservabilità per aiutarti a monitorarne le prestazioni e garantire il tempo di attività continuo della pipeline di importazione OTLP.
Per monitorare il raccoglitore, installa la dashboard di esempio per il raccoglitore. Questa dashboard offre informazioni di riepilogo su diverse metriche del Collector, tra cui uptime, utilizzo della memoria e chiamate API a Google Cloud Observability.
Per installare la dashboard:
-
Nella console Google Cloud, vai alla pagina
Dashboard:
Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.
- Seleziona la scheda Sample Library (Raccolta di Sample).
- Seleziona la categoria OpenTelemetry Collector.
- Seleziona la dashboard "OpenTelemtry Collector".
- Fai clic su
Importa.
Per ulteriori informazioni sulla procedura di installazione, consulta Installare dashboard di esempio.
Configura il raccoglitore
La pipeline di importazione OTLP autogestita include una configurazione predefinita di OpenTelemetry Collector progettata per fornire volumi elevati di metriche, log e tracce OTLP con metadati GKE e Kubernetes coerenti allegati. È inoltre progettato per prevenire i problemi di importazione più comuni.
Tuttavia, potresti avere esigenze specifiche che richiedono la personalizzazione della configurazione predefinita. Questa sezione descrive i valori predefiniti forniti con la pipeline e come puoi personalizzarli in base alle tue esigenze.
La configurazione predefinita di Collector si trova su GitHub come
config/collector.yaml
:
Esportatori
Gli esportatori predefiniti includono l'esportatore
googlecloud
(per log e tracce) e l'esportatore
googlemanagedprometheus
(per le metriche).
L'esportatore googlecloud
è configurato con un nome predefinito per i log. L'esportatoregooglemanagedprometheus
non richiede alcuna configurazione predefinita. Per ulteriori informazioni sulla configurazione di questo esportatore, consulta Introduzione al Collector OpenTelemetry nella documentazione di Google Cloud Managed Service per Prometheus.
Processori
La configurazione predefinita include i seguenti processori:
batch
: configurato per raggruppare le richieste di telemetria in base al Google Cloud numero massimo di voci per richiesta o all' Google Cloud intervallo minimo di ogni 5 secondi (a seconda del caso).k8sattributes
: mappa automaticamente gli attributi delle risorse Kubernetes alle etichette di telemetria.memory_limiter
: limita l'utilizzo della memoria del Collector a un livello ragionevole per evitare arresti anomali dovuti a esaurimento della memoria eliminando i punti dati oltre questo livello.resourcedetection
: rileva automaticamente le etichette delle risorse, ad esempio il nome del cluster e l'ID progetto. Google Cloudtransform
: rinomina le etichette delle metriche che potrebbero entrare in conflitto con i campi Google Cloud delle risorse monitorate.
Ricevitori
La configurazione predefinita include solo il otlp
ricevente.
Consulta Scegliere un approccio di instrumentation per istruzioni dettagliate sull'instrumentation delle applicazioni per inviare le tracce e le metriche OTLP all'endpoint OTLP del Collector.
Passaggi successivi: raccogli e visualizza la telemetria
Questa sezione descrive come eseguire il deployment di un'applicazione di esempio, indirizzarla all'endpoint OTLP del Collector e visualizzare la telemetria inGoogle Cloud. L'applicazione di esempio è un piccolo generatore che esporta tracce, log e metriche nel Collector.
Se hai già un'applicazione instrumentata con un SDK OpenTelemetry, puoi indirizzarla all'endpoint del Collector.
Per eseguire il deployment dell'applicazione di esempio, esegui questo comando:
kubectl apply -f https://raw.githubusercontent.com/GoogleCloudPlatform/otlp-k8s-ingest/main/sample/app.yaml
Per indirizzare le applicazioni esistenti che utilizzano l'SDK OpenTelemetry all'endpoint del Collector, imposta la variabile di ambiente OTEL_EXPORTER_OTLP_ENDPOINT
su http://opentelemetry-collector.opentelemetry.svc.cluster.local:4317
.
Dopo alcuni minuti, la telemetria generata dall'applicazione inizia a essere inviata tramite il Collector alla Google Cloud console per ogni indicatore.