Instrumentando Internals de Node.js

Rate this content
Bookmark

Cuando se solucionan problemas en aplicaciones complejas de Node.js, siempre es útil recopilar información sobre la red, el sistema de archivos o las dependencias externas. Incluso al trabajar con una nueva base de código, es importante tener información sobre cómo se construye la aplicación, qué llamadas asíncronas se están utilizando y con qué frecuencia. En esta charla, quiero presentar "instrument", una herramienta que he creado para esto y que también es de código abierto.

7 min
24 Jun, 2021

Video Summary and Transcription

La charla trata sobre la solución de problemas en aplicaciones de Node.js y el uso de una herramienta para mejorar la visibilidad y obtener información. La herramienta puede recopilar información sobre las URL y las importaciones de módulos en un servidor. Sin embargo, no se recomienda su uso en entornos no locales debido a la sobrecarga de rendimiento y posibles errores.

Available in English

1. Troubleshooting Node.js Applications

Short description:

Mi charla trata sobre la solución de problemas de aplicaciones Node.js. Intentaré descomponer las partes de la aplicación para identificar el problema. Desarrollé una herramienta que proporciona una mayor visibilidad e información útil. Se puede utilizar para recopilar información sobre las URL utilizadas por una aplicación Node.js e identificar las importaciones de módulos en un servidor. Sin embargo, no se recomienda utilizar esta herramienta en entornos no locales debido a la sobrecarga de rendimiento y posibles errores.

¡Hola a todos! Antes de continuar, primero quiero agradecer a todos los organizadores y voluntarios que hicieron esto posible, dedicaron su tiempo y también me dieron la oportunidad de presentarles hoy. Mi charla trata sobre la solución de problemas de aplicaciones Node.js.

Antes de eso, una pequeña introducción sobre mí. Soy Alejandro. Soy de Buenos Aires, Argentina. Trabajo como ingeniero de backend en X-Team y también contribuyo con un par de comunidades, Entonces, en el tema de esta charla, supongamos que tienes una aplicación Node.js que se está ejecutando, pero algo no funciona. No hay ninguna excepción. No tienes registros. ¿Por dónde empezarías? Lo que intentaría hacer es descomponer las partes de la aplicación para identificar más fácilmente dónde está exactamente el problema. Supongamos que es un servidor, verificaría la parte de inicio del proceso. Un punto de interrupción justo después de que se inicialice para ver si el error ocurre antes o después de eso.

Muchas veces estaría en el proceso de solución de problemas de una aplicación y pensaría que no tengo idea de por qué está sucediendo eso. Sería como este perro. Así que muchas veces, esto también sucedería en mi entorno de desarrollo, donde tengo control total, acceso total y también debería tener una buena observabilidad sobre lo que está sucediendo. Esta última parte fue una de las motivaciones que tuve para trabajar en una herramienta que prácticamente sin cambios en su aplicación podría permitir una mayor visibilidad y potencialmente convertirte en Ironman, como en esta escena. Ver mucha información útil de una vez. Repasaré algunos ejemplos específicos que se me ocurrieron en una demostración corta. En el escenario número uno, imagina que tienes un script o una aplicación que se está ejecutando a través de Node. Queremos poder saber si está utilizando la red y, en ese caso, recopilar más información sobre qué URL está utilizando y posiblemente más información al respecto. Así que vamos a mi demostración y para esto digamos que queremos intentar hacer eso con NPM. Y vamos a intentar obtener la última versión de un paquete, en este caso Mocha. Obtenemos el resultado 802.1. Digamos que queríamos hacer eso con esta herramienta con NPM podemos requerir instrumento pasar los mismos argumentos que estábamos pasando antes y en primer lugar veremos la misma salida que antes 802.1 y y después un resumen breve de la herramienta. En este caso, para estos dos módulos nativos que están habilitados HTTP y HTTPS. Específicamente, estos dos están configurados aquí en la lista de módulos. y también puedes agregar otros como FS, Require y otros también. Esta configuración se agrega en la parte instrument.config.js. Así que podemos ver que esto se dirige a registry.npmjs.org. Vemos que el método es get en los encabezados user agent npm en CI y demás. Así que todo lo que tuve que hacer para requerir esa herramienta es agregarla como una dependencia de desarrollo.

Para otro ejemplo, supongamos que estás refactorizando un servidor HTTP y quieres identificar qué archivos están importando el módulo A.js. El módulo solo se carga dinámicamente mediante una sonda específica en tu servidor. Y en este caso, sería prácticamente imposible hacer esta tarea con análisis estático. Tendrías que instrumentar tu aplicación o tu servidor para obtener esa información. Entonces, al agregar el módulo requerido en la lista que vimos anteriormente, también podrías obtener esa información utilizando esta herramienta.

Un pequeño detalle sobre esto y una recomendación si debes ejecutar esto en otros entornos que no sean tus entornos locales y la respuesta es no, definitivamente no. Hay una sobrecarga de rendimiento al agregar esta instrumentación y estoy seguro de que encontrarás algunos errores si lo pruebas por tu cuenta, por lo que no se recomienda hacerlo. Puedes encontrar esta herramienta en GitHub y ver el código, ver un problema abierto, una solicitud de extracción, y si tienes más preguntas sobre cómo se hace esto u otras preguntas técnicas, realizaremos una sesión de preguntas y respuestas o no dudes en enviarlas a través de las redes sociales, twitter. Eso es todo lo que tenía para ustedes hoy. Muchas gracias.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

Node Congress 2022Node Congress 2022
26 min
It's a Jungle Out There: What's Really Going on Inside Your Node_Modules Folder
Top Content
Do you know what’s really going on in your node_modules folder? Software supply chain attacks have exploded over the past 12 months and they’re only accelerating in 2022 and beyond. We’ll dive into examples of recent supply chain attacks and what concrete steps you can take to protect your team from this emerging threat.
You can check the slides for Feross' talk here.
Node Congress 2022Node Congress 2022
34 min
Out of the Box Node.js Diagnostics
In the early years of Node.js, diagnostics and debugging were considerable pain points. Modern versions of Node have improved considerably in these areas. Features like async stack traces, heap snapshots, and CPU profiling no longer require third party modules or modifications to application source code. This talk explores the various diagnostic features that have recently been built into Node.
You can check the slides for Colin's talk here. 
JSNation 2023JSNation 2023
22 min
ESM Loaders: Enhancing Module Loading in Node.js
Native ESM support for Node.js was a chance for the Node.js project to release official support for enhancing the module loading experience, to enable use cases such as on the fly transpilation, module stubbing, support for loading modules from HTTP, and monitoring.
While CommonJS has support for all this, it was never officially supported and was done by hacking into the Node.js runtime code. ESM has fixed all this. We will look at the architecture of ESM loading in Node.js, and discuss the loader API that supports enhancing it. We will also look into advanced features such as loader chaining and off thread execution.
JSNation Live 2021JSNation Live 2021
19 min
Multithreaded Logging with Pino
Top Content
Almost every developer thinks that adding one more log line would not decrease the performance of their server... until logging becomes the biggest bottleneck for their systems! We created one of the fastest JSON loggers for Node.js: pino. One of our key decisions was to remove all "transport" to another process (or infrastructure): it reduced both CPU and memory consumption, removing any bottleneck from logging. However, this created friction and lowered the developer experience of using Pino and in-process transports is the most asked feature our user.In the upcoming version 7, we will solve this problem and increase throughput at the same time: we are introducing pino.transport() to start a worker thread that you can use to transfer your logs safely to other destinations, without sacrificing neither performance nor the developer experience.

Workshops on related topic

Node Congress 2023Node Congress 2023
109 min
Node.js Masterclass
Workshop
Have you ever struggled with designing and structuring your Node.js applications? Building applications that are well organised, testable and extendable is not always easy. It can often turn out to be a lot more complicated than you expect it to be. In this live event Matteo will show you how he builds Node.js applications from scratch. You’ll learn how he approaches application design, and the philosophies that he applies to create modular, maintainable and effective applications.

Level: intermediate
Node Congress 2023Node Congress 2023
63 min
0 to Auth in an Hour Using NodeJS SDK
WorkshopFree
Passwordless authentication may seem complex, but it is simple to add it to any app using the right tool.
We will enhance a full-stack JS application (Node.JS backend + React frontend) to authenticate users with OAuth (social login) and One Time Passwords (email), including:- User authentication - Managing user interactions, returning session / refresh JWTs- Session management and validation - Storing the session for subsequent client requests, validating / refreshing sessions
At the end of the workshop, we will also touch on another approach to code authentication using frontend Descope Flows (drag-and-drop workflows), while keeping only session validation in the backend. With this, we will also show how easy it is to enable biometrics and other passwordless authentication methods.
Table of contents- A quick intro to core authentication concepts- Coding- Why passwordless matters
Prerequisites- IDE for your choice- Node 18 or higher
JSNation 2023JSNation 2023
104 min
Build and Deploy a Backend With Fastify & Platformatic
WorkshopFree
Platformatic allows you to rapidly develop GraphQL and REST APIs with minimal effort. The best part is that it also allows you to unleash the full potential of Node.js and Fastify whenever you need to. You can fully customise a Platformatic application by writing your own additional features and plugins. In the workshop, we’ll cover both our Open Source modules and our Cloud offering:- Platformatic OSS (open-source software) — Tools and libraries for rapidly building robust applications with Node.js (https://oss.platformatic.dev/).- Platformatic Cloud (currently in beta) — Our hosting platform that includes features such as preview apps, built-in metrics and integration with your Git flow (https://platformatic.dev/). 
In this workshop you'll learn how to develop APIs with Fastify and deploy them to the Platformatic Cloud.
JSNation Live 2021JSNation Live 2021
156 min
Building a Hyper Fast Web Server with Deno
WorkshopFree
Deno 1.9 introduced a new web server API that takes advantage of Hyper, a fast and correct HTTP implementation for Rust. Using this API instead of the std/http implementation increases performance and provides support for HTTP2. In this workshop, learn how to create a web server utilizing Hyper under the hood and boost the performance for your web apps.
React Summit 2022React Summit 2022
164 min
GraphQL - From Zero to Hero in 3 hours
Workshop
How to build a fullstack GraphQL application (Postgres + NestJs + React) in the shortest time possible.
All beginnings are hard. Even harder than choosing the technology is often developing a suitable architecture. Especially when it comes to GraphQL.
In this workshop, you will get a variety of best practices that you would normally have to work through over a number of projects - all in just three hours.
If you've always wanted to participate in a hackathon to get something up and running in the shortest amount of time - then take an active part in this workshop, and participate in the thought processes of the trainer.
TestJS Summit 2023TestJS Summit 2023
78 min
Mastering Node.js Test Runner
Workshop
Node.js test runner is modern, fast, and doesn't require additional libraries, but understanding and using it well can be tricky. You will learn how to use Node.js test runner to its full potential. We'll show you how it compares to other tools, how to set it up, and how to run your tests effectively. During the workshop, we'll do exercises to help you get comfortable with filtering, using native assertions, running tests in parallel, using CLI, and more. We'll also talk about working with TypeScript, making custom reports, and code coverage.