Configurar el rastreo en un pipeline de Buildkite

Documentos > Continuous Integration Visibility > CI Pipeline Visibility en Datadog > Configurar el rastreo en un pipeline de Buildkite

Información general

Buildkite es una plataforma de integración y despliegue continuos que te permite ejecutar compilaciones en tu propia infraestructura, lo que te da la habilidad de tener un control total sobre la seguridad y personalizar tu entorno de compilación mientras gestionas la orquestación en la nube.

Configura el rastreo en Buildkite para optimizar el uso de tus recursos, reducir la sobrecarga y mejorar la velocidad y la calidad del ciclo de vida del desarrollo de software.

Compatibilidad

Pipeline Visibility	Plataforma	Definición
Reintentos parciales	Pipelines parciales	Ve las ejecuciones de los pipelines parcialmente recuperadas.
Correlación de las métricas de la infraestructura	Correlación de las métricas de la infraestructura	Correlaciona los trabajos con las métricas del host de la infraestructura para los agentes de Buildkite.
Pasos manuales	Pasos manuales	Ve los pipelines activados manualmente.
Tiempo de cola	Tiempo de cola	Ve el tiempo que los trabajos de los pipelines permanecen en la cola antes de procesarse.
Etiquetas y medidas personalizadas en tiempo de ejecución	Etiquetas y medidas personalizadas en tiempo de ejecución	Configura etiquetas y medidas personalizadas en tiempo de ejecución.
Tramos (spans) personalizados	Tramos personalizados	Configura tramos personalizados para tus pipelines.

Configurar la integración de Datadog

Para configurar la integración de Datadog para Buildkite:

Ve a Settings > Notification Services (Configuración > Servicios de notificación) en Buildkite y haz clic en el botón Add (Añadir) junto a Datadog Pipeline Visibility (Visibilidad de los pipelines de Datadog).
Rellena el formulario con la siguiente información:
- Description (Descripción): una descripción para ayudar a identificar la integración en el futuro, como Datadog CI Visibility integration.
- API key (Clave de API): la clave de la API de Datadog.
- Datadog site (Sitio de Datadog):
- Pipelines: selecciona todos los pipelines o el subconjunto de pipelines que deseas rastrear.
- Branch filtering (Filtrado de ramas): deja este campo vacío para rastrear todas las ramas o selecciona el subconjunto de ramas que deseas rastrear.
Haz clic en Add Datadog Pipeline Visibility Notification (Añadir la notificación sobre la visibilidad de los pipelines de Datadog) para guardar la integración.

Configuración avanzada

Personalizar etiquetas

Se pueden añadir etiquetas personalizadas a las trazas (traces) de Buildkite con el comando buildkite-agent meta-data set. Cualquier etiqueta de metadato con una clave que empiece con dd_tags. se añade a los tramos del trabajo y el pipeline. Estas etiquetas pueden utilizarse para crear facetas de cadena destinadas a buscar y organizar los pipelines.

El código YAML de abajo representa un pipeline simple en el que se definieron las etiquetas para el nombre del equipo y la versión de Go.

steps:
  - command: buildkite-agent meta-data set "dd_tags.team" "backend"
  - command: go version | buildkite-agent meta-data set "dd_tags.go.version"
    label: Go version
  - commands: go test ./...
    label: Run tests

Las siguientes etiquetas se muestran en el tramo raíz, así como en el tramo del trabajo correspondiente en Datadog.

team: backend
go.version: go version go1.17 darwin/amd64 (la salida depende del ejecutor)

El pipeline resultante tiene el siguiente aspecto:

La traza de un pipeline de Buildkite con etiquetas personalizadas.

Cualquier metadato con una clave que empiece con dd-measures. y contenga un valor numérico se establecerá como la etiqueta de una métrica que puede utilizarse para crear medidas numéricas.

Puedes utilizar el comando buildkite-agent meta-data set para crear estas etiquetas.

Por ejemplo, puedes medir el tamaño binario en un pipeline con este comando:

steps:
  - commands:
    - go build -o dst/binary .
    - ls -l dst/binary | awk '{print \$5}' | tr -d '\n' | buildkite-agent meta-data set "dd_measures.binary_size"
    label: Go build

El pipeline resultante tendrá las etiquetas que se muestran abajo en el tramo del pipeline:

binary_size: 502 (la salida depende del tamaño del archivo)

En este ejemplo, puedes utilizar el valor de binary_size para graficar el cambio en el tamaño binario a lo largo del tiempo.

Correlacionar las métricas de la infraestructura con los trabajos

Si utilizas agentes de Buildkite, puedes correlacionar los trabajos con la infraestructura que los ejecuta. Para que esta característica funcione, instala el Datadog Agent en los hosts que ejecutan los agentes de Buildkite.

Ver los pipelines parciales y descendentes

Puedes utilizar los siguientes filtros para personalizar tu consulta de búsqueda en el explorador de CI Visibility.

La página de ejecuciones del pipeline con la expresión Partial Pipeline:retry ingresada en la consulta de búsqueda.

Nombre de la faceta	ID de la faceta	Valores posibles
Pipeline descendente	`@ci.pipeline.downstream`	`true`, `false`
Activación manual	`@ci.is_manual`	`true`, `false`
Pipeline parcial	`@ci.partial_pipeline`	`retry`, `paused`, `resumed`

También puedes aplicar estos filtros mediante el panel de facetas situado en la parte izquierda de la página.

El panel de facetas con la faceta Partial Pipeline expandida y el valor Retry seleccionado, la faceta Partial Retry expandida y el valor true seleccionado.

Visualizar los datos de los pipelines en Datadog

Las páginas CI Pipeline List (Lista de pipelines de CI) y Executions (Ejecuciones) se rellenan con datos una vez finalizados los pipelines.

En la página CI Pipeline List (Lista de pipelines de CI), se muestran datos solo para la rama predeterminada de cada repositorio. Para obtener más información, consulta Buscar y gestionar los pipelines de CI.