An open API service indexing awesome lists of open source software.

https://github.com/gmoqa/winston-transport-mattermost

A Winston 3+ transport for Mattermost.
https://github.com/gmoqa/winston-transport-mattermost

logger mattermost nodejs transport winston

Last synced: 7 months ago
JSON representation

A Winston 3+ transport for Mattermost.

Awesome Lists containing this project

README

          

# winston-transport-mattermost

> A Winston @3.x transport for [Mattermost](https://mattermost.com/).

[![NPM](https://nodei.co/npm/winston-transport-mattermost.png)](https://nodei.co/npm/winston-transport-mattermost/)

## Install

```bash
npm install winston-transport-mattermost
```

## Usage

```js
const winston = require('winston')
const MattermostTransport = require('winston-transport-mattermost')

const logger = winston.createLogger({
transports: [
new MattermostTransport({
level: 'error',
webhook_url: 'https://your.mattermost.com/hooks/334ktjodu7gq5yq7afj3w',
username: 'logger name',
icon_url: 'https://example.com/icon.png'
})
]
})

logger.error('Something happened!')

```

## Config
* __webhook_url:__ (Required) Mattermost Incoming Webhook URL.
* __username:__ (Default **Winston**) Who sends the message.
* __icon_url:__ (Default **Adorable avatars**) Public image URL for user avatar.

## Screenshots

## Motivation
The other mattermost transport packages have too many dependencies and are not compatible with Winston @3.X, and don't allow to customize the name or avatar of the message.

## License
[MIT](./LICENSE)