appoptics_apm 4.12.2 → 4.13.0

data/.github/workflows/scripts/test_install.rb

@@ -0,0 +1,23 @@
+# Copyright (c) 2021 SolarWinds, LLC.
+# All rights reserved.
+
+# Test script used to check if a newly created gem installs and connects to
+# the collector
+# requires env vars:
+# - APPOPTICS_SERVICE_KEY
+# - APPOPTICS_COLLECTOR (optional if the key is for production)
+
+require 'appoptics_apm'
+AppOpticsAPM.support_report
+exit 1 unless AppOpticsAPM.reporter
+
+AppOpticsAPM::Config[:profiling] = :enabled
+
+AppOpticsAPM::SDK.start_trace("install_test_profiling") do
+  AppOpticsAPM::Profiling.run do
+    10.times do
+      [9, 6, 12, 2, 7, 1, 9, 3, 4, 14, 5, 8].sort
+      sleep 0.2
+    end
+  end
+end

data/.github/workflows/test_on_4_linux.yml

@@ -0,0 +1,159 @@
+# Copyright (c) 2021 SolarWinds, LLC.
+# All rights reserved.
+
+name: Run Ruby Tests on 4 Linux
+
+on:
+  push:
+    paths-ignore:
+      - 'test/run_tests/Dockerfile_*'
+# Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  GHRC: ghcr.io/appoptics/appoptics-apm-ruby/apm_ruby
+  DOCKERFILE: test/run_tests/Dockerfile
+
+jobs:
+
+#-------------------------------------------------------------------------------
+# TODO: figure out how to build images first if necessary
+#
+# ********* this is not working because we don't have a    *************
+# ********* reference to the commit of the previous GH run *************
+#
+#  build_images:
+#    name: Build docker images if necessary
+#    runs-on: ubuntu-latest
+#
+#    strategy:
+#      fail-fast: true
+#      matrix:
+#        os: [ ubuntu, debian, centos, alpine ]
+#
+#    steps:
+#      - name: Checkout
+#        uses: actions/checkout@v2
+#
+#
+#  ##    comment out to get a debug session
+#  ##    only works with ubuntu and debian, because it uses apt:
+##      - name: tmate debugging session
+##        uses: mxschmitt/action-tmate@v3
+##        with:
+##          sudo: false
+#
+#      - name: check modified files
+#        id:   check_files
+#        run:  |
+#          git diff --name-only --diff-filter=ACMRT ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep Dockerfile_
+#          echo ::set-output name=check_dockerfiles::$?
+##          git diff --name-only HEAD^ HEAD | grep [D]ockerfile_
+##          echo ::set-output name=check_dockerfiles::$?
+#
+#      - name: ghcr.io login ... build and publish images if needed
+#        uses: docker/login-action@v1
+#        if: ${{ steps.check_files.outputs.check_dockerfiles == 0}}
+#        with:
+#          registry: ghcr.io
+#          username: ${{ github.actor }}
+#          password: ${{ secrets.GITHUB_TOKEN }}
+#
+#      - name: Build and publish new Docker image
+#        if: ${{ steps.check_files.outputs.check_dockerfiles == 0 }}
+#        run: |
+#          docker build -f ${{ env.DOCKERFILE }}_${{ matrix.os }} -t ${{ env.GHRC }}_${{ matrix.os }} .
+#          docker push ${{ env.GHRC }}_${{ matrix.os }}
+
+#-------------------------------------------------------------------------------
+  all_linux_test:
+    name: ${{ matrix.os }} - ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+#    needs: build_images
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, debian, centos, alpine]
+        ruby: ['3.0', '2.7', '2.6', '2.5', '2.4']
+
+    container:
+#      maybe github.repository works
+       image: ghcr.io/${{ github.repository }}/apm_ruby_${{ matrix.os }}
+
+    env:
+      APPOPTICS_GEM_TEST: true
+      APPOPTICS_REPORTER: file
+      APPOPTICS_COLLECTOR: /tmp/appoptics_traces.bson
+      APPOPTICS_MONGO_SERVER: "mongo"
+      APPOPTICS_RABBITMQ_SERVER: "rabbitmq"
+      APPOPTICS_MEMCACHED_SERVER: "memcached"
+      APPOPTICS_REPORTER_FILE_SINGLE: false
+      APPOPTICS_FROM_S3: true
+      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+      MYSQL_ROOT_PASSWORD: "admin"
+      MYSQL_HOST: "mysql"
+      MYSQL_DATABASE: "travis_ci_test"
+      POSTGRES_DB: "travis_ci_test"
+      DOCKER_MYSQL_PASS: "admin"
+      DOCKER_PSQL_PASS: "postgres"
+      POSTGRES_USER: "postgres"
+      POSTGRES_PASSWORD: "postgres"
+      POSTGRES_HOST: "postgres"
+      REDIS_PASSWORD: "redis_pass"
+      TEST_RUNS_TO_FILE: "true"
+
+    services:
+      memcached:
+        image: memcached:latest
+        ports:
+          - 11211:11211
+        options: --health-cmd "timeout 5 bash -c 'cat < /dev/null > /dev/udp/127.0.0.1/11211'" --health-interval 10s --health-timeout 5s --health-retries 5
+      rabbitmq:
+        image: rabbitmq:latest
+        ports:
+          - 5672:5672
+        options: --health-cmd "rabbitmqctl node_health_check" --health-interval 10s --health-timeout 5s --health-retries 5
+      mongo:
+        image: mongo:latest
+        ports:
+          - 27017:27017
+        options: "--health-cmd \"mongo --quiet --eval 'quit(db.runCommand({ ping: 1 }).ok ? 0 : 2)'\" --health-interval 10s --health-timeout 5s --health-retries 5"
+      postgres:
+        image: postgres:10.8
+        env:
+          POSTGRES_DB: travis_ci_test
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      mysql:
+        image: mariadb:latest
+        env:
+          MYSQL_USER: user
+          MYSQL_PASSWORD: password
+          MYSQL_DATABASE: travis_ci_test
+          MYSQL_ROOT_PASSWORD: admin
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
+
+    steps:
+    - name: Checkout ${{ github.ref }}
+      uses: actions/checkout@v2
+
+    - name: print some info
+      run: |
+        user=`whoami`
+        pwd=`pwd`
+        echo "User: $user"
+        echo "Current dir: $pwd"
+        echo "Home dir: $HOME"
+        echo "Branch: ${GITHUB_REF#refs/*/}"
+
+    - name: ruby tests
+      run: |
+        export HOME=/root
+        test/run_tests/ruby_setup.sh
+        version=`rbenv versions --bare | grep ${{ matrix.ruby }}`
+        echo "testing with ruby version: $version"
+        test/run_tests/run_tests.sh -r $version

data/.gitignore

@@ -1,44 +1,36 @@
-*.code-workspace
+!.keep
 *.gem
 *.lock
-*.o
-*.so
+*.log
 *.swp
-*.vscode
 *~
 .*byebug*
-.bundle
+.bundle/
 .env
 .irb_history
 .irbrc
 .ruby-version
-.travis/*
-.vagrant
-.yardoc
-builds
-coverage
-config
-doc
+.yardoc/
+app/
+builds/
+coverage/
+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/src/bson/*
-ext/oboe_metal/src/oboe.h
-ext/oboe_metal/src/oboe.hpp
+ext/oboe_metal/src/bson/
 ext/oboe_metal/src/oboe_api.cpp
+ext/oboe_metal/src/oboe.h
 ext/oboe_metal/src/oboe_api.hpp
 ext/oboe_metal/src/oboe_debug.h
-ext/oboe_metal/src/oboe_wrap.cxx
 ext/oboe_metal/src/oboe_swig_wrap.cc
-ext/oboe_metal/test
+ext/oboe_metal/test/build/
+ext/oboe_metal/test/MakeFile
+gemfiles/*.lock
+gemfiles/.bundle/
 gemfiles/vendor*
-log
-oboe*.gem
-scrap*
-swig*
-vendor
-ext/oboe_metal/experiments/
-ext/oboe_metal/test/
-test/run_tests/grpc_matrix/
+lib/libappoptics_apm.so
+vendor/

data/.travis.yml

@@ -10,11 +10,11 @@ env:
   - DBTYPE=mysql2
 
 rvm:
-  - 3.0.0 # appoptics_apm instrumentation not ready yet, probably ok, let's see
-  - 2.7.0
-  - 2.6.5
-  - 2.5.5
-  - 2.4.5
+  - 3.0.2
+  - 2.7.4
+  - 2.6.8
+  - 2.5.8
+  - 2.4.10
 #  - ruby-head
 #  - jruby-9.0.5.0
 
@@ -24,26 +24,26 @@ gemfile:
   - gemfiles/instrumentation_mocked.gemfile
   - gemfiles/instrumentation_mocked_oldgems.gemfile
   - gemfiles/frameworks.gemfile
-  - gemfiles/rails61.gemfile
   - gemfiles/rails60.gemfile
   - gemfiles/rails52.gemfile
   - gemfiles/rails42.gemfile
+  - gemfiles/profiling.gemfile
   - gemfiles/delayed_job.gemfile
   - gemfiles/noop.gemfile
 
 matrix:
   exclude:
-    - rvm: ruby-head
+    - rvm: 3.0.2
       gemfile: gemfiles/rails42.gemfile
-    - rvm: 2.7.0
+    - rvm: 3.0.2
+      gemfile: gemfiles/rails52.gemfile
+    - rvm: 2.7.4
       gemfile: gemfiles/rails42.gemfile
-    - rvm: 2.6.5
+    - rvm: 2.6.8
       gemfile: gemfiles/rails42.gemfile
-    - rvm: 2.4.5
-      gemfile: gemfiles/rails61.gemfile
-    - rvm: 2.4.5
+    - rvm: 2.4.10
       gemfile: gemfiles/rails60.gemfile
-    - rvm: 2.4.5  # excluding because of new sprockets version (4.0.0)
+    - rvm: 2.4.10  # excluding because of new sprockets version (4.0.0)
       gemfile: gemfiles/rails52.gemfile
 
     - gemfile: gemfiles/unit.gemfile
@@ -58,6 +58,8 @@ matrix:
       env: DBTYPE=mysql2
     - gemfile: gemfiles/frameworks.gemfile
       env: DBTYPE=mysql2
+    - gemfile: gemfiles/profiling.gemfile
+      env: DBTYPE=mysql2
     - gemfile: gemfiles/delayed_job.gemfile
       env: DBTYPE=mysql2
   allow_failures:
@@ -100,7 +102,8 @@ before_script:
 #  - export APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
 #  - export APPOPTICS_TOKEN_BUCKET_RATE=1000
   - export APPOPTICS_FROM_S3=true
-  - export OBOE_VERSION=10.0.0
+#  - export OBOE_WIP=true
+#  - export OBOE_VERSION=10.0.1
 
 #  - bundle update --jobs=3 --retry=3
   - ./.travis/bundle.sh

data/Gemfile

@@ -6,33 +6,9 @@ source 'https://rubygems.org'
 gem 'rake', '>= 0.9.0'
 
 group :development, :test do
-  # 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
+  gem 'memory_profiler'
 end
 
 gemspec

data/README.md

@@ -13,13 +13,11 @@ It requires an [AppOptics](https://www.appoptics.com/) account to view metrics.
 
 [![Gem Version](https://badge.fury.io/rb/appoptics_apm.svg)](https://badge.fury.io/rb/appoptics_apm)
 
-[comment]: <> ([![Build Status]&#40;https://travis-ci.org/appoptics/appoptics-apm-ruby.png?branch=master&#41;]&#40;https://travis-ci.org/appoptics/appoptics-apm-ruby&#41;)
+[![Run all Tests](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_tests.yml/badge.svg)](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_tests.yml)
+[![C++ Tests](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_cpluplus_tests.yml/badge.svg)](https://github.com/appoptics/appoptics-apm-ruby/actions/workflows/run_cpluplus_tests.yml)
 
 [comment]: <> ([![Maintainability]&#40;https://api.codeclimate.com/v1/badges/ac7f36241a23a3a82fc5/maintainability&#41;]&#40;https://codeclimate.com/github/appoptics/appoptics-apm-ruby/maintainability&#41;)
 
-_Note: The repository is now at https://github.com/appoptics/appoptics-apm-ruby  Please update your github remotes with 
-`git remote set-url origin git@github.com:appoptics/appoptics-apm-ruby.git`._
-
 # Documentation
 
 * [AppOptics Knowledge Base](https://docs.appoptics.com/kb/apm_tracing/ruby)
@@ -236,7 +234,7 @@ Find more details in the [RubyDoc page](https://www.rubydoc.info/gems/appoptics_
 # Support
 
 If you run into a problem, find a bug, or would like to request an enhancement, feel free to contact our tech support 
-[support@appoptics.com](support@appoptics.com).  
+[technicalsupport@solarwinds.com](technicalsupport@solarwinds.com).  
 
 # Contributing
 
@@ -392,4 +390,4 @@ See the README in the test directory.
 
 Copyright (c) 2018 SolarWinds, LLC
 
-Released under the [Librato Open License](https://docs.appoptics.com/kb/apm_tracing/librato-open-license/)
+Released under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)

data/appoptics_apm.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.license = "Apache-2.0"
 
   s.authors = ["Maia Engeli", "Peter Giacomo Lombardo", "Spiros Eliopoulos"]
-  s.email = %q{support@appoptics.com}
+  s.email = %q{technicalsupport@solarwinds.com}
   s.homepage = %q{https://www.appoptics.com/}
   s.summary = %q{AppOptics APM performance instrumentation gem for Ruby}
   s.description = <<-EOF
@@ -32,7 +32,10 @@ Automatic tracing and metrics for Ruby applications. Get started at appoptics.co
               'ext/oboe_metal/src/oboe_swig_wrap.cc',
               'ext/oboe_metal/src/bson/bson.h',
               'ext/oboe_metal/src/bson/platform_hacks.h',
-              'ext/oboe_metal/src/VERSION']
+              'ext/oboe_metal/src/VERSION',
+              'ext/oboe_metal/lib/liboboe-1.0-alpine-x86_64.so.0.0.0.sha256',
+              'ext/oboe_metal/lib/liboboe-1.0-x86_64.so.0.0.0.sha256'
+             ]
   s.files -= ['build_gem.sh',
               'build_gem_upload_to_packagecloud.sh',
               'Rakefile']
@@ -43,17 +46,20 @@ 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')
+  # this still gives a warning, would have to be pinned to a minor version
+  # but that is not necessary and may restrict other gems
+  s.add_runtime_dependency('json', '~> 2.0')
   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'
+  # s.add_development_dependency('irb', '>= 1.0.0', '< 1.2.2') if RUBY_VERSION >= '2.6.0'
   #
   # unless defined?(JRUBY_VERSION)
-  #   s.add_development_dependency('byebug', '>= 8.0.0')
+  #   s.add_development_dependency('byebug', '>= 11.0.0')
+  #   s.add_development_dependency('minitest')
   #   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')

data/examples/prepend.rb

@@ -0,0 +1,13 @@
+require 'appoptics_apm'
+
+module Measurements
+  def request(*args, &block)
+    req = args.first
+    AppOpticsAPM::SDK.summary_metric("request_size", req.to_hash.to_s.size)
+    resp = super
+    AppOpticsAPM::SDK.summary_metric("response_size", resp.to_hash.to_s.size)
+    return resp
+  end
+end
+
+Net::HTTP.send(:prepend, :Measurements)

data/examples/sdk_examples.rb

@@ -140,3 +140,19 @@ AppOpticsAPM::SDK.start_trace('log_trace_id') do
   trace = AppOpticsAPM::SDK.current_trace
   AppOpticsAPM.logger.warn "Some log message #{trace.for_log}"
 end
+
+###############################################################
+# START A TRACE AND PROFILE
+###############################################################
+#
+# AppOpticsAPM::Profiling.run
+# This method adds profiling for the code executed in the block
+
+AppOpticsAPM::SDK.start_trace("#{name}_profiling") do
+  AppOpticsAPM::Profiling.run do
+    10.times do
+      [9, 6, 12, 2, 7, 1, 9, 3, 4, 14, 5, 8].sort
+      sleep 0.2
+    end
+  end
+end