# winston-logstash-salim
> A winston@3 replacement for both winston-logstash and winston-logstash-udp to facilitate either TCP or UDP traffic to logstash
Latest version **1.1.0** (published 2020-09-07) · MIT license · 0 weekly downloads
## Install
```sh
npm install winston-logstash-salim
pnpm add winston-logstash-salim
yarn add winston-logstash-salim
bun add winston-logstash-salim
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-09-07 |
| First published | 2020-09-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 36.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | saouas |
| Keywords | winston, winston@3, logstash, tcp, udp, transport, winston-transport, logging, winston-logstash, winston-logstash-udp |
## Links
- npm: https://www.npmjs.com/package/winston-logstash-salim
- Repository: https://github.com/saouas/winston-logstash-salim.git
- Homepage: https://github.com/saouas/winston-logstash-salim.git#readme
- Issues: https://github.com/saouas/winston-logstash-salim.git/issues
- npm.io page: https://npm.io/package/winston-logstash-salim
## Dependencies (2)
- [winston-transport](https://npm.io/package/winston-transport.md) ^4.3.0
- [@outofsync/lodash-ex](https://npm.io/package/@outofsync/lodash-ex.md) ^1.3.2
## Alternatives
- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads
## Recent versions
- 1.1.0 (latest) — 2020-09-07
- 1.0.1-c — 2020-09-07
## README
# winston3-logstash-transport
[](https://nodei.co/npm/winston3-logstash-transport/)
[](https://www.npmjs.org/package/winston3-logstash-transport)
[](https://www.npmjs.org/package/winston3-logstash-transport)
[](https://www.npmjs.org/package/winston3-logstash-transport)
[](https://www.codacy.com/app/OutOfSyncStudios/winston-logstash-transport?utm_source=github.com&utm_medium=referral&utm_content=OutOfSyncStudios/winston-logstash-transport&utm_campaign=Badge_Grade)
[](https://www.codacy.com/app/OutOfSyncStudios/winston-logstash-transport?utm_source=github.com&utm_medium=referral&utm_content=OutOfSyncStudios/winston-logstash-transport&utm_campaign=Badge_Coverage)
[](https://david-dm.org/OutOfSyncStudios/winston-logstash-transport?view=list)
A winston@3 transport for LogStash.
This winston transport has been rewritten from both `winston-logastah` and `winston-logstash-udp` to use the new Transport behavior from winston@3.
Where possible, this has been updated to mimic the behaviors of the original
modules. There are some changes that have been made to allow the transport to
handle either TCP or UDP connections to LogStash, instead of being dedicated to
a single transport-layer protocol.
## Usage
```js
const Winston = require('winston');
const WinstonLogStash = require('winston3-logstash-transport');
const logger = Winston.createLogger();
logger.add(new WinstonLogStash({
mode: 'udp',
host: '127.0.0.1',
port: 28777
}));
logger.error('Some Error');
```
## API
### constructor(options)
Create a new Logstash Transport
### *options*
| Name | Type | Description | Valid Values | Default | TCP | UDP |
|------|------|-------------|--------------|---------|-----|-----|
| `mode` | string | The protocol to use to connect to LogStash. `tcp` is an alias for `tcp4` and `udp` is an alias for `udp4`. | `udp` `udp4` `udp6` `tcp` `tcp4` `tcp6` | `'udp4'` | ✔️ | ✔️ |
| `localhost` | string | The hostname sent to LogStash | Any | `os.hostname` | ✔️ | ✔️ |
| `host` | string | The LogStash server ip or hostname | Any valid IP or host address | `127.0.0.1` (ip4)
`::0` (ip6) | ✔️ | ✔️ |
| `port` | integer | The LogStash server port number | Any integer | `28777` | ✔️ | ✔️ |
| `applicationName` | string | The application name sent to LogStash | Any | `process.title` | ✔️ | ✔️ |
| `pid` | string | The Operating System process ID for this process | Any valid PID | `process.pid` | ✔️ | ✔️ |
| `silent` | boolean | Offline/Silent mode enabled | | `false` | ✔️ | ✔️ |
| `maxConnectRetries` | integer | The number of attempts to reconnect to make before erroring out | Any integer | `4` | ✔️ | ✔️ |
| `timeoutConnectRetries` | integer | The number of milliseconds to wait between connection attempts | Any integer | `100` | ✔️ | ✔️ |
| `label` | string | The LogStash label to send with the information | Any | `process.title` | ✔️ | ✔️ |
| `sslEnable` | boolean | Whether SSL/TLS connection should be attempted when connecting via TCP | | `false` | ✔️ | |
| `sslKey` | filepath | The filepath to the SSL Key | Any valid filepath | `''` | ✔️ | |
| `sslCert` | filepath | The filepath to the SSL Cert | Any valid filepath | `''` | ✔️ | |
| `sslCA` | filepath or Array(filepaths) | The filepath(s) to the Certificat Authority (CA) Intermediary Certs | Any valid filepath(s) | `''` | ✔️ | |
| `sslPassPhrase` | string | The SSL Cert PassPhrase (if any) | Any | `''` | ✔️ | |
| `rejectUnauthorized` | boolean | Enable connection rejection when cert is not valid | | `false` | ✔️ | |
| `trailingLineFeed` | boolean | Enable appending end of line character to UDP output | | `false` | | ✔️ |
| `trailingLineFeedChar` | string | The type of end of line character(s) to append to UDP output | Any | `os.EOL` | | ✔️ |
## [License](#license)
Copyright (c) 2018, 2019 Jay Reardon
Copyright (c) 2019 Out of Sync Studios LLC -- Licensed under the MIT license.
---
_Source: https://npm.io/package/winston-logstash-salim · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._