Skip to content

Commit

Permalink
Readme update (#94)
Browse files Browse the repository at this point in the history
* Update README.md
* Update LICENSE
  • Loading branch information
kkamkou authored Mar 27, 2024
1 parent f321254 commit 07030ef
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2013-2022 Kanstantsin Kamkou and contributors
Copyright (c) 2013-2024 Kanstantsin Kamkou and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
gelf pro
=============
node-gelf - Graylog2 client library for Node.js. Pro - because of code-quality (at 2015). GELF - The Graylog Extended Log Format.
node-gelf - Graylog2 client library for Node.js. GELF - The Graylog Extended Log Format.

![Build Status](https://github.com/kkamkou/node-gelf-pro/actions/workflows/node.js.yml/badge.svg?branch=master)
![Coverage Status](https://coveralls.io/repos/github/kkamkou/node-gelf-pro/badge.svg?branch=master)
Expand All @@ -23,9 +23,11 @@ var log = require('gelf-pro');

### Adapters

> :warning: To provide predictable behaviour, all existing 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).
[See related section](#third-party-adapters).
> [!WARNING]
> To ensure consistent behavior, **none of the existing adapters re-use the socket connection**. Re-using socket connections can lead to resource leakage, complexity in state management, concurrency issues, security risks, and may not always provide significant performance benefits.
> It's often simpler and safer to establish new connections as needed rather than re-using existing ones, ensuring better resource utilization and reducing potential complications in network communication.
>
> 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 for you to borrow from and create a new adapter.
- UDP (with deflation and chunking)
- Input: `GELF UDP`
Expand All @@ -35,9 +37,10 @@ There are multiple ([1](https://github.com/kkamkou/node-gelf-pro/pull/68), [2](h
- Input: `GELF TCP` (with `Null frame delimiter` and `Enable TLS`)


> 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 project.
For sensitive information `tcp-tls` adapter is recommended.
> [!NOTE]
> Within a 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 project.
> For sensitive information, the `tcp-tls` adapter is recommended.
### Configuration
```javascript
Expand Down

0 comments on commit 07030ef

Please sign in to comment.