Plugin de Datadog para entornos de desarrollo integrados de JetBrains
El complemento de Datadog para IDEs de JetBrains ayuda a mejorar el rendimiento de software al proporcionar información del código en el IDE basado en datos de observabilidad en tiempo real. El complemento es para desarrolladores que usan productos de Datadog incluidos Log Explorer, Error Tracking, Live Debugger, Continuous Profiler, Code Security, Test Optimization y CI Visibility para monitorizar sus servicios. Está disponible para IntelliJ IDEA, GoLand, PyCharm, WebStorm y PhpStorm.
La integración de Logs muestra logs observados en el editor de código fuente y ofrece enlaces al Log Explorer para ver logs generados por una línea de código específica.
La característica Code Insights ayuda a encontrar y corregir errores de tiempo de ejecución desde Error Tracking, biblioteca y vulnerabilidades de código de tiempo de ejcución desde Code Security, tests flaky tests detectados por Test Optimization y más.
El Live Debugger te permite capturar información de depuración vital al añadir logs temporales a tu código de tiempo de ejecución y sin tener que detener e iniciar tu servicio o aplicación.
El Continuous Profiler te ayuda a reducir la latencia y disminuir los costes de nube al destacar el código que usa el mayor tiempo de CPU, asigna la mayor memoria, activa las mayores excepciones o consume altas cantidades de otros recursos.
La característica CI Test Runs abre el CI Visibility Explorer para mostrar las ejecuciones recientes de cualquier test.
El motor Static Analysis, que se ejecuta localmente, analiza tu código con las reglas predefinidas para detectar y corregir problemas antes de confirmar los cambios.
Requisitos
- Una cuenta de Datadog: el complemento requiere una cuenta de Datadog (excepto cuando usa características de Static Analysis). Si eres nuevo en Datadog, ve al sitio web de Datadog para obtener más información sobre las herramientas de observabilidad de Datadog e iniciar sesión para un periodo de prueba gratuito.
- Continuous Profiler: para mostrar los datos e información de perfil, el complemento requiere que se configure el Continuous Profiler para tus servicios. Para obtener más información, consulta Empezando con el Continuous Profiler.
Configuración
Instala el complemento de Datadog
- Haz clic en Plugins (Complementos) y busca
Datadog. - Haz clic en Install (Instalar) para descargar e instalar el complemento en tu IDE.
- Si recibes una indicación que te notifica que Datadog es un complemento externo, haz clic en Accept (Aceptar).
- Haz clic en Restart IDE (Reiniciar IDE).
De forma alternativa, puedes instalar el complemento desde el JetBrains Marketplace.
Inicia sesión en Datadog
Después de instalar el complemento de Datadog y reiniciar el IDE, inicia sesión en Datadog:
- Con un archivo o proyecto abierto en el IDE, haz clic en la ventana de la herramienta de Datadog.
- Haz clic en Log in… (Iniciar sesión…).
- En la ventana del navegador que se abre, selecciona tu sitio y organización y, luego, autoriza el acceso a la plataforma.
Nota: Para la mayoría de los usuarios, solo se requiere un inicio de sesión. Si estás utilizando una configuración de varias organizaciones, asegúrate de que la cuenta correcta está activa. Para saber qué nombre de usuario está utilizando tu entorno de desarrollo integrado, haz clic en Settings* -> Tools -> Datadog (Configuración -> Herramientas -> Datadog), y comprueba qué cuenta está activa.
Vincular un servicio
Para proporcionar los datos relevantes de la plataforma de Datadog, añade servicios relacionados a tu proyecto:
- Con tu proyecto abierto en el IDE, abre la ventana de la herramienta Datadog y selecciona Manage Linked Services… (Administrar servicios vinculados…) del menú Options (Opciones).
- Se abre un cuadro de diálogo, haz clic en el ícono más (+).
- Busca y selecciona los servicios que deseas añadir al proyecto actual.
Para eliminar un servicio, selecciónalo en la tabla Services (Servicios) y haz clic en el ícono menos (-).
Los nombres de los servicios vinculados persisten con el proyecto cuando lo cierras.
Los patrones de log de Datadog se emparejan directamente con las líneas de código en tu editor para tus archivos fuente de Java, JavaScript, TypeScript, Go y Python:
Una ventana emergente muestra los valores de ejecución de las entradas de log:
Haz clic en el icono de log para abrir el Log Explorer en Datadog con una consulta precargada que coincida lo más posible con el nombre del registrador, el nivel de log y el mensaje de log:
La pestaña Code Insights (Información del código) muestra información generada por la plataforma de Datadog que es relevante para tu proyecto actual. Los datos se agrupan en tres categorías: rendimiento, fiabilidad y seguridad.
La Información del código incluye una descripción detallada de cada problema y enlaces a:
- La localización de código fuente correspondiente
- La plataforma de Datadog para más información
Puedes descartar información individual y establecer filtros para ver las categorías de información que te interesen.
Live Debugger
El Live Debugger te permite añadir puntos de log (puntos de interrupción que expiran automáticamente y no se rompen) a tu código en tiempo de ejecución para recopilar información para la depuración.
Más información en la documentación de Live Debugger.
Continuous Profiler
El Continuous Profiler destaca el consumo de recursos (como CPU, asignación de memoria y excepciones lanzadas) utilizando datos de perfiles recopilados de servicios desplegados. Esta información ayuda a los desarrolladores a escribir código más eficiente y eliminar cuellos de botella.
Más información en la documentación de Continuous Profiler.
Ejecución de tests de CI
Puedes ver las ejecuciones recientes de tests en CI Visibility Explorer navegando directamente desde tus archivos fuente. Busca las incrustaciones CI Test Run encima de las declaraciones de métodos de test en tu código fuente:
Al hacer clic en el enlace, se abre la pestaña Test Runs (Ejecuciones de test), que muestra el historial reciente de un caso de test.
Ver en entorno de desarrollo integrado
La función View in IDE (Ver en entorno de desarrollo integrado) proporciona un enlace desde la plataforma de Datadog directamente a los archivos fuente en tu entorno de desarrollo integrado. Busca el botón junto a los marcos en stack traces que se muestra en la plataforma (por ejemplo, en Rastreo de errores):
Un requisito previo para aprovechar al máximo esta función es que la integración de código fuente esté configurada para tu servicio.
Análisis estático
El plugin de Datadog ejecuta reglas de Análisis estático en tus archivos fuente mientras los editas. El objetivo es detectar y corregir problemas de mantenimiento, errores o vulnerabilidades de seguridad en el código antes de confirmar los cambios.
El Análisis estático admite la exploración de muchos lenguajes de programación. Si deseas consultar la lista completa, consulta Reglas del análisis estático. Para los tipos de archivos pertenecientes a los lenguajes compatibles, los problemas se muestran en el editor de código fuente con el sistema de inspección JetBrains, y las correcciones sugeridas se pueden aplicar directamente:
Además, todos los problemas detectados por esta función se enumeran en la vista estándar Problems (Problemas).
Empezando
Cuando empieces a editar un archivo fuente admitido por el Análisis estático, el plugin comprueba static-analysis.datadog.yml en la raíz de tu repositorio fuente. Te pedirá que crees el archivo si es necesario:
Una vez creado el archivo de configuración, el analizador estático se ejecuta automáticamente en segundo plano.
La función de Análisis estático no requiere una cuenta en Datadog, ya que los archivos fuente se analizan localmente.
Comentarios
Puedes darnos tu opinión en el foro de debate, o enviar un correo electrónico a team-ide-integration@datadoghq.com.
Datos y telemetría
Datadog recopila información sobre el uso que haces de este IDE, incluyendo cómo interactúas con él, si se han producido errores durante su uso y cuál ha sido la causa de dichos errores, de acuerdo con la Política de privacidad de Datadog y EULA de Datadog.
Si no deseas enviar estos datos a Datadog, puedes desactivar la recopilación en cualquier momento en los ajustes: Settings > Tools > Datadog > Data Sharing y desactivar la opción Send usage statistics.
Referencias adicionales
Más enlaces, artículos y documentación útiles:
