> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-parallel-read-in-order-multi-part.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ClickStack 用 NestJS SDK - ClickHouse Observability Stack

# NestJS

export const ClickStackIntegrates = ({signals = []}) => {
  const list = Array.isArray(signals) ? signals : String(signals).split(",");
  const supported = list.map(s => String(s).trim().toLowerCase());
  const pillStyle = {
    display: "inline-flex",
    alignItems: "center",
    padding: "0.125rem 0.625rem",
    borderRadius: "9999px",
    fontSize: "0.8125rem",
    fontWeight: 500,
    lineHeight: 1.6,
    color: "#161517",
    backgroundColor: "#faff69",
    border: "1px solid rgba(0, 0, 0, .1)",
    marginRight: "0.5rem"
  };
  return <div style={{
    margin: "0 0 1.25rem"
  }}>
      <span style={{
    marginRight: "0.5rem"
  }}>このガイドで統合するシグナル:</span>
      {supported.includes("logs") && <span style={pillStyle}>ログ</span>}
      {supported.includes("metrics") && <span style={pillStyle}>メトリクス</span>}
      {supported.includes("traces") && <span style={pillStyle}>トレース</span>}
    </div>;
};

ClickStack の NestJS インテグレーションでは、ロガーを作成するか、デフォルトの
ロガーを使用して ClickStack にログを送信できます ([nest-winston](https://www.npmjs.com/package/nest-winston?activeTab=readme) を利用) 。

<ClickStackIntegrates signals={['logs']} />

*メトリクスや APM/トレースも送信するには、対応する言語の
インテグレーションをアプリケーションに追加する必要があります。*

<h2 id="getting-started">
  はじめに
</h2>

ルートの `AppModule` に `HyperDXNestLoggerModule` をインポートし、`forRoot()`
メソッドで設定します。

```javascript theme={null}
import { Module } from '@nestjs/common';
import { HyperDXNestLoggerModule } from '@hyperdx/node-logger';

@Module({
  imports: [
    HyperDXNestLoggerModule.forRoot({
      url: '<YOUR_OTEL_COLLECTOR_HTTP_ENDPOINT>',
      apiKey: '<YOUR_INGESTION_API_KEY>', // Omit for Managed ClickStack
      maxLevel: 'info',
      service: 'my-app',
    }),
  ],
})
export class AppModule {}
```

その後、`HDX_LOGGER_MODULE_PROVIDER` の注入トークンを使って、プロジェクト
全体で `winston` インスタンスを注入できるようになります。

```javascript theme={null}
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: '🐱' });
  }
}
```

<h3 id="replacing-the-nest-logger">
  Nest のロガーを置き換える (ブートストラップ時を含む)
</h3>

<Info>
  **重要**

  この方法では依存性注入を使わなくなるため、`forRoot` と `forRootAsync` は不要で、使用すべきではありません。メインモジュールから削除してください。
</Info>

依存性注入を使用する場合、1 つだけ小さな欠点があります。Nest はまずアプリケーションをブートストラップし (モジュールやプロバイダーのインスタンス化、依存関係の注入など) 、その処理中は `HyperDXNestLogger` のインスタンスがまだ利用できません。そのため、Nest は内部ロガーにフォールバックします。

これに対する 1 つの解決策は、`createLogger` 関数を使ってアプリケーションのライフサイクル外でロガーを作成し、それを `NestFactory.create` に渡すことです。すると Nest は、カスタムロガー (`createLogger` メソッドが返すものと同じインスタンス) を Logger クラスでラップし、すべての呼び出しをそこに転送します。

`main.ts` ファイルでロガーを作成します

```javascript theme={null}
import { HyperDXNestLoggerModule } from '@hyperdx/node-logger';

async function bootstrap() {
  const app = await NestFactory.create(AppModule, {
    logger: HyperDXNestLoggerModule.createLogger({
      url: '<YOUR_OTEL_COLLECTOR_HTTP_ENDPOINT>',
      apiKey: '<YOUR_INGESTION_API_KEY>', // Omit for Managed ClickStack
      maxLevel: 'info',
      service: 'my-app',
    })
  });
  await app.listen(3000);
}
bootstrap();
```

メインモジュールで Logger サービスを提供するように変更します。

```javascript theme={null}
import { Logger, Module } from '@nestjs/common';

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

次に、`@nestjs/common` の Logger を型ヒントとして指定するだけで、ロガーを簡単に注入できます。

```javascript theme={null}
import { Controller, Logger } from '@nestjs/common';

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

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