View a markdown version of this page

Configuración de OpenTelemetry para GitHub Copilot - Amazon CloudWatch
Requisitos previosConfiguración del exportador de métricasCómo agregar atributos de identidad y de la organizaciónComprobación y visualización

Configuración de OpenTelemetry para GitHub Copilot

GitHub Copilot emite métricas de OpenTelemetry (OTel) sobre el uso de tokens, las solicitudes, las llamadas a herramientas y la latencia. Cuando estas métricas se envían a Amazon CloudWatch, aparecen en la pestaña GitHub Copilot de los paneles de Información del agente de codificación. Para obtener más información acerca de los paneles, consulte Información de agentes de codificación.

Copilot envía las métricas de OTLP directamente al punto de conexión nativo de métricas de OTLP de CloudWatch y se autentica mediante un token de portador, es decir, una clave de API de métricas de CloudWatch. No se requiere ningún recopilador de OpenTelemetry. Actualmente, el token de portador es la ruta compatible con Copilot.

nota

Esta guía solo explica cómo enviar las métricas de OTel de Copilot a CloudWatch, lo cual es independiente de la forma en que Copilot llama a un modelo para realizar inferencias. De forma predeterminada, Copilot utiliza sus propios modelos, pero las empresas pueden usar sus propias claves de proveedores de modelos, incluido Amazon Bedrock. Para obtener más información, consulte Uso propias claves de API propias en la documentación de GitHub Copilot.

importante

Los tokens de portador son credenciales de larga duración. Solo recomendamos su uso cuando no resulte viable utilizar credenciales de AWS de corta duración, como en los equipos portátiles de los desarrolladores que se encuentran fuera de AWS. Para obtener información sobre las ventajas y desventajas de seguridad y las recomendaciones para la rotación de claves, consulte Configurar la autenticación por token de portador para métricas.

Requisitos previos

  • GitHub Copilot instalado en una versión compatible con la exportación de métricas de OpenTelemetry.

  • Una suscripción activa a GitHub Copilot para la inferencia de modelos. Copilot utiliza sus propios modelos de forma predeterminada. Para usar Amazon Bedrock en su lugar, configure una clave de modelo personalizada como se describe en Uso de claves de API propias en la documentación de GitHub Copilot.

  • Una clave de API de métricas de CloudWatch (token de portador), creada a partir de un usuario de IAM con permisos para las métricas de CloudWatch. Para consultar el procedimiento de creación del usuario de IAM y generación de la clave, consulte Configurar la autenticación por token de portador para métricas.

Configuración del exportador de métricas

Configure el exportador de OpenTelemetry de Copilot para enviar métricas al punto de conexión de métricas de CloudWatch con el token de portador en el encabezado Authorization. Establezca las siguientes variables de entorno en el entorno desde el que se lanza Copilot. Establezca COPILOT_OTEL_ENABLED=true para habilitar OpenTelemetry. Copilot utiliza las variables estándar de OpenTelemetry para todas las señales. No admite anulaciones específicas para las métricas. Establezca OTEL_EXPORTER_OTLP_ENDPOINT en el punto de conexión base sin la ruta /v1/metrics. El exportador agrega automáticamente la ruta de la señal.

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

Trate el token de portador como un secreto. Evite confirmar el token en el control de código fuente o en perfiles compartidos del intérprete de comandos, y rote la clave periódicamente como se describe en Configurar la autenticación por token de portador para métricas.

Cómo agregar atributos de identidad y de la organización

Los paneles de información del agente de codificación agrupan el uso por desarrollador, equipo, departamento y otras dimensiones de la organización. Proporcione estos datos como atributos de recurso de OTel mediante la variable de entorno OTEL_RESOURCE_ATTRIBUTES. Establezca los valores según la identidad del desarrollador y la estructura de la organización.

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"

Comprobación y visualización

Use Copilot para generar métricas y, a continuación, confirme que los datos llegaron a CloudWatch.

Verificación de las métricas

  1. Use Copilot para realizar alguna tarea que genere telemetría.

  2. En la consola de CloudWatch, elija Observabilidad de IA generativa, Información del agente de codificación y, a continuación, la pestaña GitHub Copilot. Por lo general, las métricas aparecen en unos minutos.

  3. De manera opcional, consulte las métricas directamente con PromQL. Para obtener más información, consulte Consultas PromQL.