-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Sarvesh Chitko
committed
Feb 22, 2019
1 parent
7b3089f
commit 17846bc
Showing
2 changed files
with
36 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,30 @@ | ||
# winston-logstash | ||
<a name="module_LogstashTransport"></a> | ||
|
||
This module adds a Logstash transport to Winston to simplify logging to ELK. This plugin supports multiple inputs for Logstash thus enabling the user to make the choice that best suits his/her needs. | ||
## LogstashTransport | ||
|
||
* [LogstashTransport](#module_LogstashTransport) | ||
* [module.exports](#exp_module_LogstashTransport--module.exports) ⏏ | ||
* [new module.exports(options)](#new_module_LogstashTransport--module.exports_new) | ||
* [~LogstashTransport](#module_LogstashTransport--module.exports..LogstashTransport) ⇐ <code>Transport</code> | ||
|
||
<a name="exp_module_LogstashTransport--module.exports"></a> | ||
|
||
### module.exports ⏏ | ||
**Kind**: Exported class | ||
<a name="new_module_LogstashTransport--module.exports_new"></a> | ||
|
||
#### new module.exports(options) | ||
|
||
| Param | Type | Description | | ||
| --- | --- | --- | | ||
| options | <code>Object</code> | The Configuration object | | ||
| options.name | <code>String</code> | The name of the transport | | ||
| options.input | <code>String</code> | The input that you want to use | | ||
| options.host | <code>String</code> | The Logstash server host | | ||
| options.port | <code>String</code> | The port of the Logstash pipeline you've configured | | ||
|
||
<a name="module_LogstashTransport--module.exports..LogstashTransport"></a> | ||
|
||
#### module.exports~LogstashTransport ⇐ <code>Transport</code> | ||
**Kind**: inner class of [<code>module.exports</code>](#exp_module_LogstashTransport--module.exports) | ||
**Extends**: <code>Transport</code> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters