# loglayer
`loglayer` is a unified Typescript logger that routes logs to various logging libraries, cloud providers, files, and OpenTelemetry while providing a fluent API for specifying log messages, metadata and errors.
Supports browser, Node.js, Bun, and Deno platforms.
- For full documentation, read the [docs](https://loglayer.dev).
```javascript
// Example using the Pino logging library with LogLayer
// You can also start out with a console logger and swap to another later!
import { LogLayer } from 'loglayer';
import { pino } from 'pino';
import { PinoTransport } from '@loglayer/transport-pino';
import { redactionPlugin } from '@loglayer/plugin-redaction';
const log = new LogLayer({
// Multiple loggers can also be used at the same time.
transport: new PinoTransport({
logger: pino()
}),
// Plugins modify log data before it's shipped to your logging library.
plugins: [
redactionPlugin({
paths: ['password'],
censor: '[REDACTED]',
}),
],
// Put context data in a specific field (default is flattened)
contextFieldName: 'context',
// Put metadata in a specific field (default is flattened)
metadataFieldName: 'metadata',
})
// persisted data that is always included in logs
log.withContext({
path: "/",
reqId: "1234"
})
log.withPrefix("[my-app]")
.withError(new Error('test'))
// data that is included for this log entry only
.withMetadata({ some: 'data', password: 'my-pass' })
// Non-object data only (numbers, booleans, and strings only)
// this can be omitted to just log an object / error
// by using .errorOnly() / .metadataOnly() instead of withError() / withMetadata()
.info('my message')
```
```json5
{
"level": 30,
"time": 1735857465669,
"msg": "[my-app] my message",
"context": {
"path": "/",
"reqId": "1234",
},
"metadata": {
"password": "[REDACTED]",
"some": "data",
},
"err":{
"type": "Error",
"message": "test",
"stack": "Error: test\n ..."
}
}
```
With the [Pretty Terminal Transport](https://loglayer.dev/transports/pretty-terminal):
The [Wide Events Mixin](https://loglayer.dev/mixins/wide-events) enables comprehensive, self-contained log entries that capture an entire operation's context. For background on the problem this solves, see [Why Logging Sucks](https://loggingsucks.com/).
```typescript
import { AsyncLocalStorage } from "node:async_hooks";
import { LogLayer, StructuredTransport, useLogLayerMixin } from 'loglayer';
import { createWideEventMixin } from '@loglayer/mixin-wide-events';
const asyncLocalStorage = new AsyncLocalStorage<{ logger: LogLayer }>();
useLogLayerMixin(createWideEventMixin({ asyncContext: asyncLocalStorage }));
const log = new LogLayer({
transport: new StructuredTransport({ logger: console })
});
asyncLocalStorage.run({ logger: log }, () => {
log.withWideEvents({ userId: "123" });
// ... do work ...
log.withWideEvents({ orderId: "456", duration: 150 });
log.emitWideEvent({ message: "Order processed" });
// Emits a single log with all accumulated data in one entry
});
```
## Installation
Install the core package:
```bash
npm i loglayer
```
## Quick Start
```typescript
import { LogLayer, ConsoleTransport } from 'loglayer'
const log = new LogLayer({
transport: new ConsoleTransport({
logger: console,
}),
})
log
.withMetadata({ some: 'data'})
.withError(new Error('test'))
.info('my message')
```
- See the [LogLayer configuration documentation](https://loglayer.dev/configuration.html) for more configuration options.
- See the [Console Transport documentation](https://loglayer.dev/transports/console.html) for more configuration options.
Made with ❤️ by [Theo Gravity](https://suteki.nu) / [Disaresta](https://disaresta.com). Logo by [Akshaya Madhavan](https://www.linkedin.com/in/akshaya-madhavan).