logjam_agent 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a443531b0f42f9a5facc12e29186e0588e65a503ed066747d4a01e8545c4d7
-  data.tar.gz: e9b3e84141df640116d7992707e2e16d783d3c61aeff6204202cc177f64706c2
+  metadata.gz: 24a410b2cc2884bdb2ad87c3219db9cc1c78b0b050e7a8161288a1f13146cdcf
+  data.tar.gz: c9dab061fe5360f6ff7db1784c1d0ff2c972b2b2a9486e0e689bc0068d6e9871
 SHA512:
-  metadata.gz: 3d4072d17788175b864c19bee9fd0e200fac5bc8bf9efa30d20d4eecc02c51f1ef95117c463c187e9fbd41f19a5604d598de0ebd3d65adeb4014bfb9dcd8e6ac
-  data.tar.gz: 9dd5d5b9a0a79e406567925ed7a18b2a93a8619d60042f4cf38ebd258018c32c023d38ce1e8911ac397c045c1f3799355ab4dcd99d0be9ff1cd8a701761138e7
+  metadata.gz: 351db0a9ab580febe99e11c2616e099817445ff698a2a26da7b5233497532a4abb49545949794dca173e54127e043f819c8040d9470abf295ee7fcd155360fba
+  data.tar.gz: 0e1c1387cb78caa5a84e2dcb6945558600ea5a3d613d66104ddaed9d1336d403f859e8295afcbe1eb8975370f408651b0a0a425f1c421b428dbad04c09cb4eb9

data/README.md

@@ -93,11 +93,13 @@ module LogjamAgent
   self.max_bytes_all_lines = 1024 * 1024
 
   # Configure compression method. Defaults to NO_COMPRESSION. Available
-  # compression methods are ZLIB_COMPRESSION and SNAPPY_COMPRESSION.
-  # Snappy is faster and less CPU intensive than ZLIB, ZLIB achieves
-  # higher compression rates.
+  # compression methods are ZLIB_COMPRESSION, SNAPPY_COMPRESSION, LZ4_COMPRESSION.
+  # Snappy and LZ4 are faster and less CPU intensive than ZLIB, ZLIB achieves
+  # higher compression rates. LZ4 is faster to decompress than Snappy
+  # and recommended.
   # self.compression_method = ZLIB_COMPRESSION
   # self.compression_method = SNAPPY_COMPRESSION
+  # self.compression_method = LZ4_COMPRESSION
 
   # Activate the split between hard and soft-exceptions. Soft exceptions are
   # all exceptions below a log level of Logger::ERROR. Logjam itself can then
@@ -110,7 +112,7 @@ end
 
 The agent generates unique request ids for all request handled. It
 will use [uuid4r](https://github.com/skaes/uuid4r) if this is
-avalaibale in the application. Otherwise it will fall back to use the
+available in the application. Otherwise it will fall back to use the
 standard `SecureRandom` class shipped with Ruby.
 
 ### Generating JSON
@@ -135,7 +137,7 @@ LogjamAgent.error_handler = lambda {|exception| ... }
 
 The MIT License
 
-Copyright (c) 2013 - 2016 Stefan Kaes
+Copyright (c) 2013 - 2019 Stefan Kaes
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/logjam_agent/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.28.0"
+  VERSION = "0.29.0"
 end

data/lib/logjam_agent.rb

@@ -117,6 +117,7 @@ module LogjamAgent
   NO_COMPRESSION = 0
   ZLIB_COMPRESSION = 1
   SNAPPY_COMPRESSION = 2
+  LZ4_COMPRESSION= 3
 
   mattr_reader :compression_method
   def self.compression_method=(compression_method)
@@ -128,6 +129,13 @@ module LogjamAgent
       rescue LoadError
         # do nothing
       end
+    when LZ4_COMPRESSION
+      begin
+        require "ruby-lz4"
+        @@compression_method = LZ4_COMPRESSION
+      rescue LoadError
+        # do nothing
+      end
     when NO_COMPRESSION, ZLIB_COMPRESSION
       @@compression_method = compression_method
     else
@@ -245,15 +253,35 @@ module LogjamAgent
   def self.encode_payload(data)
     json = json_encode_payload(data)
     case compression_method
-    when ZLIB_COMPRESSION
-      ActiveSupport::Gzip.compress(json)
     when SNAPPY_COMPRESSION
       Snappy.deflate(json)
+    when LZ4_COMPRESSION
+      n = data.byte_size
+      max_compressed_size = n + n/256 + 16
+      buf = String.new([n].pack("N"), capacity: max_compressed_size + 4)
+      LZ4::Raw.compress(json, input_size: n, dest: buf, max_ouput_size: max_compressed_size).first
+    when ZLIB_COMPRESSION
+      ActiveSupport::Gzip.compress(json)
     else
       json
     end
   end
 
+  def self.decode_payload(data)
+    case compression_method
+    when SNAPPY_COMPRESSION
+      Snappy.inflate(data)
+    when LZ4_COMPRESSION
+      uncompressed_size = data[0..3].unpack("N")
+      buf = String.new("", capacity: uncompressed_size)
+      LZ4::Raw.decompress(data[4..-1], uncompressed_size, dest: buf).first
+    when ZLIB_COMPRESSION
+      ActiveSupport::Gzip.decompress(data)
+    else
+      data
+    end
+  end
+
   def self.event(label, extra_fields = {})
     fields = {
       :label      => label,

data/logjam_agent.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "i18n"
   s.add_development_dependency "snappy"
+  s.add_development_dependency "lz4-ruby"
   s.add_development_dependency "oj"
   s.add_development_dependency "byebug"
   s.add_development_dependency "minitest"

data/test/zmq_forwarder_test.rb

@@ -30,7 +30,29 @@ module LogjamAgent
       normal_msg = LogjamAgent.encode_payload(data)
       LogjamAgent.compression_method = SNAPPY_COMPRESSION
       compressed_msg = LogjamAgent.encode_payload(data)
-      assert_equal normal_msg, Snappy.inflate(compressed_msg)
+      assert_equal normal_msg, LogjamAgent.decode_payload(compressed_msg)
+      f = ZMQForwarder.new
+      f.expects(:publish).with("a-b", "x", compressed_msg)
+      f.forward(data, :routing_key => "x", :app_env => "a-b")
+    end
+
+    test "compressed message using lz4 can be uncompressed" do
+      data = {a: 1, b: "str"}
+      normal_msg = LogjamAgent.encode_payload(data)
+      LogjamAgent.compression_method = LZ4_COMPRESSION
+      compressed_msg = LogjamAgent.encode_payload(data)
+      assert_equal normal_msg, LogjamAgent.decode_payload(compressed_msg)
+      f = ZMQForwarder.new
+      f.expects(:publish).with("a-b", "x", compressed_msg)
+      f.forward(data, :routing_key => "x", :app_env => "a-b")
+    end
+
+    test "compressed message using zlib can be uncompressed" do
+      data = {a: 1, b: "str"}
+      normal_msg = LogjamAgent.encode_payload(data)
+      LogjamAgent.compression_method = ZLIB_COMPRESSION
+      compressed_msg = LogjamAgent.encode_payload(data)
+      assert_equal normal_msg, LogjamAgent.decode_payload(compressed_msg)
       f = ZMQForwarder.new
       f.expects(:publish).with("a-b", "x", compressed_msg)
       f.forward(data, :routing_key => "x", :app_env => "a-b")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2019-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: lz4-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -211,8 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: logjam_agent
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Logjam client library to be used with logjam