> ## 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.

> SDK do NestJS para ClickStack - a stack de observabilidade da ClickHouse

# 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"
  }}>Este guia integra:</span>
      {supported.includes("logs") && <span style={pillStyle}>Logs</span>}
      {supported.includes("metrics") && <span style={pillStyle}>Métricas</span>}
      {supported.includes("traces") && <span style={pillStyle}>Rastreamentos</span>}
    </div>;
};

A integração do NestJS com o ClickStack permite criar um logger ou usar o logger padrão
para enviar logs ao ClickStack (com tecnologia do [nest-winston](https://www.npmjs.com/package/nest-winston?activeTab=readme)).

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

*Para enviar métricas ou APM/traces, você também precisará adicionar à sua aplicação a
integração correspondente da linguagem.*

<h2 id="getting-started">
  Primeiros passos
</h2>

Importe `HyperDXNestLoggerModule` no `AppModule` principal e use o método `forRoot()`
para configurá-lo.

```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 {}
```

Depois, a instância do winston ficará disponível para ser injetada em todo o
projeto usando o token de injeção `HDX_LOGGER_MODULE_PROVIDER`:

```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">
  Substituindo o logger do Nest (também durante o bootstrap)
</h3>

<Info>
  **Importante**

  Ao fazer isso, você abre mão da injeção de dependências, o que significa que `forRoot` e `forRootAsync` não são necessários e não devem ser usados. Remova-os do módulo principal.
</Info>

Usar a injeção de dependências tem uma pequena desvantagem. O Nest precisa primeiro inicializar a
aplicação (instanciando módulos e providers, injetando dependências
etc.) e, durante esse processo, a instância de `HyperDXNestLogger` ainda não
está disponível, o que significa que o Nest recorre ao logger interno.

Uma solução é criar o logger fora do ciclo de vida da aplicação, usando
a função `createLogger`, e passá-lo para `NestFactory.create`. O Nest então
encapsulará nosso logger personalizado (a mesma instância retornada pelo método `createLogger`)
na classe Logger, encaminhando todas as chamadas para ela:

Crie o logger no arquivo `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();
```

Altere seu módulo principal para disponibilizar o serviço Logger:

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

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

Em seguida, injete o logger simplesmente tipando-o com o Logger de `@nestjs/common`:

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

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

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