> For the complete documentation index, see [llms.txt](https://www.ngxs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.ngxs.io/v3.3/plugins/logger.md).

# Logger

A simple console log plugin to log actions as they are processed.

## Installation

```bash
npm install @ngxs/logger-plugin --save

# or if you are using yarn
yarn add @ngxs/logger-plugin
```

## Usage

Add the `NgxsLoggerPluginModule` plugin to your root app module:

```typescript
import { NgxsModule } from '@ngxs/store';
import { NgxsLoggerPluginModule } from '@ngxs/logger-plugin';

@NgModule({
  imports: [
    NgxsModule.forRoot([]),
    NgxsLoggerPluginModule.forRoot()
  ]
})
export class AppModule {}
```

### Options

The plugin supports the following options passed via the `forRoot` method:

* `logger`: Supply a different logger, useful for logging to backend. Defaults to `console`.
* `collapsed`: Collapse the log by default or not. Defaults to true.
* `disabled`: Disable the logger during production.

### Notes

You should always include the logger as the last plugin in your configuration. For instance, if you were to include logger before a plugin like the storage plugin, the initial state would not be reflected.