gelf_redux 4.2.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34fdff35e2f2d6ca2f6a5058207daee386bd22cca506216cad1f1fb7180e1d7a
-  data.tar.gz: d5779e92ca36a31ef0cb87f4a1745433fe062d0839d21be82c74866c2617ce0b
+  metadata.gz: '090a1e70d86fb1c1773e85f693561bd0c0c13944c1924464271f93761ca4f1e3'
+  data.tar.gz: 6404d9178c8a8383edf2c899e25d76510558d10fe307bb528ca09882dd36d107
 SHA512:
-  metadata.gz: 0e3e2acb03645deb166d0850ba9f0e21e453a830cb30378a3153ec1ec00ed33ea257fd965a85bf7069838953281c4b89b9c937a6bde749e1b248b0e3a9ccf9eb
-  data.tar.gz: 7f576a99b7f4f410d0dba14b8329eb7ca29703a8ee25e349ecbb0614e8d044333d3597799261c25d0ba6100ed57c8e5492ade2f7e3de870fc03ec049ba4e2911
+  metadata.gz: d3674594a4cf394a45cc08381852d8d5a92cef8a1469e4491b57babf11e80472a79a28d569853da8e059c71d6c3d3bcf69a85109a63145ad40ba959e7fdc6ecf
+  data.tar.gz: '08553745e14bb61b6c79fd12cc6e2c5dc66462826f58c368038bf743aa6df5698b17380948665c206868ed4ea0f620363981d294cee8bb8ad57af85f5cd3447a'

data/README.md

@@ -7,37 +7,58 @@ of the original project because we wanted to keep all of the projects and mainta
 
 ## Versioning
 
-- 3.1.1 is the latest original gelf-rb version ()
+- 3.1.1 is the latest original gelf-rb version (https://github.com/graylog-labs/gelf-rb)
 - 3.2.1 is the first http(s) supporting version from here https://github.com/christianrolle/gelf-rb
 - 4.0.0 we do start from here with our versioning, improvements and updates
 
+See the [CHANGELOG](CHANGELOG) for release details.
 
+## Installation
+
+Add `gem 'gelf_redux'` to your Gemfile (and run `bundle install`), or run `gem install gelf_redux`.
+Load the library with `require 'gelf_redux'`.
 
 ## Usage
-### Gelf::Notifier
+### GELF::Notifier
 
-This allows you to send arbitary messages via UDP to Graylog.
+This allows you to send arbitrary messages via UDP to Graylog.
 
     n = GELF::Notifier.new("localhost", 12201)
 
     # Send with custom attributes and an additional parameter "foo"
-    n.notify!(:short_message => "foo", :full_message => "something here\n\nbacktrace?!", :_foo => "bar")
+    n.notify!(short_message: "foo", full_message: "something here\n\nbacktrace?!", _foo: "bar")
 
     # Pass any object that responds to .to_hash
     n.notify!(Exception.new)
 
 The recommended default is to send via UDP but you can choose to send via TCP like this:
 
-    n = GELF::Notifier.new("127.0.0.1", 12201, "LAN", { :protocol => GELF::Protocol::TCP })
+    n = GELF::Notifier.new("127.0.0.1", 12201, "LAN", { protocol: GELF::Protocol::TCP })
 
 Note that the `LAN` or `WAN` option is ignored for TCP because no chunking happens. (Read below for more information.)
 
-### Gelf::Logger
+For a Graylog GELF HTTP input, select HTTP or HTTPS. The `:path` and `:headers` options are available if your endpoint requires them:
+
+    n = GELF::Notifier.new("localhost", 12201, "WAN", { protocol: GELF::Protocol::HTTP })
+    n.notify!("Hello from HTTP")
+
+    # For an HTTPS input, use GELF::Protocol::HTTPS and its HTTPS port:
+    n = GELF::Notifier.new("graylog.example.com", 443, "WAN", { protocol: GELF::Protocol::HTTPS })
+
+For TLS over a GELF TCP input, pass `:tls`. Certificate and hostname verification are enabled by default; specify `"ca"` to trust a custom CA. The host must match the server certificate:
+
+    n = GELF::Notifier.new("graylog.example.com", 12201, "WAN", {
+      protocol: GELF::Protocol::TCP,
+      tls: { "ca" => "/path/to/ca.pem" }
+    })
+    n.notify!("Hello from TLS")
 
-The Gelf::Logger is compatible with the standard Ruby Logger interface and can be used interchangeably.
-Under the hood it uses Gelf::Notifier to send log messages via UDP to Graylog.
+### GELF::Logger
 
-    logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "appname" })
+The GELF::Logger is compatible with the standard Ruby Logger interface and can be used interchangeably.
+Under the hood it uses GELF::Notifier to send log messages via UDP to Graylog.
+
+    logger = GELF::Logger.new("localhost", 12201, "WAN", { facility: "appname" })
 
     logger.debug "foobar"
     logger.info "foobar"
@@ -47,13 +68,13 @@ Under the hood it uses Gelf::Notifier to send log messages via UDP to Graylog.
 
     logger << "foobar"
 
-Then `WAN` or `LAN` option influences the UDP chunk size depending on if you send in your own
+The `WAN` or `LAN` option influences the UDP chunk size depending on whether you send in your own
 network (LAN) or on a longer route (i.e. through the internet) and should be set accordingly.
 
 Since it's compatible with the Logger interface, you can also use it in your Rails application:
 
     # config/environments/production.rb
-    config.logger = GELF::Logger.new("localhost", 12201, "WAN", { :facility => "appname" })
+    config.logger = GELF::Logger.new("localhost", 12201, "WAN", { facility: "appname" })
 
 ### Note on Patches/Pull Requests
 
@@ -71,7 +92,26 @@ You can either run tests against the ruby versions defined in docker-compose.yml
 ```bash
 docker compose up
 ```
-Or you can run a specific test:
+Or you can run the tests for a specific Ruby version:
 ```bash
 docker compose up ruby26
-```
+```
+
+### Create a release
+- The VERSION file has to be updated to the new version number because it is used in gelf_redux.gemspec to
+have a generic way of bumping the version
+- CHANGELOG should be updated with a few hints about the release
+- a release tag should be created from main branch after all PRs that will be part of the release have been merged
+- creating a tag for the version is mandatory to be able to come back later for a fix-release if needed, example:
+```shell
+git tag v4.2.0
+git push origin main --tags
+```
+#### For tags < 4.2.0
+There is no automated way of pushing to rubygems, so we have to run these commands on a developers machine:
+```shell
+gem build *.gemspec
+gem push *.gem
+```
+#### For tags >= 4.2.0
+There is a github action for automated releases which will run as soon as a version tag has been pushed

data/lib/gelf/transport/tcp_tls.rb

@@ -35,7 +35,7 @@ module GELF
 
       def connect(host, port)
         plain_socket = super(host, port)
-        start_tls(plain_socket)
+        start_tls(plain_socket, host)
       rescue OpenSSL::SSL::SSLError
         plain_socket.close unless plain_socket.closed?
         raise unless rescue_ssl_errors
@@ -43,10 +43,13 @@ module GELF
       end
 
       # Initiates TLS communication on the socket
-      def start_tls(plain_socket)
+      def start_tls(plain_socket, host)
         ssl_socket_class.new(plain_socket, ssl_context).tap do |ssl_socket|
           ssl_socket.sync_close = true
+          ssl_socket.hostname = host if ssl_socket.respond_to?(:hostname=) # SNI
           ssl_socket.connect
+          # VERIFY_PEER only checks the chain; also check the cert was issued for this host
+          ssl_socket.post_connection_check(host) unless @tls_options['no_verify']
         end
       end
 
@@ -88,7 +91,7 @@ module GELF
       def restrict_ciphers(ctx)
         # This CipherString is will allow a variety of 'currently' cryptographically secure ciphers, 
         # while also retaining a broad level of compatibility
-        ctx.ciphers = "TLSv1_2:TLSv1_1:TLSv1:!aNULL:!eNULL:!LOW:!3DES:!MD5:!EXP:!PSK:!DSS:!RC4:!SEED:!ECDSA:!ADH:!IDEA:!3DES"
+        ctx.ciphers = "TLSv1.2:TLSv1.1:TLSv1:!aNULL:!eNULL:!LOW:!3DES:!MD5:!EXP:!PSK:!DSS:!RC4:!SEED:!ECDSA:!ADH:!IDEA:!3DES"
       end
 
       def verify_mode

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gelf_redux
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Alexey Palazhchenko
@@ -14,22 +14,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-05 00:00:00.000000000 Z
+date: 2026-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.18.1
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.18.1
+        version: '3.18'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement