GitHub

Información general

Instala la integración de GitHub para configurar GitHub Apps y GitHub Actions, proteger el acceso a tus repositorios y recopilar telemetría avanzada (como logs de auditoría, informes de vulnerabilidad, escaneo de secretos y estadísticas de repositorios).

La pestaña Configuración del repositorio en el cuadro de integración de GitHub

Puedes usar la integración de código fuente de Datadog a fin de ver fragmentos de código en tus stack traces, vincular stack traces al código fuente en GitHub para tus funciones de Lambda, mostrar resúmenes de resultados de tests de los comentarios de solicitudes pull en CI Visibility y acceder a diferentes definiciones de servicio en GitHub desde Service Catalog.

Configurar

Sigue estas instrucciones para instalar GitHub Apps y otorgar permisos a Datadog. En función de los permisos otorgados, puedes configurar la integración de código fuente, ver fragmentos de código en las stack traces, ver la telemetría recopilada, como los logs de auditoría, acceder a GitHub Actions en CI Visibility y más.

Vincular un repositorio en tu organización o cuenta personal

Si eres administrador en tu organización de GitHub, puedes configurar GitHub Apps.

En el cuadro de integración de GitHub, dirígete a la pestaña Repo Configuration (Configuración del repositorio).
Haz clic en Link GitHub Account (Vincular cuenta de GitHub) para crear una GitHub App nueva.
En Configure (Configurar), selecciona Organization (Organización) e ingresa un nombre para la organización, o selecciona Personal Account (Cuenta personal).
De manera opcional, especifica la URL de tu instancia de GitHub Enterprise Server (versión 2.22 o posterior) y asegúrate de que los servidores de Datadog puedan conectarse a tu instancia de Enterprise. Las direcciones IP de los servidores se encuentran disponibles en la sección Webhooks de Rangos de IP.
En Edit Permissions (Editar permisos), habilita los permisos de lectura de Datadog para problemas, solicitudes pull y contenidos. Debes seleccionar al menos un permiso.
Haz clic en Create App in GitHub (Crear aplicación en GitHub), luego se te solicitará que ingreses un nombre de GitHub App en GitHub.
Ingresa un nombre en el campo nombre de GitHub App y haz clic en Create GitHub App (Crear GitHub App).
En la pestaña Configuration (Configuración), haz clic en Install GitHub App (Instalar GitHub App) e Install & Authorize (Instalar y autorizar).

Tu GitHub App se muestra en el cuadro de integración. Para habilitar fragmentos de código en línea en las stack traces, consulta la Configuración de la integración de código fuente.

Notebooks

Si has concedido permisos de lectura para problemas y solicitudes pull a tu GitHub App, estos generarán de manera automática un cuadro flotante de vista previa con detalles que incluyen el historial de confirmaciones, el autor y la fecha en Notebooks.

Dirígete a Notebooks > New Notebook (Notebook nuevo).
Añade una celda de texto y menciona un problema o solicitud pull en GitHub en el campo Edit (Editar), por ejemplo: https://github.com/project/repository/pull/#.
Haz clic en Done (Listo) y, a continuación, aparecerá el icono de GitHub junto al problema o solicitud pull vinculados.
Haz clic en Connect to Preview (Conectar a la vista previa) y Authorize (Autorizar).
Coloca el cursor sobre la solicitud pull o problema vinculado para ver la vista previa de la descripción.

Logs de auditoría

Los logs de auditoría abarcan todas las actividades y eventos de una organización de GitHub. Tras la instalación de una aplicación, permite que los permisos de administración de la organización tengan acceso de lectura. Esto permite que la aplicación comience a recopilar el flujo de auditoría de GitHub como logs en nombre de la organización de GitHub.

Nota: Se requiere una cuenta de GitHub Enterprise para recopilar logs de auditoría.

Sigue las instrucciones en la Configuración de la transmisión a Datadog en la documentación de GitHub para reenviar tus logs de auditoría a Datadog. A fin de obtener más información sobre los logs de auditoría, consulta la documentación de GitHub para Acciones de log de auditoría.

Datos recopilados

Métricas

La integración de GitHub recopila métricas de alertas de escaneo de código y de secretos. Estas métricas proporcionan información general sobre el estado de alerta de la organización al categorizar su estado, repositorio y tipo de secreto. También proporcionan información a largo plazo sobre las tendencias de alerta y su progreso general.

github.code_scan_alert (gauge)	Github Code Scan Alerts Shown as alert
github.secret_scan_alert (gauge)	Github Secret Scan Alerts Shown as alert

A fin de empezar a recopilar estas métricas, selecciona los permisos correspondientes para el acceso de lectura al instalar la aplicación. Para inhabilitar las métricas de escaneo de código o de secretos, busca la organización correspondiente en la pestaña Telemetery (Telemetría) en el cuadro de integración, haz clic en el botón de alternancia de las secciones respectivas y haz clic en Update Account (Actualizar cuenta).

Eventos

Sigue estas instrucciones para configurar webhooks en GitHub y Datadog, lo que permite que los eventos aparezcan en el Events Explorer.

Añadir un webhook en GitHub

En tu proyecto de GitHub, dirígete a Settings (Configuración) > Webhooks.
Haz clic en Add webhook (Añadir webhook).
Añade la siguiente URL en el campo Payload URL (URL de carga útil): https:///intake/webhook/github?api_key=<DATADOG_API_KEY>. No olvides reemplazar <DATADOG_API_KEY> con tu clave de API de Datadog.
Selecciona application/json en el menú desplegable Content type (Tipo de contenido).
De manera opcional, añade un secreto en el campo Secret (Secreto).

En la sección Which events would you like to trigger this webhook? (¿Qué eventos te gustaría que activen este webhook?), haz clic en Let me select individual events. (Permíteme seleccionar eventos individuales.) y selecciona una de las siguientes opciones compatibles para enviar eventos a Datadog:

Nombre del evento	Acciones del evento
Creación de rama o etiqueta (tag)
Comentarios de confirmación
Comentarios del problema	Se admiten las siguientes acciones: - `created` - `deleted` - `edited`
Problemas	Se admiten las siguientes acciones: - `assigned` - `closed` - `deleted` - `demilestoned` - `edited` - `labeled` - `locked` - `milestoned` - `opened` - `pinned` - `reopened` - `transferred` - `unassigned` - `unlabeled` - `unlocked` - `unpinned`
Comentarios de revisión de la solicitud pull	Se admiten las siguientes acciones: - `created` - `deleted` - `edited`
Solicitudes pull	Se admiten las siguientes acciones: - `assigned` - `unassigned` - `labeled` - `unlabeled` - `opened` - `edited` - `closed` - `reopened` - `synchronize` - `converted_to_draft` - `locked` - `unlocked` - `enqueued` - `dequeued` - `milestoned` - `demilestoned` - `ready_for_review` - `review_requested` - `review_request_removed` - `auto_merge_enabled` - `auto_merge_disabled`
Pushes
Repositorios	Se admiten las siguientes acciones: - `archived` - `created` - `deleted` - `edited` - `privatized` - `publicized` - `renamed` - `transferred` - `unarchived`
Seguridad y análisis
Adiciones del equipo

Selecciona Active (Activo) para recibir detalles del evento cuando se active el enlace.
Haz clic en Add webhook (Añadir webhook) para guardar el webhook.

Añadir un webhook en Datadog

En el cuadro de integración de GitHub, dirígete a la pestaña Webhooks.
Especifica los repositorios y las ramas que quieres monitorizar para cada repositorio. Para añadir todos los repositorios de un usuario u organización, usa comodines (*). Puedes usar comodines en los nombres de las ramas. Por ejemplo, dev-* incluye todas las ramas que comienzan con dev-.
Para reunir todos los eventos relacionados con la rama master del repositorio de GitHub DataDog/documentation, puedes ingresar DataDog/documentation en el campo Repository (Repositorio) y master en el campo Branches (Ramas).
Si quieres recopilar todos los eventos relacionados con todas las ramas master de la organización de Datadog, ingresa DataDog/* en el campo Repository (Repositorio) y master en el campo Branches (Ramas). Nota: Cuando se usa un comodín para el nombre de repositorio, se debe especificar el usuario o la organización. Por ejemplo, «» no es un nombre de repositorio válido, pero «DataDog/» sí lo es.
Haz clic en las casillas de verificación de Commits (Confirmaciones) e Issues (Problemas) para recibir alertas sobre estos eventos.
Haz clic en Update Configuration (Actualizar configuración) para guardar la configuración del webhook.

Una vez que hayas añadido webhooks en la pestaña Webhooks en el cuadro de integración, los eventos en los repositorios de GitHub que especificaste anteriormente empiezan a aparecer en el Events Explorer. Para obtener más información, consulta la documentación del Events Explorer.

Para filtrar eventos provenientes de GitHub, selecciona Github en el menú de la faceta Source (Fuente) en Core (Núcleo), o ingresa source:github en la consulta de búsqueda. La gráfica de barras de los eventos se actualiza de manera automática a medida que editas la consulta de búsqueda.