apptrail-application-events-sdk 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a56d565f6da67bd2bc4bbfb36c20f599e0ef18bd7ec0f5e969caae6c592409c
-  data.tar.gz: b3c67d43208b9a8eb134bb529d023c33c24bae80b4485ed41dcc6ca224865131
+  metadata.gz: 033ced91d5d347d03c478bfd99656e901920d6eadb8823b19fd0b5751ac3b736
+  data.tar.gz: 38f63305471ef6aa3ea25392df9c5b72676b3410ab4d6ec5055c8d1597f655e2
 SHA512:
-  metadata.gz: 9955cd66982d262361d7cbfdd6672ce4f34ff03e4caf65fc883ddcede9ba0fc2d3386b7fe93e32e2f1cbeed1fc0ee3f1d4450c87131eb7e94491ce6f182ed5ce
-  data.tar.gz: 76618a0b1bd9f2800a37f167b2781210664da5bb4458a4be29c50d842d14d0e8c2f46bdafd4c3d353e1652625c08bd3062c007233a18b763c5f373a01010a0ce
+  metadata.gz: efe5076ba194024da52d8b9305fcaf7319717243eab7f2bba2320cfdb31eb353b194d4ee7fd350295e43520dfaedfa8cf5b4c881a3c2aecccc602527e82e31e9
+  data.tar.gz: 288c4f04e2508aaa7636d685dc14c873382f597ab96a7a83db99f0e2097580671cff16ff6c7bf7ade18e457757d0145c7593a60d10982a9176ce457091accf1c

data/README.md

@@ -62,8 +62,10 @@ event = {
       },
     },
   ],
-  sourceIpAddress: "103.6.179.245",
-  userAgent: "Apache-HttpClient/4.5.3 (Java/11.0.11)",
+  context: {
+    sourceIpAddress: "103.6.179.245",
+    userAgent: "Apache-HttpClient/4.5.3 (Java/11.0.11)"
+  },
   tags: {
     severity: "LOW",
   },

data/lib/apptrail-application-events-sdk.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'stringio'
-require "base64"
-require "json"
+require 'base64'
+require 'json'
 require 'securerandom'
-require "http"
-require "json-schema"
-require "retriable"
-
-#HTTP.default_options = HTTP::Options.new(features: {logging: { logger: Logger.new(STDOUT)}})
+require 'http'
+require 'json-schema'
+require 'retriable'
 
 module Apptrail
   class << self
@@ -15,15 +15,13 @@ module Apptrail
     # For example, log to STDOUT by setting this to Logger.new(STDOUT).
     #
     # @return [Logger]
-    attr_accessor :logger
+    attr_writer :logger
 
     def logger
       @logger ||= Logger.new($stdout).tap do |log|
-        log.progname = self.name
+        log.progname = name
       end
     end
-
-    
   end
 
   class ApptrailError < StandardError; end
@@ -34,10 +32,19 @@ module Apptrail
       tries: 3,
       base_interval: 0.04,
       on: Apptrail::ApptrailRetryableError,
-      on_retry: Proc.new { puts 'Retrying...' },
+      on_retry: proc { Apptrail.logger.debug('Retrying upload.') },
+      max_interval: 0.12,
+      max_elapsed_time: 4,
+      rand_factor: 0.2
+    }
+    c.contexts[:session] = {
+      tries: 3,
+      base_interval: 0.04,
+      on: Apptrail::ApptrailRetryableError,
+      on_retry: proc { Apptrail.logger.debug('Retrying refresh session.') },
       max_interval: 0.12,
       max_elapsed_time: 4,
-      rand_factor: 0.2,
+      rand_factor: 0.2
     }
   end
 
@@ -46,12 +53,9 @@ module Apptrail
   #
   # See [Sending events](https://apptrail.com/docs/applications/guide/working-with-events/overview).
   class ApptrailEventsClient
-    @_form_data = nil
-    @_upload_url = nil
-
     SCHEMA = JSON.parse(File.read(
-      File.expand_path('../raw-event-schema.json', __FILE__)
-    )).freeze
+                          File.expand_path('raw-event-schema.json', __dir__)
+                        )).freeze
     private_constant :SCHEMA
 
     def inspect
@@ -59,21 +63,29 @@ module Apptrail
     end
 
     def to_s
-      "ApptrailEventsClient{}"
+      'ApptrailEventsClient{}'
     end
 
     def initialize(region:, api_key:)
       @_region = region
       begin
         parsed_key = Base64.urlsafe_decode64(api_key)
-        application_id, *_  = parsed_key.split(',', 3)
+        application_id, = parsed_key.split(',', 3)
         @_application_id = application_id
-      rescue
-        raise ArgumentError, "Invalid API Key." 
+      rescue StandardError
+        raise ArgumentError, 'Invalid API Key.'
       end
 
       @_base_api_url = "https://events.#{region}.apptrail.com/applications/session"
       @_api_key = api_key
+      @_session_client = HTTP.persistent @_base_api_url
+
+      @_form_data = nil
+      @_upload_url = nil
+      @_upload_client = nil
+
+      @_finalize_id = SecureRandom.uuid
+      ObjectSpace.define_finalizer(@_finalize_id, proc { close })
     end
 
     # Send a single audit event to log to Apptrail.
@@ -83,88 +95,109 @@ module Apptrail
       put_events([event])
     end
 
-
     # Send a list of up to 1000 audit events to log to Apptrail.
     #
     # @param events [Array<ApptrailEvent>]] An array of events to log. See [Apptrail Event Format](https://apptrail.com/docs/applications/guide/event-format) for a full description of the event format.
     def put_events(events)
-      unless events.is_a?(Array)
-        raise TypeError, "Must pass in array of events."
-      end
-      unless events.length <= 1000
-        raise ArgumentError, "Can not send more than 1000 events in a single PutEvents call."
-      end
+      raise TypeError, 'Must pass in array of events.' unless events.is_a?(Array)
+      raise ArgumentError, 'Can not send more than 1000 events in a single PutEvents call.' unless events.length <= 1000
 
       begin
-        JSON::Validator.validate!(SCHEMA, events, :list => true, :parse_data => false)
+        JSON::Validator.validate!(SCHEMA, events, list: true, parse_data: false)
       rescue JSON::Schema::ValidationError => e
-        raise Apptrail::ApptrailError.new(e.message)
+        raise Apptrail::ApptrailError, e.message
       end
 
-      if @_upload_url.nil? || @_form_data.nil?
-        _refresh_post_policy()
-      end
+      _refresh_post_policy() if @_upload_url.nil? || @_form_data.nil? || @_upload_client.nil?
 
-      content = ""
+      content = StringIO.new
       events.each do |evt|
-        content << JSON.generate(evt)
+        content << JSON.fast_generate(evt)
         content << "\n"
       end
 
-      filename = SecureRandom.uuid + ".jsonl"
+      filename = "#{SecureRandom.uuid}.jsonl"
       s3_key = File.join(@_application_id, filename)
 
-      form_file = HTTP::FormData::File.new(StringIO.new(content), :filename => filename)
+      form_file = HTTP::FormData::File.new(StringIO.new(content.string), filename: filename)
 
       new_form_opts = {
         **@_form_data,
-        :key => s3_key,
-        :file => form_file
+        key: s3_key,
+        file: form_file
       }
 
+      resp = nil
       begin
         Retriable.with_context(:s3) do
-          resp = HTTP.post(@_upload_url, :form => new_form_opts)
-          if !resp.status.success?
-            if (resp.status.server_error?)
-              raise ApptrailRetryableError.new("Server Error while putting events.")
-            elsif (resp.status.client_error?)
-              if (resp.status.code === 403 && resp.body.to_s.include?("Policy expired"))
-                _refresh_post_policy()
-                raise ApptrailRetryableError.new("Session expired.")
+          resp = @_upload_client.post(@_upload_url, form: new_form_opts)
+          unless resp.status.success?
+            if resp.status.server_error?
+              raise ApptrailRetryableError, 'Server Error while putting events.'
+            elsif resp.status.client_error?
+              if resp.status.code == 403 && resp.body.to_s.include?('Policy expired')
+                _refresh_post_policy
+                raise ApptrailRetryableError, 'Session expired.'
               else
-                puts resp.body.to_s
-                raise ApptrailError.new("Error while putting events.")
+                raise ApptrailError, 'Error while putting events.'
               end
             else
-              raise ApptrailError.new("Error while putting events.")
+              raise ApptrailError, 'Error while putting events.'
             end
           end
         end
-      rescue
-        raise ApptrailError.new("Failed to put #{events.length} events. Encountered error.")
+      rescue StandardError
+        raise ApptrailError, "Failed to put #{events.length} events. Encountered error."
       else
-        Apptrail::logger.info("Successfully wrote #{events.length} events.")
+        Apptrail.logger.info("Successfully wrote #{events.length} events.")
+      ensure
+        resp.flush if resp
       end
+    end
 
+    def close
+      # https://github.com/appsignal/rdkafka-ruby/pull/160/files
+      ObjectSpace.undefine_finalizer(@_finalize_id)
+      @_session_client.close if @_session_client
+      @_upload_client.close if @_upload_client
     end
 
     private
 
     def _refresh_post_policy
-      puts @_base_api_url
-      resp = HTTP
-        .auth("Bearer #{@_api_key}")
-        .get(@_base_api_url)
-      if !resp.status.success?
-        raise ApptrailError.new("Error refreshing credentials, status code: #{resp.code}")
+      fail_default = -> { raise ApptrailError, "Error refreshing credentials." }
+      resp = nil
+
+      begin
+        Retriable.with_context(:session) do
+          resp = @_session_client
+             .auth("Bearer #{@_api_key}")
+             .get(@_base_api_url)
+
+          unless resp.status.success?
+            if resp.status.server_error?
+              raise ApptrailRetryableError, 'Server Error refreshing session.'
+            elsif resp.status.client_error?
+              if resp.status.code == 429
+                raise ApptrailRetryableError, 'Throttling'
+              else
+                fail_default.call
+              end
+            else
+              fail_default.call
+            end
+          end
+
+          result = JSON.parse(resp.body.to_s)
+          @_upload_url = result['uploadUrl']
+          @_form_data = result['form']
+          @_upload_client = HTTP.persistent @_upload_url
+        end
+      rescue StandardError => e
+        fail_default.call
+      ensure
+        resp.flush if resp
       end
-      result = JSON.parse(resp.body.to_s)
-      @_upload_url = result["uploadUrl"]
-      @_form_data = result["form"]
     end
-
-    
   end
-
 end

data/lib/raw-event-schema.json

@@ -53,21 +53,27 @@
         }
       }
     },
-    "sourceIpAddress": {
-      "type": "string",
-      "description": "The IP address the activity/request being recorded was made from.",
-      "oneOf": [
-        {
-          "format": "ipv4"
+    "context": {
+      "type": "object",
+      "description": "The context object contains fields that give customers additional information about the environment in and source from which the activity recorded occurred",
+      "properties": {
+        "sourceIpAddress": {
+          "type": "string",
+          "description": "The IP address the activity/request being recorded was made from.",
+          "anyOf": [
+            {
+              "format": "ipv4"
+            },
+            {
+              "format": "ipv6"
+            }
+          ]
         },
-        {
-          "format": "ipv6"
+        "userAgent": {
+          "type": "string",
+          "description": "The agent through which the request was made, e.g. `Mozilla/5.0` or `python-requests/2.20.1`."
         }
-      ]
-    },
-    "userAgent": {
-      "type": "string",
-      "description": "The agent through which the request was made, e.g. `Mozilla/5.0` or `python-requests/2.20.1`."
+      }
     },
     "eventDetails": {
       "type": "object",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apptrail-application-events-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Apptrail Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http