appoptics_apm 4.10.1 → 4.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e70295e3dc49a39e001776c90ae399d1c1ee522
-  data.tar.gz: bc03b3d467a18370ce889b6c66228172a41efd5c
+SHA256:
+  metadata.gz: 6407eda7d31bb8fe541c0dc6295a82229c72a4fdcca5208f10cc30eae7c22d2c
+  data.tar.gz: 8dcfafc3e7bb8caf5c93afc6a54e5682cc9eea0dc790ec5a6334458b1b98107e
 SHA512:
-  metadata.gz: f9d957a9d608fd1c3e3499125c96784b9767485934666986c8ecc1ca6befe89d870eb67b087887d5e6caf274452522e52c70dd773bf624a3144c225334688fe8
-  data.tar.gz: 01e0625d7242ea1717d5264e65ab3b53df8f4e534e08ba7c67e6959a1e0478d81cdc2dcb6c08d7361008bdf78dbfd962879a59e0fd2ce3302d5c4e9e38e57d1a
+  metadata.gz: e4f04e064600294fa39899f61fb153816c90bb5969fa1a9173ed65925e9f4e2f36e61670098fe5ecb7e18ddcf0995b9aac4150d1048510ae3127fe950e7bf52b
+  data.tar.gz: b33f037425f2b7d1d19cbd069456f75c28b97de0906b2a9950a2b1fa408771c083f8b5dc811480a0f9b60f21437ddd6e50ea37fd22fff3c36cb51bbb9782f057

data/.gitignore

@@ -1,34 +1,38 @@
-oboe*.gem
+*.code-workspace
+*.gem
 *.lock
-gemfiles/*.lock
-.ruby-version
-*~
 *.swp
+*.vscode
+*~
+.*byebug*
+.bundle
 .env
-lib/oboe_metal.so
+.github
+.irb_history
+.irbrc
+.ruby-version
+.travis
+.vagrant
+.yardoc
+builds
+coverage
+config
+doc
+ext/oboe_metal/*.o
 ext/oboe_metal/Makefile
+ext/oboe_metal/lib/liboboe*so*
 ext/oboe_metal/mkmf.log
 ext/oboe_metal/oboe_metal.so
 ext/oboe_metal/oboe_noop.so
-ext/oboe_metal/*.o
-ext/oboe_metal/lib/liboboe*so*
+ext/oboe_metal/src/bson/*
 ext/oboe_metal/src/oboe.h
 ext/oboe_metal/src/oboe.hpp
 ext/oboe_metal/src/oboe_debug.h
 ext/oboe_metal/src/oboe_wrap.cxx
-ext/oboe_metal/src/bson/*
-log/
-.vagrant
-gemfiles/.bundle
-swig*
-*.gem
-.yardoc
-coverage
-doc
-.*byebug*
 gemfiles/vendor*
+lib/rb_appoptics_apm.so
+lib/oboe_metal.so
+log
+oboe*.gem
 scrap*
-.irbrc
-*.code-workspace
-.irb_history
-.bundle/
+swig*

data/.rubocop.yml

@@ -1,8 +1,29 @@
-Metrics/LineLength:
-  Max: 120
+Style/StringLiterals:
+  Description: 'Checks if uses of quotes match the configured preference.'
+  StyleGuide: '#consistent-string-literals'
+  Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+Layout/LineLength:
+  Description: 'Limit lines to 80 characters.'
+  Enabled: false
 
-Layout/TrailingWhitespace:
-  Enabled: false
+Naming/VariableNumber:
+  Description: 'Use the configured style when numbering variables.'
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Description: >-
+    Add the frozen_string_literal comment to the top of files
+    to help transition to frozen string literals by default.
+  Enabled: false
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Metrics/BlockLength:
+  Exclude:
+    - test/*/*_test.rb

data/.travis.yml

@@ -8,14 +8,13 @@ cache:
 env:
   - DBTYPE=postgresql
   - DBTYPE=mysql2
-  - DBTYPE=mysql
 
 rvm:
+  - 2.7.0
   - 2.6.4
   - 2.5.5
   - 2.4.5
-  - 2.7.0-preview2
-#  - ruby-head
+  - ruby-head
 #  - jruby-9.0.5.0
 
 gemfile:
@@ -34,42 +33,14 @@ matrix:
   exclude:
     - rvm: ruby-head
       gemfile: gemfiles/rails42.gemfile
-    - rvm: 2.7.0-preview2
+    - rvm: 2.7.0
       gemfile: gemfiles/rails42.gemfile
     - rvm: 2.6.4
       gemfile: gemfiles/rails42.gemfile
     - rvm: 2.4.5
       gemfile: gemfiles/rails60.gemfile
-
-    - rvm: ruby-head
-      env: DBTYPE=mysql
-    - rvm: 2.7.0-preview2
-      env: DBTYPE=mysql
-    - rvm: 2.6.4
-      env: DBTYPE=mysql
-    - rvm: 2.5.5
-      env: DBTYPE=mysql
-    - rvm: 2.4.5
-      env: DBTYPE=mysql
-
-    - gemfile: gemfiles/unit.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/noop.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/libraries.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/instrumentation_mocked.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/instrumentation_mocked_oldgems.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/frameworks.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/rails52.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/rails60.gemfile
-      env: DBTYPE=mysql
-    - gemfile: gemfiles/delayed_job.gemfile
-      env: DBTYPE=mysql
+    - rvm: 2.4.5  # excluding because of new sprockets version (4.0.0)
+      gemfile: gemfiles/rails52.gemfile
 
     - gemfile: gemfiles/unit.gemfile
       env: DBTYPE=mysql2
@@ -87,9 +58,9 @@ matrix:
       env: DBTYPE=mysql2
   allow_failures:
     - rvm: ruby-head
-    - rvm: 2.7.0-preview2
 
-# FIXME: Figure out if this is still an issue when reviewing cassandra test setup
+# FIXME: No cassandra tests for now
+# ____   Figure out if this is still an issue when reviving cassandra
 # Attempt Travis/Cassandra fix re: https://github.com/travis-ci/travis-ci/issues/1484
 # Updated Cassandra: https://github.com/travis-ci/travis-ci/issues/1650
 
@@ -104,23 +75,32 @@ matrix:
 #  - sudo service cassandra start
 
 install:
-  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.12/swig-3.0.12.tar.gz
-  - tar xzf swig-3.0.12.tar.gz
-  - pushd swig-3.0.12
+  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-4.0.2/swig-4.0.2.tar.gz
+  - tar xzf swig-4.0.2.tar.gz
+  - pushd swig-4.0.2
   - ./configure && make && sudo make install
   - popd
 
+# use swig from git in case fixes haven't been released
+#  - git clone https://github.com/swig/swig.git
+#  - pushd swig
+#  - ./autogen.sh
+#  - ./configure && make && sudo make install
+#  - popd
+
 before_script:
   - export APPOPTICS_GEM_TEST=true
   - export APPOPTICS_REPORTER=file
   - export APPOPTICS_COLLECTOR=/tmp/appoptics_traces.bson
   - export APPOPTICS_REPORTER_FILE_SINGLE=false
-  - export APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
-  - export APPOPTICS_TOKEN_BUCKET_RATE=1000
+#  - export APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
+#  - export APPOPTICS_TOKEN_BUCKET_RATE=1000
   - export APPOPTICS_FROM_S3=true
+  - export OBOE_VERSION=10.0.0
 
-  - bundle update --jobs=3 --retry=3
-  - bundle exec rake clean fetch compile
+#  - bundle update --jobs=3 --retry=3
+  - ./.travis/bundle.sh
+  - bundle exec rake distclean fetch compile
   - psql -c 'create database travis_ci_test;' -U postgres
   - mysql -e 'create database travis_ci_test;'
   - redis-server --requirepass secret_pass &

data/Gemfile

@@ -1,29 +1,38 @@
 source 'https://rubygems.org'
-gem 'rake'
+
+# this Gemfile is very minimal
+# use rake commands or gemfiles in the gemfiles directory for testing
+
+gem 'rake', '>= 0.9.0'
 
 group :development, :test do
-  gem 'minitest'
-  gem 'minitest-reporters', '< 1.0.18'
-  gem 'minitest-debugger', :require => false
-  gem 'rack-test'
-  gem 'puma'
-  gem 'bson'
-  gem 'webmock' if RUBY_VERSION >= '2.0.0'
-  gem 'mocha'
-  gem 'rubocop', require: false
-  gem 'ruby-prof'
-  gem 'benchmark-ips'
-  gem 'ruby-debug',   :platforms =>  :jruby
-  gem 'debugger',     :platform  =>  :mri_19
-  gem 'byebug'
-  gem 'get_process_mem'
-  gem 'memory_profiler'
+  # gem 'benchmark-ips', '>= 2.7.2'
+  # gem 'bson'
+  gem 'byebug', '>= 8.0.0'
+  # gem 'debugger',     :platform  =>  :mri_19
+  # gem 'get_process_mem'
+  gem 'irb', '>= 1.0.0' # if RUBY_VERSION >= '2.6.0'
+  # gem 'memory_profiler'
+  # gem 'minitest'
+  # gem 'minitest-debugger', :require => false
+  # gem 'minitest-focus', '>=1.1.2'
+  # gem 'minitest-hooks', '>= 1.5.0'
+  # gem 'minitest-reporters', '< 1.0.18'
+  # gem 'mocha'
+  # gem 'puma'
+  # gem 'rack-test'
+  # gem 'rubocop', require: false
+  # gem 'ruby-debug',   :platforms =>  :jruby
+  # gem 'ruby-prof'
+  # gem 'simplecov', '>= 0.16.0'
+  # gem 'simplecov-console'
+  # gem 'webmock' if RUBY_VERSION >= '2.0.0'
 
-  if defined?(JRUBY_VERSION)
-    gem 'sinatra', :require => false
-  else
-    gem 'sinatra'
-  end
+  # if defined?(JRUBY_VERSION)
+  #   gem 'sinatra', :require => false
+  # else
+  #   gem 'sinatra'
+  # end
 end
 
 gemspec

data/appoptics_apm.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.version = AppOpticsAPM::Version::STRING
   s.date = Time.now.strftime('%Y-%m-%d')
 
-  s.license = "Librato Open License, Version 1.0"
+  s.license = "Librato Open License, Version 1.0, https://bit.ly/2Kmm0mN"
 
   s.authors = ["Maia Engeli", "Peter Giacomo Lombardo", "Spiros Eliopoulos"]
   s.email = %q{support@appoptics.com}
@@ -42,20 +42,21 @@ Automatic tracing and metrics for Ruby applications. Get started at appoptics.co
 
   s.extensions = ['ext/oboe_metal/extconf.rb'] unless defined?(JRUBY_VERSION)
 
-  s.add_runtime_dependency('json', '>= 0')
+  s.add_runtime_dependency('json')
   s.add_runtime_dependency('no_proxy_fix', '~> 0.1.2', '>= 0.1.2')
 
   # Development dependencies used in gem development & testing
-  s.add_development_dependency('rake', '>= 0.9.0')
-  s.add_development_dependency('simplecov', '>= 0.16.0') if ENV["SIMPLECOV_COVERAGE"]
-  s.add_development_dependency('simplecov-console', '>= 0.4.0') if ENV["SIMPLECOV_COVERAGE"]
-  s.add_development_dependency('irb', '>= 1.0.0') if RUBY_VERSION >= '2.6.0'
-
-  unless defined?(JRUBY_VERSION)
-    s.add_development_dependency('byebug', '>= 8.0.0')
-    s.add_development_dependency('minitest-hooks', '>= 1.5.0')
-    s.add_development_dependency('benchmark-ips', '>= 2.7.2')
-  end
+  # s.add_development_dependency('rake', '>= 0.9.0')
+  # s.add_development_dependency('simplecov', '>= 0.16.0') if ENV["SIMPLECOV_COVERAGE"]
+  # s.add_development_dependency('simplecov-console', '>= 0.4.0') if ENV["SIMPLECOV_COVERAGE"]
+  # s.add_development_dependency('irb', '>= 1.0.0') if RUBY_VERSION >= '2.6.0'
+  #
+  # unless defined?(JRUBY_VERSION)
+  #   s.add_development_dependency('byebug', '>= 8.0.0')
+  #   s.add_development_dependency('minitest-hooks', '>= 1.5.0')
+  #   s.add_development_dependency('minitest-focus', '>=1.1.2')
+  #   s.add_development_dependency('benchmark-ips', '>= 2.7.2')
+  # end
 
   s.required_ruby_version = '>= 2.4.0'
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/examples/sdk_examples.rb

@@ -0,0 +1,142 @@
+# Copyright (c) 2020 SolarWinds, LLC.
+# All rights reserved.
+
+###############################################################
+# SDK EXAMPLES
+###############################################################
+# The uses cases of the SDK include:
+# - tracing a piece of your own code
+# - tracing a method call of a gem that is not auto-instrumented
+#   by appoptics_apm
+#
+# SDK documentation:
+# https://rubydoc.info/gems/appoptics_apm/AppOpticsAPM/SDK
+
+###############################################################
+# Prerequisits
+# export APPOPTICS_SERVICE_KEY=<API token>:<service_name>
+# `bundle exec ruby sdk_examples.rb`
+# 5 traced requests will show up at https://my.appoptics.com/
+###############################################################
+
+require 'appoptics_apm'
+
+unless AppOpticsAPM::SDK.appoptics_ready?(10_000)
+  puts "aborting!!! Agent not ready after 10 seconds"
+  exit false
+end
+
+###############################################################
+### ADD A SPAN
+###############################################################
+#
+# AppOpticsAPM::SDK.trace()
+# This method adds a span to a trace that has been started either
+# by the auto-instrumentation of the gem handling incoming requests
+# or the SDK method `start_trace`.
+# If this method is called outside of the context of a started
+# trace no spans will be created.
+#
+# The argument is the name for the span
+
+AppOpticsAPM::SDK.trace('span_name') do
+  [9, 6, 12, 2, 7, 1, 9, 3, 4, 14, 5, 8].sort
+end
+
+###############################################################
+# START A TRACE, ADD A SPAN, AND LOG AN INFO EVENT
+###############################################################
+#
+# AppOpticsAPM::SDK.start_trace()
+# This method starts a trace.  It is handy for background jobs,
+# workers, or scripts, that are not part of a rack application
+
+AppOpticsAPM::SDK.start_trace('outer_span') do
+  AppOpticsAPM::SDK.trace('first_child_span') do
+    [9, 6, 12, 2, 7, 1, 9, 3, 4, 14, 5, 8].sort
+    AppOpticsAPM::SDK.log_info({ some: :fancy, hash: :to, send: 1 })
+  end
+end
+
+###############################################################
+# LOG AN ERROR EVENT
+###############################################################
+#
+# AppOpticsAPM::SDK.log_exception()
+# This method adds an error event to the trace, which will be
+# displayed and counted as exception on the appoptics dashboard.
+
+def do_raise
+  raise StandardError.new("oops")
+end
+
+AppOpticsAPM::SDK.start_trace('with_error') do
+  begin
+    do_raise
+  rescue => e
+    AppOpticsAPM::SDK.log_exception(e)
+  end
+end
+
+###############################################################
+# TRACE A METHOD
+###############################################################
+#
+# AppOpticsAPM::SDK.trace_method()
+# This creates a span every time the defined method is run.
+# The method can be of any (accessible) type (instance,
+# singleton, private, protected etc.).
+
+module ExampleModule
+  def self.do_sum(a, b)
+    a + b
+  end
+end
+
+AppOpticsAPM::SDK.trace_method(ExampleModule,
+                               :do_sum,
+                               { name: 'computation', backtrace: true },
+                               { CustomKey: "some_info"})
+
+AppOpticsAPM::SDK.start_trace('trace_a_method') do
+  ExampleModule.do_sum(1, 2)
+  ExampleModule.do_sum(3, 4)
+end
+
+###############################################################
+# SET A CUSTOM TRANSACTION NAME
+###############################################################
+#
+# AppOpticsAPM::SDK.set_transaction_name()
+#
+# this method can be called anytime after a trace has been started to add a
+# custom name for the whole transaction.
+# In case of a controller the trace is usually started in rack.
+
+class FakeController
+  def create(params)
+    # @fake = fake.new(params.permit(:type, :title))
+    # @fake.save
+    AppOpticsAPM::SDK.set_transaction_name("fake.#{params[:type]}")
+    # redirect_to @fake
+  end
+end
+
+AppOpticsAPM::SDK.start_trace('set_transaction_name') do
+  FakeController.new.create(type: 'news')
+end
+
+###############################################################
+# LOG INJECTION OF TRACE_ID
+###############################################################
+#
+# AppOpticsAPM::SDK.current_trace
+# This method creates an object with the current trace ID and
+# helper methods to add the ID to logs for cross-referencing.
+
+AppOpticsAPM::Config[:log_traceId] = :always
+
+AppOpticsAPM::SDK.start_trace('log_trace_id') do
+  trace = AppOpticsAPM::SDK.current_trace
+  AppOpticsAPM.logger.warn "Some log message #{trace.for_log}"
+end