https://github.com/titarenko/logstash-udp

Your log messages go to logstash UDP input (almost) without any overhead.
https://github.com/titarenko/logstash-udp

Last synced: about 1 month ago
JSON representation

Your log messages go to logstash UDP input (almost) without any overhead.

• Host: GitHub
• URL: https://github.com/titarenko/logstash-udp
• Owner: titarenko
• Created: 2015-07-13T19:19:36.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-07-14T14:53:37.000Z (over 9 years ago)
• Last Synced: 2024-10-08T10:11:03.248Z (3 months ago)
• Language: JavaScript
• Size: 121 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# logstash-udp

Your log messages go to logstash UDP input (almost) without any overhead.

## Installation

```bash

npm i lsudp --save

```

## Usage

Somewhere in the app entry module:

```js

var logstash = require('lsudp');

logstash.init({

	appName: 'my-app-1',

	host: 'logstash.mycompany.com',

	port: 7777

});

```

In any module then:

```js

var logstash = require('lsudp')('my-folder/my-module');

logstash.error('oh no! json: %j, number: %d, string: %s', {everything: 'is broken'}, 1000, 'times');

```

Will cause logstash receive following over UDP:

```json

{

	"@timestamp": "Date as ISO string here",

	"type": "my-app-1",

	"env": "NODE_ENV value here",

	"source": "my-folder/my-module",

	"level": "ERROR",

	"message": "oh no! json: {\"everything\": \"is broken\"}, number: 1000, string: times"

}

```

If you want to log structured data, then:

```js

logstash.warning('warning!', mydata);

```

Resulting message object will have `mydata` assigned as value of property `data`.

This still works if you want to use placeholders inside message:

```js

logstash.debug('my %s message %d', 'formatted', 2, { my_custom: 'structured data' });

```

## Notes

If `lsudp` encounters transport level error, it will output it to `stderr` in stringified form.

## License

MIT