sqreen-kit 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: feacd9986438ad22e08e0e752a59058956dd63ddfe00b90bdfd094e030db4ced
-  data.tar.gz: 318d9d80e07bcc4336740effe1b243e1f279fdbb5bef84be9dab3425884ae7e0
+  metadata.gz: f8cbb82a739997ab9d4faa9689df9d3854ddb32a45361b4a572f2e13b4104dfa
+  data.tar.gz: 456792fc273fce1cd31c9b4d8d60f94321ac8315dd968cd992ffb1c42607c9d1
 SHA512:
-  metadata.gz: f43f0e22c84f9d15d749ad4ffaf9078ac9b0d1357d24f8f866cd7af5dfaf395489bd5fb913fdaeacc6b74a195491c42292b34b7c075271c3f4e788d95b105e4d
-  data.tar.gz: 91879a34437077558e6efb76196a9dd6b71fbdb0bdcc00c1c5d9e348035d749e8c0fd3b9537e8ec189737c7a0df1c0a5813b4ef0afd20c6fb0858b00aae2620c
+  metadata.gz: cd0f3f2a07777f0996eee497e87c4a843fb20d1b8d9cab255383b89d489c067ed83442ea77ccd12f5d463073b9b7ab4200e84067bbef21abdf04773773a41187
+  data.tar.gz: 4e8b6b71afc3e951de917e4a712f2fdabb0f70f627d7253c6e87e07bbe29efab839cf4e6a23de125ce752fb3856c8314adf4b2a636588c824c95d10776dd7506

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.2.2
+
+* Make user agent optional for HTTP context payload
+
+## 0.2.1
+
+* Add configurable certificate store
+
+## 0.2.0
+
+* Add configurable source information
+* Fix wire-level formats
+
+## 0.1.1
+
+* Fixed a potential conflict prefenting agent startup
+
 ## 0.1.0
 
 * Extracted code from Ruby agent

data/lib/sqreen-kit.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
 # frozen_string_literal: true
 
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit'

data/lib/sqreen/kit.rb

@@ -1,3 +1,9 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+require 'sqreen/kit/version'
 require 'sqreen/kit/configuration'
 require 'sqreen/kit/retry_policy'
 require 'sqreen/kit/http_client'
@@ -12,10 +18,6 @@ module Sqreen
   module Kit
     # Factories using the global configuration
     class << self
-      def version
-        @version ||= Gem.loaded_specs['sqreen-kit'].version
-      end
-
       def auth_signals_client
         @auth_signals_client ||=
           Signals::AuthSignalsClient.new(
@@ -55,6 +57,7 @@ module Sqreen
         @http_client ||=
           HttpClient.new(Configuration.ingestion_url,
                          retry_policy,
+                         certificate_store: Configuration.certificate_store,
                          proxy_address: Configuration.proxy_address,
                          proxy_port: Configuration.proxy_port,
                          proxy_user: Configuration.proxy_user,

data/lib/sqreen/kit/configuration.rb

@@ -1,4 +1,10 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'logger'
+require 'sqreen/kit/version'
 
 module Sqreen
   module Kit
@@ -8,6 +14,7 @@ module Sqreen
 
         # http client related
         attr_accessor :ingestion_url,
+                      :certificate_store,
                       :proxy_address,
                       :proxy_port,
                       :proxy_user,
@@ -29,6 +36,11 @@ module Sqreen
                       :batch_flush_size,
                       :batch_max_size
 
+        # Default value for source in signals taking a generic value
+        # Something like 'sqreen:agent:ruby:1.11.1'
+        # XXX: do not provide default and force user to explicitly set source?
+        attr_accessor :default_source
+
         # @param [String] url
         def proxy_url=(url)
           if url.nil?
@@ -59,6 +71,8 @@ module Sqreen
         logger.progname = 'sqreen-kit'
 
         self.ingestion_url = 'https://ingestion.sqreen.com/'
+
+        self.default_source = "sqreen:kit:#{Sqreen::Kit.version}"
       end
 
       set_defaults

data/lib/sqreen/kit/http_client.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'net/http'
 require 'uri'
 
@@ -32,6 +37,7 @@ module Sqreen
                                 opts[:proxy_port], opts[:proxy_user],
                                 opts[:proxy_pass])
         @http.use_ssl = @base_url.scheme.downcase == 'https'
+        @http.cert_store = opts[:certificate_store]
         @http.verify_mode = OpenSSL::SSL::VERIFY_NONE if ENV['SQREEN_SSL_NO_VERIFY'] # for testing
 
         @http.open_timeout = opts[:connect_timeout] || DEFAULT_CONNECT_TIMEOUT_S

data/lib/sqreen/kit/http_client/authentication_error.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/http_client/unexpected_status_error'
 
 module Sqreen

data/lib/sqreen/kit/http_client/unexpected_status_error.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 module Sqreen
   module Kit
     class HttpClient

data/lib/sqreen/kit/loggable.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/configuration'
 
 module Sqreen

data/lib/sqreen/kit/retry_policy.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/loggable'
 
 module Sqreen

data/lib/sqreen/kit/signals/actor.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/signals/dto_helper'
 
 module Sqreen

data/lib/sqreen/kit/signals/auth_signals_client.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/signals/signals_client'
 
 module Sqreen

data/lib/sqreen/kit/signals/batch_collector.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/loggable'
 
 module Sqreen

data/lib/sqreen/kit/signals/context/http_context.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/signals/dto_helper'
 
 # reference: https://github.com/sqreen/SignalsSchemas/blob/master/schemas/context/http/2020-01-01T00_00_00_000Z/schema.cue
@@ -18,7 +23,7 @@ class Sqreen::Kit::Signals::Context::HttpContext
                   :params_json, :params_other].freeze
 
   SCHEMA_VERSION = 'http/2020-01-01T00:00:00.000Z'.freeze
-  add_mandatory_attrs :headers, :user_agent, :scheme, :verb,
+  add_mandatory_attrs :headers, :scheme, :verb,
                       :host, :port, :remote_ip, :remote_port, :path
 
   # @return [String]
@@ -102,6 +107,14 @@ class Sqreen::Kit::Signals::Context::HttpContext
   # @return [String]
   attr_accessor :content_type
 
+  # Datadog trace id
+  # @return [Integer]
+  attr_accessor :datadog_trace_id
+
+  # Datadog span id
+  # @return [Integer]
+  attr_accessor :datadog_span_id
+
   def to_h
     check_mandatories
 
@@ -134,6 +147,9 @@ class Sqreen::Kit::Signals::Context::HttpContext
                                content_type: content_type,
                                content_length: content_length,
                              }),
-    }
+    }.merge!(compact_hash(
+               datadog_trace_id: datadog_trace_id,
+               datadog_span_id: datadog_span_id,
+    ))
   end
 end

data/lib/sqreen/kit/signals/dto_helper.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'json'
 
 module Sqreen
@@ -9,6 +14,8 @@ module Sqreen
           NilClass, Hash, Array, Numeric, TrueClass, FalseClass
         ].freeze
 
+        RFC_3339_FMT = '%Y-%m-%dT%H:%M:%S.%3N%:z'.freeze
+
         module ClassMethods
           # method should have been defined initially in an ancestor
           def validate_str_attr(attr, regex)
@@ -49,8 +56,17 @@ module Sqreen
             @self_mandatory_attrs += args
           end
 
+          def readonly_attrs(*attrs)
+            attrs.each do |attr|
+              define_method :"#{attr}=" do |value|
+                raise "Attribute #{attr} is read-only" unless public_send(attr).nil?
+                super(value)
+              end
+            end
+          end
+
           def self_mandatory_attrs
-            @self_mandatory_attrs || []
+            @self_mandatory_attrs ||= []
           end
 
           def mandatory_attrs
@@ -76,11 +92,14 @@ module Sqreen
             end
 
             define_method attr do
-              cur_val = instance_variable_get("@#{attr}")
+              var = "@#{attr}"
+              return nil unless instance_variable_defined?(var)
+
+              cur_val = instance_variable_get(var)
 
               return nil if cur_val.nil?
               return cur_val if cur_val.is_a?(String)
-              cur_val.strftime('%Y-%m-%dT%H:%M:%S.%L%z')
+              cur_val.strftime(RFC_3339_FMT)
             end
           end
 
@@ -128,7 +147,9 @@ module Sqreen
         end
 
         def to_json
-          res = (@filters || []).reduce(to_h) { |accum, filter| filter[accum] }
+          return to_h.to_json unless instance_variable_defined?(:@filters)
+
+          res = @filters.reduce(to_h) { |accum, filter| filter[accum] }
           res.to_json
         end
 

data/lib/sqreen/kit/signals/metric.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/signals/dto_helper'
 require 'sqreen/kit/signals/signal'
 

data/lib/sqreen/kit/signals/point.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/signals/dto_helper'
 require 'sqreen/kit/signals/signal'
 

data/lib/sqreen/kit/signals/signal.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/signals/dto_helper'
 require 'sqreen/kit/signals/signal_attributes'
 

data/lib/sqreen/kit/signals/signal_attributes.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/signals/dto_helper'
 require 'sqreen/kit/signals/stack_trace'
 require 'sqreen/kit/signals/actor'
@@ -55,6 +60,14 @@ module Sqreen
         # @param [Exception] e
         attr_writer :exception
 
+        # Datadog trace id
+        # @return [Integer]
+        attr_accessor :datadog_trace_id
+
+        # Datadog span id
+        # @return [Integer]
+        attr_accessor :datadog_span_id
+
         def stack_trace
           if @exception
             Sqreen::Kit::StackTrace.parse(@exception)
@@ -95,8 +108,10 @@ module Sqreen
 
         def to_h
           {
-            agent_type: 'ruby',
-          }.merge(super())
+            infra: {
+              agent_type: 'ruby',
+            }.merge(super()),
+          }
         end
       end
     end # module Signals

data/lib/sqreen/kit/signals/signals_client.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/http_client'
 
 module Sqreen

data/lib/sqreen/kit/signals/stack_trace.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 # Includes code from Airbrake Technologies, Inc., under the MIT licence
 # see https://github.com/airbrake/airbrake-ruby/blob/c172657dcd4eeaf62ea23f0f7d6111be2373ea59/LICENSE.md
 

data/lib/sqreen/kit/signals/trace.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 require 'sqreen/kit/signals/dto_helper'
 require 'sqreen/kit/signals/signal'
 require 'sqreen/kit/signals/signal_attributes'

data/lib/sqreen/kit/string_sanitizer.rb

@@ -1,3 +1,8 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
 module Sqreen
   module Kit
     module StringSanitizer

data/lib/sqreen/kit/version.rb

@@ -0,0 +1,15 @@
+# typed: ignore
+
+# Copyright (c) 2015 Sqreen. All Rights Reserved.
+# Please refer to our terms for more information: https://www.sqreen.com/terms.html
+
+# Split to avoid a circular dependency between kit.rb and configuration.rb
+module Sqreen
+  module Kit
+    class << self
+      def version
+        @version ||= Gem.loaded_specs['sqreen-kit'].version
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sqreen-kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Loic Nageleisen
 - Gustavo Lopes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqreen-backport
@@ -25,8 +25,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -34,7 +34,6 @@ files:
 - CHANGELOG.md
 - LICENSE
 - lib/sqreen-kit.rb
-- lib/sqreen.rb
 - lib/sqreen/kit.rb
 - lib/sqreen/kit/configuration.rb
 - lib/sqreen/kit/http_client.rb
@@ -55,12 +54,13 @@ files:
 - lib/sqreen/kit/signals/stack_trace.rb
 - lib/sqreen/kit/signals/trace.rb
 - lib/sqreen/kit/string_sanitizer.rb
+- lib/sqreen/kit/version.rb
 homepage: https://sqreen.com
 licenses:
 - Sqreen
 metadata:
   source_code_uri: https://github.com/sqreen/ruby-sdk
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Sqreen development kit for Ruby
 test_files: []

data/lib/sqreen.rb

@@ -1 +0,0 @@
-module Sqreen; end