gelf-pro - npm Package Compare versions

Comparing version 1.3.11 to 1.3.12

package.json

 {
   "name": "gelf-pro",
-  "version": "1.3.11",
+  "version": "1.3.12",
   "main": "./lib/gelf-pro.js",
@@ -5,0 +5,0 @@ "typings": "./typings/index.d.ts",

README.md

 gelf pro
 =============
-node-gelf - Graylog2 client library for Node.js. Pro - because of code-quality (at 2015). GELF - The Graylog Extended Log Format.
+`gelf-pro` - Graylog2 client library for Node.js.  
+Sends logs to Graylog2 server in GELF (Graylog Extended Log Format) format.
 
+**Features:**
+- JS object marshalling
+- UDP/TCP/TLS support
+- Filtering, Transforming, Broadcasting.
+
 ![Build Status](https://github.com/kkamkou/node-gelf-pro/actions/workflows/node.js.yml/badge.svg?branch=master)
@@ -15,3 +21,3 @@ ![Coverage Status](https://coveralls.io/repos/github/kkamkou/node-gelf-pro/badge.svg?branch=master)
 
-`npm install gelf-pro` (**ALL** node.js versions are supported [0.x to 20.x] :)
+`npm install gelf-pro` (**ALL** node.js versions are supported [0.x to 2x.x] :)
 
@@ -27,5 +33,7 @@ Library depends on: `lodash#~4.17`
 
-> :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. [See related section](#third-party-adapters).
 
@@ -40,5 +48,6 @@ - UDP (with deflation and chunking)
 
-> 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.
 
@@ -45,0 +54,0 @@ ### Configuration

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24636

increased by2.09%

Number of lines in readme file

202

increased by4.66%

No dependency changes