NestJS

SDK لـ NestJS من أجل ClickStack - مكدس observability من ClickHouse

يتيح لك تكامل NestJS مع ClickStack إنشاء مسجّل أو استخدام المسجّل الافتراضي لإرسال السجلات إلى ClickStack (بالاعتماد على nest-winston).

يدمج هذا الدليل ما يلي:

✅ السجلات

✖️ المقاييس

✖️ التتبعات

لإرسال المقاييس أو APM/التتبعات، ستحتاج أيضًا إلى إضافة التكامل الخاص باللغة المقابلة إلى تطبيقك.

​

البدء

استورد HyperDXNestLoggerModule إلى AppModule الرئيسي، واستخدم الطريقة forRoot() لتهيئته.

import { Module } from '@nestjs/common';
import { HyperDXNestLoggerModule } from '@hyperdx/node-logger';

@Module({
  imports: [
    HyperDXNestLoggerModule.forRoot({
      url: 'http://your-otel-collector:4318',
      apiKey: ***YOUR_INGESTION_API_KEY***, // Not need for Managed ClickStack
      maxLevel: 'info',
      service: 'my-app',
    }),
  ],
})
export class AppModule {}

بعد ذلك، سيصبح مثيل winston متاحًا للحقن على مستوى المشروع بأكمله باستخدام رمز الحقن HDX_LOGGER_MODULE_PROVIDER:

import { Controller, Inject } from '@nestjs/common';
import { HyperDXNestLoggerModule, HyperDXNestLogger } from '@hyperdx/node-logger';

@Controller('cats')
export class CatsController {
  constructor(
    @Inject(HyperDXNestLoggerModule.HDX_LOGGER_MODULE_PROVIDER)
    private readonly logger: HyperDXNestLogger,
  ) { }

  meow() {
    this.logger.info({ message: '🐱' });
  }
}

​

استبدال المسجّل في Nest (أيضًا أثناء التمهيد)

مهم

عند القيام بذلك، ستتخلى عن حقن التبعيات، ما يعني أن forRoot وforRootAsync لن يعودا مطلوبين ولا ينبغي استخدامهما. أزِلهما من الوحدة الرئيسية.

لاستخدام حقن التبعيات عيبٌ بسيط. إذ يتعين على Nest أولًا تمهيد التطبيق (إنشاء مثيلات الوحدات والموفّرات، وحقن التبعيات، وما إلى ذلك)، وخلال هذه العملية لا يكون مثيل HyperDXNestLogger متاحًا بعد، ما يعني أن Nest يعود إلى المسجّل الداخلي.

أحد الحلول هو إنشاء المسجّل خارج دورة حياة التطبيق، باستخدام الدالة createLogger، ثم تمريره إلى NestFactory.create. عندها سيقوم Nest بتغليف المسجّل المخصص لدينا (وهو نفس المثيل الذي تعيده الدالة createLogger) داخل الفئة Logger، مع إعادة توجيه جميع الاستدعاءات إليه:

أنشئ المسجّل في ملف main.ts

import { HyperDXNestLoggerModule } from '@hyperdx/node-logger';

async function bootstrap() {
  const app = await NestFactory.create(AppModule, {
    logger: HyperDXNestLoggerModule.createLogger({
      url: 'http://your-otel-collector:4318',
      apiKey: ***YOUR_INGESTION_API_KEY***, // Not needed for Managed ClickStack
      maxLevel: 'info',
      service: 'my-app',
    })
  });
  await app.listen(3000);
}
bootstrap();

غيّر وحدتك الرئيسية بحيث توفّر خدمة Logger:

import { Logger, Module } from '@nestjs/common';

@Module({
  providers: [Logger],
})
export class AppModule {}

ثم احقن المسجّل ببساطة عبر تلميح النوع باستخدام Logger من @nestjs/common:

import { Controller, Logger } from '@nestjs/common';

@Controller('cats')
export class CatsController {
  constructor(private readonly logger: Logger) {}

  meow() {
    this.logger.log({ message: '🐱' });
  }
}