8000 docs: forgot to update README · log4js-node/rabbitmq@c310f50 · GitHub
[go: up one dir, main page]

Skip to content

Commit c310f50

Browse files
author
Gareth Jones
committed
8000
docs: forgot to update README
1 parent 442bcdc commit c310f50

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1-
# Rabbitmq Appender
1+
# RabbitMQ Appender for Log4JS
22

3-
Push log events to a [Rabbitmq](https://www.rabbitmq.com/) MQ. You will need to include the [amqplib](https://www.npmjs.com/package/amqplib) package in your application's dependencies to use this appender.
3+
Push log events to a [Rabbitmq](https://www.rabbitmq.com/) MQ. Require [log4js-node](https://github.com/log4js-node/log4js-node) 2.x or later.
4+
5+
```bash
6+
npm install @log4js-ndoe/rabbitmq
7+
```
48

59
## Configuration
610

7-
* `type` - `rabbitmq`
11+
* `type` - `@log4js-ndoe/rabbitmq`
812
* `host` - `string` (optional, defaults to `127.0.0.1`) - the location of the rabbitmq server
913
* `port` - `integer` (optional, defaults to `5672`) - the port the rabbitmq server is listening on
1014
* `username` - `string` (optional, defaults to `guest`) - username to use when authenticating connection to rabbitmq
@@ -23,7 +27,7 @@ The appender will use the Rabbitmq Routing model command to send the log event m
2327
log4js.configure({
2428
appenders: {
2529
mq: {
26-
type: 'rabbitmq',
30+
type: '@log4j-node/rabbitmq',
2731
host: '127.0.0.1',
2832
port: 5672,
2933
username: 'guest',

0 commit comments

Comments
 (0)
0