mirror of
https://github.com/log4js-node/log4js-node.git
synced 2025-12-08 19:26:01 +00:00
28 lines
1.1 KiB
Markdown
28 lines
1.1 KiB
Markdown
# Redis Appender
|
|
|
|
Stores log events in a [Redis](https://redis.io) database. You will need to include the [redis](https://www.npmjs.com/package/redis) package in your application's dependencies to use this appender.
|
|
|
|
## Configuration
|
|
|
|
* `type` - `redis`
|
|
* `host` - `string` (optional, defaults to `127.0.0.1`) - the location of the redis server
|
|
* `port` - `integer` (optional, defaults to `6379`) - the port the redis server is listening on
|
|
* `pass` - `string` (optional) - password to use when authenticating connection to redis
|
|
* `channel` - `string` - the redis channel that log events will be published to
|
|
* `layout` - `object` (optional, defaults to `messagePassThroughLayout`) - the layout to use for log events (see [layouts](layouts.md)).
|
|
|
|
The appender will use the Redis PUBLISH command to send the log event messages to the channel.
|
|
|
|
## Example
|
|
|
|
```javascript
|
|
log4js.configure({
|
|
appenders: {
|
|
redis: { type: 'redis', channel: 'logs' }
|
|
},
|
|
categories: { default: { appenders: ['redis'], level: 'info' } }
|
|
});
|
|
```
|
|
|
|
This configuration will publish log messages to the `logs` channel on `127.0.0.1:6379`.
|