Skip to content

Commit

Permalink
Adapters hints and explanations (refs #67, refs #24)
Browse files Browse the repository at this point in the history
  • Loading branch information
kkamkou committed Apr 7, 2021
1 parent 046b727 commit 27d6939
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,20 @@ var log = require('gelf-pro');

### Adapters

To provide predictable behaviour, all adapters do **NOT** re-use the socket connection.
There are multiple ([1](https://github.com/kkamkou/node-gelf-pro/pull/68), [2](https://github.com/fdelayen/node-gelf-pro/commit/b52b4b6b1ff26772314b8673dd6fd724c0937caa)) variants available which you can borrow from (and create a new adapter).

- UDP (with deflation and chunking)
- Input: `GELF UDP`
- TCP
- Input: `GELF TCP` (with `Null frame delimiter`)
- TCP via TLS(SSL)
- Input: `GELF TCP` (with `Null frame delimiter` and `Enable TLS`)


> *(hint)* withing more or less stable network (which is most likely) I would recommend using the "udp" adapter.
I would also recommend it for an average to high-loaded projects. For sensitive information "tcp-tls" adapter is recommended.

### Configuration
```javascript
// simple
Expand Down

0 comments on commit 27d6939

Please sign in to comment.