stackify-ruby-apm 1.8.0 → 1.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a671e23d695c474d3aafa85df6756d98fa51610411f40e2c750a8e2e5ad2bb1
-  data.tar.gz: c34ada9683508fbf2345434260c616100a5394fc58c22c4ea5eeceb8e7be78fe
+  metadata.gz: 6f7fd8fff02ed67e5112d4b59f84063cdebd84862e05f84376bd98c3237c3625
+  data.tar.gz: 0b59b1c98df2313f254e0f3f10fbe9291510e9316360d839c1073beee9100ab0
 SHA512:
-  metadata.gz: 135db2d570f4d24b94ebd39f70909eb1ca21beb52052eaf25f1788d339039803f229ccdfaea00618386f6656378ae934e79f4a85d4c8eee059ff3941794b9c3f
-  data.tar.gz: b6d344829e9d14e8736bf3e0807fe2c9995d859a733fd1b79920196bc30df3afeac1c2374ad469e1a4bffe9428f43b258243af5138c61981e627ba14f37928f7
+  metadata.gz: f347b093845bedd23269048c352aeac43b9bde434f22d9805e60fba67d08bd0eb1907d052f8f3b522f1b3452faaf4a1c02fb332ae28abd49bdba37e65bd6d714
+  data.tar.gz: 71f935e7e9096c5a4e4c1d365b8e45790364f77a4e6045f0af2fe79e5475662eaa93937de6a95a7c5e8b15a55e0b57c947bbe28da7f9c0d081da6cdf8886efa6

data/lib/stackify-ruby-apm-lambda.rb

@@ -0,0 +1 @@
+require 'stackify_ruby_apm_lambda'

data/lib/stackify_apm/agent.rb

@@ -118,6 +118,10 @@ module StackifyRubyAPM
     # Stores transaction in queue
     #
     def enqueue_transaction(transaction)
+      if !@config.queue
+        return @trace_logger.post([transaction])
+      end
+
       boot_worker unless worker_running?
       pending_transactions.push(transaction)
       return unless should_flush_transactions?

data/lib/stackify_apm/config.rb

@@ -8,7 +8,12 @@ require 'logger'
 require 'yaml'
 require 'socket'
 module StackifyRubyAPM
-  TRANSPORT = [TRACE_LOG = 'default'.freeze, UNIX_SOCKET = 'agent_socket'.freeze, AGENT_HTTP = 'agent_http'.freeze].freeze
+  TRANSPORT = [
+    TRACE_LOG = 'default'.freeze,
+    UNIX_SOCKET = 'agent_socket'.freeze,
+    AGENT_HTTP = 'agent_http'.freeze,
+    LOGGING = 'logging'.freeze
+].freeze
 
   # @api private
   class Config
@@ -62,7 +67,10 @@ module StackifyRubyAPM
       stackify_properties_file: '/usr/local/stackify/stackify-ruby-apm/stackify.properties',
       agent_traces_url: '/traces',
       unix_socket_path: '/usr/local/stackify/stackify.sock',
-      transport_http_endpoint: 'https://localhost:10601'
+      transport_http_endpoint: 'https://localhost:10601',
+
+      queue: true,
+      lambda_handler: ''
     }.freeze
 
     ENV_TO_KEY = {
@@ -87,7 +95,9 @@ module StackifyRubyAPM
       'STACKIFY_SPAN_FRAMES_MIN_DURATION' => [:int, 'span_frames_min_duration'],
       'STACKIFY_MAX_QUEUE_SIZE' => [:int, 'max_queue_size'],
       'STACKIFY_FLUSH_INTERVAL' => 'flush_interval_seconds',
-      'STACKIFY_DISABLED_SPIES' => [:list, 'disabled_spies']
+      'STACKIFY_DISABLED_SPIES' => [:list, 'disabled_spies'],
+      'STACKIFY_QUEUE' => [:bool, 'queue'],
+      'STACKIFY_LAMBDA_HANDLER' => 'lambda_handler'
     }.freeze
 
     def initialize(options = {})
@@ -158,6 +168,9 @@ module StackifyRubyAPM
     attr_accessor :root_path
     attr_accessor :http_status
 
+    attr_accessor :queue
+    attr_accessor :lambda_handler
+
     attr_reader :client_id
     attr_reader :device_id
     attr_reader :apm_disabled_in_rake
@@ -221,11 +234,18 @@ module StackifyRubyAPM
       new_available_spies - disabled_spies
     end
 
+    # Default Transport
+    #
+    # initialize default logger transport
     def debug_logger
-      debugger_logpath = log_path == '-' ? $stdout : log_path
-      logger = StackifyLogger.new(debugger_logpath, debugger_filenum_rotate, debugger_byte_size)
-      logger.level = log_level
-      self.logger = logger
+      case @transport.downcase
+      # For unix socket we don't create a trace log file
+      when StackifyRubyAPM::TRACE_LOG
+        debugger_logpath = log_path == '-' ? $stdout : log_path
+        logger = StackifyLogger.new(debugger_logpath, debugger_filenum_rotate, debugger_byte_size)
+        logger.level = log_level
+        self.logger = logger
+      end
     end
 
     private

data/lib/stackify_apm/context.rb

@@ -12,12 +12,19 @@ module StackifyRubyAPM
   class Context
     include NaivelyHashable
 
-    attr_accessor :request, :response
+    attr_accessor :request, :response, :aws
     attr_reader :custom, :tags
 
     def initialize
       @custom = {}
       @tags = {}
     end
+
+    # add aws context to context instance
+    #
+    # values {arn}
+    def add_aws_context ctx
+      @aws = ctx
+    end
   end
 end

data/lib/stackify_apm/root_info.rb

@@ -15,6 +15,15 @@ module StackifyRubyAPM
     def build
       # get process id
       pid = $PID || Process.pid
+      # get hostname and remove extra unwanted characters
+      begin
+        hostname = (@config.hostname || `hostname`).strip
+      rescue StandardError
+        # use socket to get hostname if `hostname` throws exception
+        require 'socket'
+        hostname = Socket.gethostname
+      end
+
       hash = {
         CATEGORY: 'Ruby',
         APPLICATION_PATH: '/',
@@ -26,7 +35,7 @@ module StackifyRubyAPM
         THREAD_ID: Thread.current.object_id,
         TRACE_SOURCE: 'RUBY',
         TRACE_TARGET: 'RETRACE',
-        HOST_NAME: (@config.hostname || `hostname`).strip,
+        HOST_NAME: hostname,
         OS_TYPE: StackifyRubyAPM::Util.host_os,
         PROCESS_ID: pid,
         TRACE_VERSION: '2.0',
@@ -36,6 +45,7 @@ module StackifyRubyAPM
       hash[:STATUS] = @transaction.context.response.status_code if @transaction.context && @transaction.context.response && @transaction.context.response.status_code
       hash[:URL] = @transaction.context.request.url[:full] if @transaction.context && @transaction.context.request && @transaction.context.request.url[:full]
       hash[:RUM] = true if @config.rum_enabled.is_a?(TrueClass)
+      hash[:AWS_LAMBDA_ARN] = @transaction.context.aws[:arn] if @transaction.context && @transaction.context.aws && @transaction.context.aws[:arn]
       hash
     end
     # rubocop:enable Metrics/CyclomaticComplexity

data/lib/stackify_apm/transport/aws_lambda_logging.rb

@@ -0,0 +1,53 @@
+require 'base64'
+require 'stringio'
+require 'zlib'
+require 'stackify_apm/root_info'
+require 'stackify_apm/serializers'
+
+
+module StackifyRubyAPM
+  # This class will handle the writing of messages through a logfile.
+  # @api private
+  class AWSLoggerClient
+    include Log
+    COMPRESS_DEFAULT_LEVEL = 6
+
+    def initialize(config)
+      @config = config
+      @transaction_serializers = Serializers::Transactions.new(@config)
+      @logger = Logger.new(STDOUT)
+      @logger.level = :debug
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        "STACKIFY-TRACE: #{msg}\n"
+      end
+    end
+
+    # This method will build an Array of Transactions in a json format.
+    # It will accept Array of transactions.
+    def post(transactions = [])
+      # convert transactions to json
+      json_traces = []
+      transactions.each  do |transaction|
+        # convert transaction to json
+        json_transaction = @transaction_serializers.build_json(@config, transaction).to_json
+
+        # add to json traces array
+        json_traces.push(json_transaction)
+      end
+
+      return unless ENV['STACKIFY_RUBY_ENV'] != 'rspec'
+
+      json_traces.each do |json_trace|
+        str = StringIO.new mode='w'
+        gz = Zlib::GzipWriter.new str, 6
+        gz.write json_trace.to_s
+        gz.close
+        compressed = Base64.strict_encode64 str.string
+        @logger.debug compressed
+      end
+      debug '[LogClient] post() Successfully write to logfile.' if ENV['STACKIFY_TRANSPORT_LOG_LEVEL'] == '0'
+    rescue StandardError => e
+      debug "[LogClient] post() exception: #{e.inspect}"
+    end
+  end
+end

data/lib/stackify_apm/transport_selector.rb

@@ -14,6 +14,8 @@ module StackifyRubyAPM
           StackifyRubyAPM::UnixSocketClient.new(config)
         when StackifyRubyAPM::AGENT_HTTP
           StackifyRubyAPM::AgentHTTPClient.new(config)
+        when StackifyRubyAPM::LOGGING
+          StackifyRubyAPM::AWSLoggerClient.new(config)
         else
           StackifyRubyAPM::LogClient.new(config)
         end

data/lib/stackify_apm/version.rb

@@ -2,5 +2,5 @@
 
 # Sets the version of the APM
 module StackifyRubyAPM
-  VERSION = '1.8.0'.freeze
+  VERSION = '1.9.5'.freeze
 end

data/lib/stackify_ruby_apm.rb

@@ -33,6 +33,7 @@ require 'stackify_apm/transport/agent_base'
 require 'stackify_apm/transport/log_client'
 require 'stackify_apm/transport/unix_socket_client'
 require 'stackify_apm/transport/agent_http_client'
+require 'stackify_apm/transport/aws_lambda_logging'
 
 require 'google/protobuf'
 require 'proto/stackify_trace'

data/lib/stackify_ruby_apm_lambda.rb

@@ -0,0 +1,62 @@
+require 'stackify_ruby_apm'
+
+module AWS
+  def self.instrument
+    config = {
+      transport: 'logging',
+      queue: false,
+    }
+    StackifyRubyAPM.start config
+  end
+
+  def self.handler(event:, context:, &block)
+    begin
+      ctx = StackifyRubyAPM::Context.new
+      ctx.add_aws_context({:arn => context.invoked_function_arn})
+      transaction = StackifyRubyAPM.transaction context.function_name, 'TASK', context: ctx
+      ret = block.call
+    rescue StackifyRubyAPM::InternalError
+      raise # Don't report StackifyRubyAPM errors
+    rescue StandardError => e
+      StackifyRubyAPM.report e
+      raise e
+    ensure
+      transaction.submit()
+    end
+    ret
+  end
+
+  # STACKIFY LAMBDA HANDLER
+  #
+  # @return original function execution
+  def self.stackify_handler(event:, context:)
+    begin
+      if !StackifyRubyAPM.running?
+        config = {
+          transport: 'logging',
+          queue: false,
+        }
+        StackifyRubyAPM.start config
+      end
+
+      ctx = StackifyRubyAPM::Context.new
+      ctx.add_aws_context({:arn => context.invoked_function_arn})
+      transaction = StackifyRubyAPM.transaction context.function_name, 'TASK', context: ctx
+
+      lambda_handler = StackifyRubyAPM.agent.config.lambda_handler.split('.')
+      function_file = lambda_handler[0]
+      function_name = lambda_handler[-1]
+
+      require "./#{function_file}"
+
+      send(function_name, event: event, context: context)
+    rescue StackifyRubyAPM::InternalError
+      raise # Don't report StackifyRubyAPM errors
+    rescue StandardError => e
+      StackifyRubyAPM.report e
+      raise e
+    ensure
+      transaction.submit()
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackify-ruby-apm
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.5
 platform: ruby
 authors:
 - Stackify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,18 +143,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gemignore"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
-- docker-compose.yml
 - lib/proto/stackify_trace.rb
+- lib/stackify-ruby-apm-lambda.rb
 - lib/stackify-ruby-apm.rb
 - lib/stackify_apm/agent.rb
 - lib/stackify_apm/config.rb
@@ -218,6 +213,7 @@ files:
 - lib/stackify_apm/transaction.rb
 - lib/stackify_apm/transport/agent_base.rb
 - lib/stackify_apm/transport/agent_http_client.rb
+- lib/stackify_apm/transport/aws_lambda_logging.rb
 - lib/stackify_apm/transport/log_client.rb
 - lib/stackify_apm/transport/unix_socket_client.rb
 - lib/stackify_apm/transport_selector.rb
@@ -230,6 +226,7 @@ files:
 - lib/stackify_apm/version.rb
 - lib/stackify_apm/worker.rb
 - lib/stackify_ruby_apm.rb
+- lib/stackify_ruby_apm_lambda.rb
 - stackify-ruby-apm.gemspec
 homepage: http://www.stackify.com
 licenses:

data/.gemignore

@@ -1,8 +0,0 @@
-test
-spec
-features
-docs
-docker
-docker-compose.xml
-deploy-*.sh
-run-*.sh

data/.gitignore

@@ -1,76 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore all logfiles and tempfiles.
-/log/*
-/tmp/*
-!/log/.keep
-!/tmp/.keep
-
-# Ignore bundler config.
-/.bundle
-
-# Deps
-node_modules
-
-# IDE
-.idea
-
-# VS Code
-.vscode
-.vs
-
-# Unnecessary since this will be a plugin
-package-lock.json
-
-# Folder config file
-Desktop.ini
-
-# Windows shortcuts
-*.lnk
-
-### OSX ###
-/**/.DS_Store
-/.DS_Store
-.AppleDouble
-.LSOverride
-
-# Thumbnails
-._*
-
-# Files that might appear on external disk
-.Spotlight-V100
-.Trashes
-
-### Linux ###
-*~
-
-# Windows image file caches
-Thumbs.db
-ehthumbs.db
-
-# Ignore .byebug_history, .rspec, brakeman.html
-.byebug_history
-.rspec
-brakeman.html
-
-
-# Gem
-*.gem
-
-#bin
-bin
-bin/*
-

data/.rubocop.yml

@@ -1,38 +0,0 @@
-AllCops:
-  RubyInterpreters:
-    - ruby
-    - macruby
-    - rake
-    - jruby
-    - rbx
-
-  Exclude:
-    - 'node_modules/**/*'
-    - 'vendor/**/*'
-    - '.git/**/*'
-    - 'spec/**/*'
-
-Naming/FileName:
-  Exclude:
-    - 'lib/stackify-ruby-apm.rb'
-
-Metrics/LineLength:
-  Max: 1000
-
-Metrics/BlockLength:
-  Max: 1000
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Max: 1000
-
-Style/RedundantFreeze:
-  Enabled: false
-
-Style/SafeNavigation:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0-p648

data/docker-compose.yml

@@ -1,46 +0,0 @@
-version: "3"
-services:
-
-  dbpostgresql:
-    image: postgres
-    volumes:
-      - postgresdata:/var/lib/postgresql/data
-    ports:
-      - 5433:5432
-    environment:
-      POSTGRES_DB: PostgresTestDB
-      POSTGRES_USER: bob
-      POSTGRES_PASSWORD: password
-    container_name: sinatra_activerecord_postgres_test
-
-  dbmysql:
-    image: mysql:5.7
-    volumes:
-      - mysqldata:/var/lib/mysql
-    ports:
-      - 3305:3306
-    environment:
-      - MYSQL_ROOT_PASSWORD=secret
-      - MYSQL_USER=bob
-      - MYSQL_PASSWORD=password
-      - MYSQL_DATABASE=MysqlTestDB
-    container_name: sinatra_activerecord_mysql_test
-
-  dbmongo:
-    image: mongo:3.6
-    volumes:
-      - mongodata:/data/db
-      - mongodata_config:/data/configdb
-    ports:
-      - 27018:27017
-    container_name: sinatra_activerecord_mongo_test
-
-volumes:
-  postgresdata:
-    driver: local
-  mysqldata:
-    driver: local
-  mongodata:
-    driver: local
-  mongodata_config:
-    driver: local