Express حالا خودش TracingChannel داره
خلاصهٔ کاملتر
تیم Express تو یه پست اعلام کرده که روتر Express حالا یه TracingChannel به اسم express.router.request منتشر میکنه. این کانال برای هر middleware، route handler و callback مربوط به router.param() فعال میشه. نتیجهش اینه که ابزارهای APM (یعنی ابزارهای پایش عملکرد اپلیکیشن)، لاگرها و حتی کد خودت میتونن Express رو زیر نظر بگیرن، بدون اینکه چیزی رو patch کنن.
نویسنده توضیح میده که تا الان همهچی روی monkey patching بود، یعنی عوض کردن API یه کتابخونه با یه wrapper که قبل و بعد از اجرا سیگنال ثبت میکنه. این روش شکنندهست. مثلاً اگه wrapper امضای handler رو حفظ نکنه، error handlerهایی که ۴ آرگومان میگیرن خراب میشن. برای patch کردن خودکار هم باید instrumentation قبل از Express لود بشه. تازه اگه Express داخل bundle اپ inline شده باشه، اصلاً import نمیشه و هوکها هیچوقت فعال نمیشن. OpenTelemetry هم از همین روشها استفاده میکنه، پس همین مشکلات رو داره.
به گفتهٔ نویسنده، event emitter معمولی هم جواب نمیده. حتی بدون listener سربار داره، برای گوش دادن باید خود instance رو داشته باشی، و اگه listener خطا بده، خطا به اسم کتابخونه ثبت میشه. مشکل دیگه هم اینه که باید بفهمی کدوم «پایان» مال کدوم «شروع» هست، چون همزمان کلی درخواست در جریانه.
راهحل، API TracingChannel از ماژول node:diagnostics_channel هست که از Node 19.9 اومده و به 18.19 هم backport شده. هر tracing channel در واقع ۵ کانال پشت سر همه: start، end، asyncStart، asyncEnd و error. اینها چرخهٔ عمر کدهای sync، callback و promise رو پوشش میدن. همهٔ این رویدادها یه context object مشترک میگیرن که میشه داخل AsyncLocalStorage (یعنی جایی که یه مقدار رو در طول کارهای async همراه کد نگه میداره) گذاشتش. پس شروع و پایان هر عملیات خودکار به هم وصل میشن. انتشار روی کانالی که subscriber نداره هم تقریباً هیچ هزینهای نداره.
context هر رویداد شامل req و res، الگوی route مثل /users/:id (نه آدرس واقعی)، خود handler، اسم param، خطای گزارششده، errorHandler و result هست. با چند خط کد و بدون هیچ وابستگی میشه latency رو بر اساس الگوی route اندازه گرفت، دقیقاً فهمید کدوم middleware خطا داده، یا برای هر handler یه span تو OpenTelemetry ساخت. کتابخونههایی مثل mysql2، node-redis، ioredis، graphql و mongoose هم قبلاً tracing channel خودشون رو اضافه کردن.
این قابلیت تو پکیج router نسخهٔ 2.3.0 اومده که مسیریابی Express 5 روی اونه. هر اپ Express 5 از قبل بهش وابستهست، پس نیازی به ارتقای Express نیست. فقط باید مطمئن شی lockfile نسخهٔ جدید رو برداشته. Node 18.19 یا بالاتر لازمه و نسخههای قدیمیتر فقط هیچ رویدادی منتشر نمیکنن.
نکات کلیدی:
- اسم کانال: express.router.request برای middleware، route handler و router.param()
- نیازمند router نسخهٔ 2.3.0 و Node 18.19 به بالا، بدون نیاز به ارتقای Express 5
- هر tracing channel پنج رویداد داره: start، end، asyncStart، asyncEnd و error
- دیگه لازم نیست instrumentation قبل از Express لود بشه و bundle شدن کد هم مشکلی ایجاد نمیکنه
- فیلد route الگوی مسیر رو میده، پس /users/1 و /users/2 تو یه دسته قرار میگیرن




