appoptics_apm 4.2.3 → 4.2.4

data/lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb

@@ -8,6 +8,47 @@
 
 if defined?(AppOpticsAPM::Config)
 
+  # :service_key, :hostname_alias, and :debug_level are startup settings and can't be changed afterwards.
+  #
+  # Set APPOPTICS_SERVICE_KEY
+  # This Setting will be overridden if APPOPTICS_SERVICE_KEY is set as an environment variable.
+  # This is a required setting. If the service key is not set here it needs to be set as environment variable.
+  #
+  # The service key is a combination of the API token plus a service name.
+  # E.g.: 0123456789abcde0123456789abcde0123456789abcde0123456789abcde1234:my_service
+  #
+  # AppOpticsAPM::Config[:service_key] = '0123456789abcde0123456789abcde0123456789abcde0123456789abcde1234:my_service'
+
+  #
+  # Set APPOPTICS_HOSTNAME_ALIAS
+  # This Setting will be overridden if APPOPTICS_HOSTNAME_ALIAS is set as an environment variable
+  #
+  # AppOpticsAPM::Config[:hostname_alias] = 'alias_name'
+
+  #
+  # Set APPOPTICS_DEBUG_LEVEL
+  # This Setting will be overridden if APPOPTICS_DEBUG_LEVEL is set as an environment variable
+  #
+  # It sets the log level and takes the following values:
+  ## 0 fatal, 1 error, 2 warning, 3 info (the default), 4 debug low, 5 debug medium, 6 debug high.
+  #
+  #
+  AppOpticsAPM::Config[:debug_level] = 3
+  #
+  # :debug_level will be used in the c-extension of the gem and also mapped to the
+  # Ruby logger as FATAL, ERROR, WARN, INFO, or DEBUG
+  # The Ruby logger can afterwards be changed to a different level as follows:
+  # AppOpticsAPM.logger.level = Logger::INFO
+
+  #
+  # Set APPOPTICS_GEM_VERBOSE
+  # This Setting will be overridden if APPOPTICS_GEM_VERBOSE is set as an environment variable
+  #
+  # On startup the components that are being instrumented will be reported if this is set to true.
+  # If true and the log level is 4 or higher this may create extra debug log messages
+  #
+  AppOpticsAPM::Config[:verbose] = false
+
   #
   # Turn tracing on or off
   #
@@ -17,11 +58,6 @@ if defined?(AppOpticsAPM::Config)
   #
   AppOpticsAPM::Config[:tracing_mode] = :always
 
-  #
-  # Verbose output of instrumentation initialization
-  #
-  AppOpticsAPM::Config[:verbose] = ENV.key?('APPOPTICS_GEM_VERBOSE') && ENV['APPOPTICS_GEM_VERBOSE'] == 'true' ? true : false
-
   #
   # Prepend domain to transaction name
   #
@@ -92,7 +128,7 @@ if defined?(AppOpticsAPM::Config)
   # In Rails, raised exceptions with rescue handlers via
   # <tt>rescue_from</tt> are not reported to the AppOptics
   # dashboard by default.  Setting this value to true will
-  # report all raised exception regardless.
+  # report all raised exceptions regardless.
   #
   AppOpticsAPM::Config[:report_rescued_errors] = false
   #
@@ -122,7 +158,9 @@ if defined?(AppOpticsAPM::Config)
   #
   # If you're having trouble with one of the instrumentation libraries, they
   # can be individually disabled here by setting the :enabled
-  # value to false:
+  # value to false.
+  #
+  # :enabled settings are read on startup and can't be changed afterwards
   #
   AppOpticsAPM::Config[:action_controller][:enabled] = true
   AppOpticsAPM::Config[:action_controller_api][:enabled] = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 4.2.4
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-10 00:00:00.000000000 Z
+date: 2018-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -112,7 +112,6 @@ extensions:
 extra_rdoc_files:
 - LICENSE
 files:
-- ".codeclimate.yml"
 - ".dockerignore"
 - ".gitignore"
 - ".rubocop.yml"
@@ -120,9 +119,6 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - CONFIG.md
-- Dockerfile
-- Dockerfile_alpine
-- Dockerfile_test
 - Gemfile
 - LICENSE
 - README.md
@@ -130,9 +126,8 @@ files:
 - Vagrantfile
 - appoptics_apm.gemspec
 - bin/appoptics_apm_config
-- build_gems.sh
-- config/initializers/.keep
-- docker-compose.yml
+- build_gem.sh
+- build_gem_upload_to_packagecloud.sh
 - examples/SDK/01_basic_tracing.rb
 - examples/carrying_context.rb
 - ext/oboe_metal/extconf.rb
@@ -145,7 +140,6 @@ files:
 - ext/oboe_metal/src/oboe.hpp
 - ext/oboe_metal/src/oboe_debug.h
 - ext/oboe_metal/src/oboe_wrap.cxx
-- ext/oboe_metal/tests/test.rb
 - init.rb
 - lib/appoptics_apm.rb
 - lib/appoptics_apm/api.rb
@@ -163,13 +157,11 @@ files:
 - lib/appoptics_apm/frameworks/padrino/templates.rb
 - lib/appoptics_apm/frameworks/rails.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller.rb
-- lib/appoptics_apm/frameworks/rails/inst/action_controller2.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller3.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller4.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller5.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller_api.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_view.rb
-- lib/appoptics_apm/frameworks/rails/inst/action_view_2x.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_view_30.rb
 - lib/appoptics_apm/frameworks/rails/inst/active_record.rb
 - lib/appoptics_apm/frameworks/rails/inst/connection_adapters/mysql.rb
@@ -225,9 +217,6 @@ files:
 - lib/oboe_metal.rb
 - lib/rails/generators/appoptics_apm/install_generator.rb
 - lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb
-- ruby_setup.sh
-- run_docker_build_gem_upload_to_packagecloud.sh
-- run_tests_docker.rb
 - yardoc_frontpage.md
 homepage: https://www.appoptics.com/
 licenses:
@@ -249,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: AppOptics APM performance instrumentation gem for Ruby

data/.codeclimate.yml

@@ -1,43 +0,0 @@
----
-engines:
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-      - javascript
-      - python
-      - php
-    checks:
-      Similar code:
-        enabled: false
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-    checks:
-      Rubocop/Metrics/AbcSize:
-        enabled: false
-      Rubocop/Style/ConditionalAssignment:
-        enabled: false
-      Rubocop/Metrics/MethodLength:
-        enabled: false
-      Rubocop/Metrics/ModuleLength:
-        enabled: false
-      Rubocop/Metrics/LineLength:
-        enabled: false
-      Rubocop/Lint/EnsureReturn:
-        enabled: false
-ratings:
-  paths:
-  - "**.inc"
-  - "**.js"
-  - "**.jsx"
-  - "**.module"
-  - "**.php"
-  - "**.py"
-  - "**.rb"
-exclude_paths:
-- test/
-- examples/
-- ext/oboe_metal/tests/

data/Dockerfile

@@ -1,41 +0,0 @@
-FROM ubuntu:16.04
-
-# Use this Dockerfile to create the gem
-# > docker build -f Dockerfile -t buildgem .
-# > docker run --rm  -v `pwd`:/code/ruby-appoptics buildgem bash -l -c 'cd /code/ruby-appoptics && ./build_gems.sh'
-
-# install OS packages
-RUN apt-get update \
-    && apt-get install -y --no-install-recommends \
-       build-essential \
-       curl \
-       git-core \
-       libpcre3-dev \
-       libreadline-dev \
-       libssl-dev \
-       openjdk-8-jdk \
-       zlib1g-dev \
-       less \
-    && rm -rf /var/lib/apt/lists/*
-
-# rbenv setup
-# use rbenv-default-gems to automatically install bundler for each ruby version
-RUN  git clone https://github.com/rbenv/rbenv.git ~/.rbenv \
-     &&  git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build \
-     && git clone https://github.com/rbenv/rbenv-default-gems.git ~/.rbenv/plugins/rbenv-default-gems \
-     && echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.profile \
-     && echo 'eval "$(rbenv init -)"' >> ~/.profile \
-     && echo 'bundler' > ~/.rbenv/default-gems
-
-# install rubies to build our gem against
-RUN .  ~/.profile \
-    && rbenv install 2.3.1
-#    && rbenv install jruby-9.0.5.0
-
-# install swig 3.0.8
-RUN curl -SL http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.8/swig-3.0.8.tar.gz \
-    | tar xzC /tmp \
-    && cd /tmp/swig-3.0.8 \
-    && ./configure && make && make install \
-    && cd \
-    && rm -rf /tmp/swig-3.0.8

data/Dockerfile_alpine

@@ -1,66 +0,0 @@
-FROM ruby:2.4-alpine3.7
-
-# Use this Dockerfile to create the gem
-# > docker build -f Dockerfile_alpine -t ruby_alpine .
-# > docker run --rm  -v `pwd`:/code/ruby-appoptics ruby_alpine /bin/bash -l -c 'cd /code/ruby-appoptics'
-
-# install OS packages
-RUN apk update
-RUN apk add --upgrade \
-      bash \
-      build-base \
-      curl \
-      curl-dev \
-      linux-headers \
-      git \
-      pcre \
-      pcre-dev \
-      readline-dev \
-      openjdk8 \
-      zlib-dev \
-      less \
-      swig \
-   && rm -rf /var/lib/apt/lists/*
-
-# rbenv setup
-# use rbenv-default-gems to automatically install bundler for each ruby version
-RUN  git clone https://github.com/rbenv/rbenv.git ~/.rbenv \
-   && git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build \
-   && git clone https://github.com/rbenv/rbenv-default-gems.git ~/.rbenv/plugins/rbenv-default-gems \
-   && echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.profile \
-   && echo 'eval "$(rbenv init -)"' >> ~/.profile \
-   && echo 'bundler' > ~/.rbenv/default-gems
-
-# install rubies to build our gem against
-RUN source  ~/.profile \
-   && rbenv install 2.3.1 \
-   && rbenv install 2.4.1 \
-   # && rbenv install jruby-9.0.5.0
-
-# install swig 3.0.8
-RUN curl -SL http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.8/swig-3.0.8.tar.gz \
-   | tar xzC /tmp \
-   && cd /tmp/swig-3.0.8 \
-   && ./configure && make && make install \
-   && cd \
-   && rm -rf /tmp/swig-3.0.8
-
-RUN apk add --upgrade \
-      redis \
-      memcached \
-      postgresql \
-      openrc \
-   && rc-service postgresql start \
-   && echo "psql --command \"CREATE USER docker WITH SUPERUSER PASSWORD 'docker';\"" >> /tmp/config \
-   && echo "createdb -O docker travis_ci_test" >> /tmp/config \
-   && su postgres -c "bash /tmp/config" \
-   && rm -f /tmp/config
-
-RUN apk add --update mysql-client mysql mariadb
-
-ENV PATH="/root/.rbenv/bin:/root/.rbenv/shims:$PATH"
-ENV RUBY_ENV=test
-ENV DOCKER_PSQL_PASS=docker
-ENV APPOPTICS_OS_ARCH=alpine-x86_64
-
-CMD bash

data/Dockerfile_test

@@ -1,73 +0,0 @@
-FROM ubuntu:16.04
-
-# to use with ./run_tests_docker.rb
-# docker build -f Dockerfile_test -t ruby_appoptics_apm .
-
-# install OS packages
-RUN apt-get update \
-    && apt-get install -y --no-install-recommends \
-       build-essential \
-       apt-utils \
-       curl \
-       git-core \
-       libpcre3-dev \
-       libreadline-dev \
-       libsasl2-dev \
-       libssl-dev \
-       openjdk-8-jdk \
-       zlib1g-dev \
-       libcurl4-gnutls-dev \
-       libmysqlclient-dev \
-       libpq-dev \
-       vim \
-       less \
-       tree \
-       psmisc \
-    && rm -rf /var/lib/apt/lists/*
-
-# rbenv setup
-# use rbenv-default-gems to automatically install bundler for each ruby version
-RUN  git clone https://github.com/rbenv/rbenv.git ~/.rbenv \
-     && git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build \
-     && git clone https://github.com/rbenv/rbenv-default-gems.git ~/.rbenv/plugins/rbenv-default-gems \
-     && echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.profile \
-     && echo 'eval "$(rbenv init -)"' >> ~/.profile \
-     && echo 'bundler' > ~/.rbenv/default-gems
-
-# install rubies to build our gem against
-RUN . ~/.profile \
-    && rbenv install 2.3.6 \
-    && rbenv install 2.4.3 \
-    && rbenv install 2.4.4 \
-    && rbenv install 2.5.1
-#    && rbenv install jruby-9.1.16.0
-
-# install swig 3.0.8
-RUN curl -SL http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.8/swig-3.0.8.tar.gz \
-    | tar xzC /tmp \
-    && cd /tmp/swig-3.0.8 \
-    && ./configure && make && make install \
-    && cd \
-    && rm -rf /tmp/swig-3.0.8
-
-# install postgres, redis, and memcached
-RUN apt-get update \
-    && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
-       redis-server \
-       memcached \
-       postgresql \
-       postgresql-contrib \
-    && service postgresql start \
-    && echo "psql --command \"CREATE USER docker WITH SUPERUSER PASSWORD 'docker';\"" >> /tmp/config \
-    && echo "createdb -O docker travis_ci_test" >> /tmp/config \
-    && su postgres -c "bash /tmp/config" \
-    && rm -f /tmp/config
-
-RUN apt-get update && \
-	apt-get -y install mysql-client libmysqlclient-dev
-
-ENV PATH="/root/.rbenv/bin:/root/.rbenv/shims:$PATH"
-ENV RUBY_ENV=test
-ENV DOCKER_PSQL_PASS=docker
-ENV APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
-ENV APPOPTICS_TOKEN_BUCKET_RATE=1000

data/docker-compose.yml

@@ -1,95 +0,0 @@
-version: "2"
-
-#########################################################################################################
-#
-# to start the services:
-# > docker-compose up -d
-# ('ruby_appoptics' and 'wait' will exit)
-#
-# to run some ruby tests:
-# > docker-compose run --service-ports ruby_appoptics_apm /code/ruby-appoptics_apm/ruby_setup.sh 2.3.6 gemfiles/rails42.gemfile
-#
-########################################################################################################
-
-services:
-  ruby_appoptics_apm:
-     container_name: ruby_appoptics_apm
-     image: ruby_appoptics_apm
-     build:
-        context: .
-        dockerfile: ./Dockerfile_test
-     cpu_quota: 100000 # 1 cpu, assumes cpu_period of 1 second
-     mem_limit: 1G
-     volumes:
-       - .:/code/ruby-appoptics_apm
-     depends_on:
-       - wait
-     links:
-       - wait
-     environment:
-       - APPOPTICS_RABBITMQ_SERVER=rabbitmq
-       - DOCKER_MYSQL_PASS=admin
-       - MYSQL_ALLOW_EMPTY_PASSWORD=yes
-       - MYSQL_ROOT_PASSWORD=admin
-       - MYSQL_HOST=mysql
-       - APPOPTICS_MONGO_SERVER=mongo
-
-#  ruby_appoptics_apm_alpine:
-#     container_name: ruby_appoptics_apm_alpine
-#     image: ruby_alpine
-#     build:
-#        context: .
-#        dockerfile: ./Dockerfile_alpine
-#     cpu_quota: 100000 # 1 cpu, assumes cpu_period of 1 second
-#     mem_limit: 1G
-#     volumes:
-#       - .:/code/ruby-appoptics_apm
-#     depends_on:
-#       - wait
-#     links:
-#       - wait
-#     environment:
-#       - APPOPTICS_RABBITMQ_SERVER=rabbitmq
-#       - DOCKER_MYSQL_PASS=admin
-#       - MYSQL_ALLOW_EMPTY_PASSWORD=yes
-#       - MYSQL_ROOT_PASSWORD=admin
-#       - MYSQL_HOST=mysql
-#       - APPOPTICS_MONGO_SERVER=mongo
-
-  rabbitmq:
-    container_name: rabbitmq
-    image: rabbitmq:3-management
-    ports:
-      - "8080:15672"
-      - "5672:5672"
-      - "5671:5671"
-
-  mysql:
-    container_name: mysql
-    image: mysql:5.7.13
-    environment:
-      - MYSQL_ALLOW_EMPTY_PASSWORD=yes
-      - MYSQL_ROOT_PASSWORD=admin
-    ports:
-      - "3306:3306"
-
-  mongo:
-    container_name: mongo
-    image: mongo:3.4
-    ports:
-      - "27017:27017"
-
-  wait:
-    container_name: wait
-    image: waisbrot/wait
-    depends_on:
-      - rabbitmq
-      - mysql
-      - mongo
-    links:
-      - rabbitmq
-      - mysql
-      - mongo
-    environment:
-      - TARGETS=mysql:3306;rabbitmq:5672;mongo:27017
-