@scarwar/winston-rabbitmq/README.md

A RabbitMQ transport for Winston.

# winston-rabbitmq

> This is a typescript port of [winston-fast-rabbitmq
](https://github.com/TBear79/winston-fast-rabbitmq) to `winston 3.x`

A RabbitMQ transport for Winston. 

It closes the connection after every message, but keeps the connection open as long as new messages arrive within a short timespan.

* Easy to use and fast to implement
* Build using [amqplib](https://www.npmjs.com/package/amqplib)
* Non-blocking as it uses [rabbit-chatter](https://www.npmjs.com/package/rabbit-chatter)

# Usage

Use [npm](https://www.npmjs.com/) to install the module:

```
	npm install @scarwar/winston-rabbitmq
```

Then use `import` to load it in your code:

```javascript
    import { RabbitMQTransport } from 'winston-rabbitmq';
```

Setup the transport in winston:

```javascript
	winston.add(new RabbitMQTransport(options));
```

Now you are ready to send some logs to RabbitMQ!

## Options

Most options are passed on directly to [rabbit-chatter](https://www.npmjs.com/package/rabbit-chatter). So have a look at 
that module to see the rest of the option list.

### level

String

Default: 'info'

Sets the minimum required level for sending the log to RabbitMQ. You can find the levels [here](https://www.npmjs.com/package/winston#logging-levels).

# Tests

To run tests on this module, make sure the modules for the tests are installed

```
	npm install @scarwar/winston-rabbitmq --dev
```

Then run:

```
	npm test
```

NOTICE: The test is not only a unit test but also a functionality test. So RabbitMQ is required to be installed locally in order to run the test.

# Further reading

Further documentation the topics according to this module:

* [Winston](https://www.npmjs.com/package/winston)
* [RabbitMQ](https://www.rabbitmq.com/documentation.html) [Tutorial](https://www.rabbitmq.com/getstarted.html)
* [amqplib](https://www.npmjs.com/package/amqplib)
* [rabbit-chatter](https://www.npmjs.com/package/rabbit-chatter)

# Release notes

* 3.0.0-beta1 - Updated dependencies, including winston, mocha, and more
* 2.2.0 - Updated dependencies, including rabbit-chatter v2 that fixes an issue that left open connections.
* 2.1.0 - Ability to pass timeout to rabbit-chatter
* 2.0.2 - IMPORTANT! Renamed transport property from `WinstonInstanceRabbitMq` to `WinstonFastRabbitmq` in types.
* 2.0.0 - BREAKING! Renamed exported class to `WinstonFastRabbitmq`. Added types definitions.
* 1.3.0 - Refactor to comply with `winston` formatter function signature. Thanks to JimiC.
* 1.2.4 - Added name to be able to identify transport in `winston`. Provided `routingKey` to `rabbit-chatter`. Both updates with thanks to JimiC.
* 1.2.2 - Updated dependencies.
* 1.2.1 - Removed forward slash provided to `rabbit-chatter`.

# Keywords

* winston
* rabbitmq
* amqp
* amqplib
* logging
* winston transport
* transport
* error
* error handling
* error handler

# License

The MIT License (MIT)

Copyright (c) Ariel Bereslavsky

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.