View a markdown version of this page

Configurazione OpenTelemetry per GitHub Copilot - Amazon CloudWatch

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Configurazione OpenTelemetry per GitHub Copilot

GitHub Copilot emette metriche OpenTelemetry (OtEL) sull'utilizzo dei token, sulle richieste, sulle chiamate agli strumenti e sulla latenza. Quando invii queste metriche ad Amazon CloudWatch, vengono inserite nella scheda GitHub Copilot delle dashboard di Coding Agent Insights. Per ulteriori informazioni sui pannelli di controllo, consulta. Informazioni sugli agenti di codifica

Copilot invia le metriche OTLP direttamente all'endpoint CloudWatch nativo delle metriche OTLP e si autentica con un token bearer (una chiave API di metrica). CloudWatch OpenTelemetry Non è richiesto alcun raccoglitore. Il token bearer è oggi il percorso supportato da Copilot.

Nota

Questa guida spiega solo come emettere le metriche OTel di Copilot verso CloudWatch, indipendentemente dal modo in cui Copilot chiama un modello per l'inferenza. Copilot utilizza i propri modelli per impostazione predefinita, ma le aziende possono utilizzare le proprie chiavi del provider di modelli, tra cui Amazon Bedrock. Per ulteriori informazioni, consulta Utilizzare le proprie chiavi API nella documentazione di Copilot. GitHub

Importante

I token Bearer sono credenziali a lungo termine. Li consigliamo solo laddove non sia possibile utilizzare AWS credenziali a breve termine, ad esempio quando si utilizzano computer portatili per sviluppatori esterni. AWS Per i compromessi in materia di sicurezza e le indicazioni sulla rotazione dei tasti, consulta. Configurazione dell'autenticazione con token al portatore per Metrics

Prerequisiti

  • GitHub Copilot installato, su una versione che supporta l'esportazione delle metriche. OpenTelemetry

  • Un abbonamento attivo a GitHub Copilot per l'inferenza dei modelli. Copilot utilizza i propri modelli per impostazione predefinita; per utilizzare invece Amazon Bedrock, configura una chiave modello personalizzata come descritto in Usa le tue chiavi API nella documentazione di Copilot. GitHub

  • Una chiave API per CloudWatch le metriche (token bearer), creata da un utente IAM che dispone delle autorizzazioni per le metriche. CloudWatch Per la procedura che crea l'utente IAM e genera la chiave, consulta. Configurazione dell'autenticazione con token al portatore per Metrics

Configura l'esportatore di metriche

Configura l' OpenTelemetry esportatore di Copilot per inviare le metriche all'endpoint delle metriche con il token CloudWatch bearer nell'intestazione. Authorization Imposta le seguenti variabili di ambiente nell'ambiente che avvia Copilot. Impostare per l'COPILOT_OTEL_ENABLED=trueaccensione. OpenTelemetry Copilot utilizza le OpenTelemetry variabili standard per tutti i segnali; non supporta sostituzioni specifiche delle metriche. Imposta sull'endpoint OTEL_EXPORTER_OTLP_ENDPOINT di base senza il percorso: l'esportatore aggiunge il /v1/metrics percorso del segnale per te.

export COPILOT_OTEL_ENABLED=true export OTEL_EXPORTER_OTLP_ENDPOINT="https://monitoring.region.amazonaws.com" export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer YOUR_API_KEY"
Nota

Considera il gettone portatore come un segreto. Evitate di affidarlo al controllo del codice sorgente o ai profili di shell condivisi e ruotate periodicamente la chiave come descritto in. Configurazione dell'autenticazione con token al portatore per Metrics

Aggiungi attributi identitari e organizzativi

Il pannello di controllo di Coding Agent Insights illustra l'utilizzo dei gruppi per sviluppatore, team, reparto e altre dimensioni organizzative. Forniscili come attributi di risorsa OTel tramite la variabile di OTEL_RESOURCE_ATTRIBUTES ambiente. Imposta i valori dell'identità del tuo sviluppatore e della struttura della tua organizzazione.

export OTEL_RESOURCE_ATTRIBUTES="\ user.id=alias,\ user.email=developer@example.com,\ user.name=Jane Doe,\ department=engineering,\ team.id=platform,\ cost_center=cc-1234,\ organization=example-corp,\ location=us-seattle,\ role=software-engineer,\ manager=manager@example.com"

Verifica e visualizza

Usa Copilot per generare metriche, quindi conferma i dati raggiunti. CloudWatch

Per verificare le metriche
  1. Utilizzate Copilot per eseguire alcune operazioni che generano telemetria.

  2. Nella CloudWatch console, scegli GenAI Observability, Coding Agent Insights, quindi la scheda Copilot. GitHub Le metriche vengono in genere visualizzate entro pochi minuti.

  3. Facoltativamente, interroga le metriche direttamente con PromQL. Per ulteriori informazioni, consulta Interrogazione ProMQL.