Merge pull request #31 from librato/30_rename_add_apm

rename:
AppOptics to AppOpticsAPM (module)
appoptics to appoptics_apm (gem name and gem internals)

with the exception of method aliases, email addresses,URIs, reference to the AppOptics dashboard etc.

Author: Maia Engeli

.travis.yml

@@ -8,7 +8,7 @@ cache:
 rvm:
   - 2.4.1
   - 2.3.1
-  - 1.9.3   # once we don't support 1.9.3 anymore we can use "&." (safe navigation) and prepend (instead of alias)
+  - 1.9.3
 #  - jruby-9.0.5.0
 
 gemfile:

CONFIG.md

@@ -1,15 +1,16 @@
-# AppOptics Gem Configuration
+# AppOpticsAPM Gem Configuration
 
 ## Environment Variables
 
-The following environment variables are detected by the appoptics gem and affect how the gem functions.
+The following environment variables are detected by the appoptics_apm gem and affect how the gem functions.
 
 ### General
 
 Name | Description | Default
 ---- | ----------- | -------
-`IGNORE_APPOPTICS_WARNING` | tells the appoptics gem to __not__ output the _missing AppOptics libraries_ message on stack initialization | `false`
-`APPOPTICS_GEM_VERBOSE` | sets the verbose flag (`AppOptics::Config[:verbose]`) early in the gem loading process which may output valuable information | `false`
+`APPOPTICS_SERVICE_KEY` | API token + service name combination, mandatory for metrics and traces to show in my.appoptics.com | 
+`IGNORE_APPOPTICS_WARNING` | tells the appoptics_apm gem to __not__ output the _missing AppOpticsAPM libraries_ message on stack initialization | `false`
+`APPOPTICS_GEM_VERBOSE` | sets the verbose flag (`AppOpticsAPM::Config[:verbose]`) early in the gem loading process which may output valuable information | `false`
 `APPOPTICS_CUUID` | Allows specifying the customer ID via environment variable to override/bypass the value in `/etc/tracelytics.conf` | `nil`
 
 # Related to Tests
@@ -25,8 +26,8 @@ Name | Description | Default
 `APPOPTICS_RABBITMQ_USERNAME` | username for the RabbitMQ connection | `guest`
 `APPOPTICS_RABBITMQ_PASSWORD` | password for the RabbitMQ connection | `guest`
 
-## AppOptics::Config
+## AppOpticsAPM::Config
 
-`AppOptics::Config` is a nested hash used by the appoptics gem to store preferences and switches.
+`AppOpticsAPM::Config` is a nested hash used by the appoptics_apm gem to store preferences and switches.
 
-See [this Rails generator template file](https://github.com/tracelytics/oboe-ruby/blob/master/lib/rails/generators/appoptics/templates/appoptics_initializer.rb) for documentation on all of the supported values.
+See [this Rails generator template file](https://github.com/librato/ruby-appoptics/blob/master/lib/rails/generators/appoptics_apm/templates/appoptics_initializer.rb) for documentation on all of the supported values.

Dockerfile

@@ -29,8 +29,8 @@ RUN  git clone https://github.com/rbenv/rbenv.git ~/.rbenv \
 
 # install rubies to build our gem against
 RUN .  ~/.profile \
-    && rbenv install 2.3.1 \
-    && rbenv install jruby-9.0.5.0
+    && 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 \

README.md

@@ -5,7 +5,7 @@ require 'fileutils'
 require 'open-uri'
 require 'bundler/setup'
 require 'rake/testtask'
-require 'appoptics/test'
+require 'appoptics_apm/test'
 
 Rake::TestTask.new do |t|
   t.verbose = false
@@ -20,7 +20,7 @@ Rake::TestTask.new do |t|
   # Here we detect the Gemfile the tests are being run against
   # and load the appropriate tests.
   #
-  case AppOptics::Test.gemfile
+  case AppOpticsAPM::Test.gemfile
   when /delayed_job/
     require 'delayed/tasks'
     t.test_files = FileList['test/queues/delayed_job*_test.rb']
@@ -180,17 +180,17 @@ task :environment do
   ENV['APPOPTICS_GEM_VERBOSE'] = 'true'
 
   Bundler.require(:default, :development)
-  AppOptics::Config[:tracing_mode] = :always
-  AppOptics::Test.load_extras
+  AppOpticsAPM::Config[:tracing_mode] = :always
+  AppOpticsAPM::Test.load_extras
 
-  if AppOptics::Test.gemfile?(:delayed_job)
+  if AppOpticsAPM::Test.gemfile?(:delayed_job)
     require 'delayed/tasks'
   end
 end
 
 task :console => :environment do
   ARGV.clear
-  if AppOptics::Test.gemfile?(:delayed_job)
+  if AppOpticsAPM::Test.gemfile?(:delayed_job)
     require './test/servers/delayed_job'
   end
   Pry.start

Rakefile

@@ -1,7 +1,7 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-# This Vagrantfile creates a build machine for our appoptics gem.
+# This Vagrantfile creates a build machine for our appoptics_apm gem.
 # Usage:
 # $ vagrant up
 # $ vagrant ssh
@@ -52,12 +52,12 @@ Vagrant.configure("2") do |config|
 #!/usr/bin/env bash
 cd /vagrant
 export RBENV_VERSION=jruby-9.0.5.0
-jruby -S gem build appoptics.gemspec
+jruby -S gem build appoptics_apm.gemspec
 
 export RBENV_VERSION=2.3.1
-gem build appoptics.gemspec
+gem build appoptics_apm.gemspec
 
-ls -la appoptics*.gem
+ls -la appoptics_apm*.gem
 
 echo "publish to rubygems via: gem push <gem>"
 BUILDSCRIPT

Vagrantfile

@@ -1,18 +1,18 @@
 $:.push File.expand_path("../lib", __FILE__)
-require "appoptics/version"
+require "appoptics_apm/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{appoptics}
-  s.version = AppOptics::Version::STRING
+  s.name = %q{appoptics_apm}
+  s.version = AppOpticsAPM::Version::STRING
   s.date = Time.now.strftime('%Y-%m-%d')
 
   s.license = "Librato Open License, Version 1.0"
 
   s.authors = ["Maia Engeli", "Peter Giacomo Lombardo", "Spiros Eliopoulos"]
   s.email = %q{support@appoptics.com}
   s.homepage = %q{https://www.appoptics.com/}
-  s.summary = %q{AppOptics performance instrumentation gem for Ruby}
-  s.description = %q{The AppOptics gem provides performance instrumentation for MRI Ruby, JRuby and related frameworks.}
+  s.summary = %q{AppOptics APM performance instrumentation gem for Ruby}
+  s.description = %q{The AppOpticsAPM gem provides performance instrumentation for MRI Ruby, JRuby and related frameworks.}
 
   s.extra_rdoc_files = ["LICENSE"]
   s.files = `git ls-files`.split("\n")

appoptics.gemspec renamed to appoptics_apm.gemspec

@@ -1,15 +1,15 @@
 #!/usr/bin/env bash
-# builds the appoptics gem for JRuby and MRI.
+# builds the appoptics_apm gem for JRuby and MRI.
 
 echo -e "\n=== building for MRI ===\n"
 export RBENV_VERSION=2.3.1
 rm -f Gemfile.lock
 bundle install
 bundle exec rake distclean
 bundle exec rake fetch_ext_deps
-gem build appoptics.gemspec
+gem build appoptics_apm.gemspec
 
 echo -e "\n=== built gems ===\n"
-ls -la appoptics*.gem
+ls -la appoptics_apm*.gem
 
 echo -e "\n=== publish to rubygems via: gem push <gem> ===\n"

build_gems.sh

@@ -7,7 +7,7 @@ version: "2"
 # ('ruby_appoptics' and 'wait' will exit)
 #
 # to run some ruby tests:
-# > docker-compose run --service-ports ruby_appoptics /code/ruby-appoptics/ruby_setup.sh 2.3.1 gemfiles/rails42.gemfile
+# > docker-compose run --service-ports ruby_appoptics /code/ruby-appoptics_apm/ruby_setup.sh 2.3.1 gemfiles/rails42.gemfile
 #
 ########################################################################################################
 
@@ -21,7 +21,7 @@ services:
      cpu_quota: 100000 # 1 cpu, assumes cpu_period of 1 second
      mem_limit: 1G
      volumes:
-       - .:/code/ruby-appoptics
+       - .:/code/ruby-appoptics_apm
      depends_on:
        - wait
      links:

docker-compose.yml

@@ -1,9 +1,9 @@
-By default, the AppOptics oboe gem will not trace routes with extensions
+By default, the AppOpticsAPM gem will not trace routes with extensions
 for common static files.  Examples of such files may be images,
 javascript, pdfs and text files.
 
 This is done by using the regular expression stored in
-`AppOptics::Config[:dnt_regexp]`:
+`AppOpticsAPM::Config[:dnt_regexp]`:
 
     .(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$
 
@@ -14,7 +14,7 @@ To replace the pattern in use, you can update this regular expression
 string.  Here are some examples.
 
 If you prefer that you want your javascript and CSS files instrumented,
-you can update `AppOptics::Config[:dnt_regexp]` with an updated regexp
+you can update `AppOpticsAPM::Config[:dnt_regexp]` with an updated regexp
 pattern (without the "js" and "css" entries):
 
     .(jpg|jpeg|gif|png|ico|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|flv|swf|ttf|woff|svg|less)$
@@ -26,7 +26,7 @@ regexp [negative
 look-behind](http://www.regular-expressions.info/lookaround.html) that
 isn't supported in Ruby 1.8):
 
-    AppOptics::Config[:dnt_regexp] = "(\.js$)(?<!show.js)"
+    AppOpticsAPM::Config[:dnt_regexp] = "(\.js$)(?<!show.js)"
 
 Since this pattern is used with the standard Ruby Regexp class, you can
 use any Regexp supported pattern.  See the documentation on Ruby Regexp