appoptics_apm_mnfst 4.5.2

data/CONFIG.md

@@ -0,0 +1,33 @@
+# AppOpticsAPM Gem Configuration
+
+## Environment Variables
+
+The following environment variables are detected by the appoptics_apm gem and affect how the gem functions.
+
+### General
+
+Name | Description | Default
+---- | ----------- | -------
+`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
+
+Name | Description | Default
+---- | ----------- | -------
+`APPOPTICS_GEM_TEST` | puts the gem in test mode.  Traces are written to /tmp/trace_output.bson. | `false`
+`DBTYPE` | For tests on Ruby on Rails, specifies the database type to test against.  `postgres`, `mysql` and `mysql2` are valid options. | `postgres`
+`APPOPTICS_CASSANDRA_SERVER` | specifies the Cassandra server to test against. | `127.0.0.1:9160`
+`APPOPTICS_MONGO_SERVER` | specifies the Mongo server to test against. | `127.0.0.1:27017`
+`APPOPTICS_RABBITMQ_SERVER` | specifies the RabbitMQ server to test against. | `127.0.0.1`
+`APPOPTICS_RABBITMQ_PORT` | port for the RabbitMQ connection. | `5672`
+`APPOPTICS_RABBITMQ_USERNAME` | username for the RabbitMQ connection | `guest`
+`APPOPTICS_RABBITMQ_PASSWORD` | password for the RabbitMQ connection | `guest`
+
+## AppOpticsAPM::Config
+
+`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/librato/ruby-appoptics/blob/master/lib/rails/generators/appoptics_apm/templates/appoptics_initializer.rb) for documentation on all of the supported values.

data/Gemfile

@@ -0,0 +1,29 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'rake'
+  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',       :platforms => [:mri_22, :mri_23, :mri_24]
+  gem 'pry'
+  gem 'pry-byebug',   :platforms => [:mri_22, :mri_23, :mri_24]
+end
+
+if defined?(JRUBY_VERSION)
+  gem 'sinatra', :require => false
+else
+  gem 'sinatra'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,193 @@
+Librato Open License
+Version 1.0, October, 2016
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 11 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.  Licensor can include Librato as an
+original contributor to the Work as defined below.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work.
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, including
+but not limited to communication on electronic mailing lists, source code
+control systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated in
+writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and
+such Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+Each time You convey a covered Work, the recipient automatically receives a
+license from the original Licensor(s), to run, modify and propagate that work,
+subject to this License. You are not responsible for enforcing compliance by
+third parties with this License.
+
+You may not impose any further restrictions on the exercise of the rights
+granted or affirmed under this License. For example, you may not impose a
+license fee, royalty, or other charge for exercise of rights granted under this
+License, and you may not initiate litigation (including a cross-claim or
+counterclaim in a lawsuit) alleging that any patent claim is infringed by
+making, using, selling, offering for sale, or importing the Work or any portion
+of it.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+  1. You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+  2. You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+  3. You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+  4. If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy of
+the attribution notices contained within such NOTICE file, excluding those
+notices that do not pertain to any part of the Derivative Works, in at least
+one of the following places: within a NOTICE text file distributed as part of
+the Derivative Works; within the Source form or documentation, if provided
+along with the Derivative Works; or, within a display generated by the
+Derivative Works, if and wherever such third-party notices normally appear. The
+contents of the NOTICE file are for informational purposes only and do not
+modify the License. You may add Your own attribution notices within Derivative
+Works that You distribute, alongside or as an addendum to the NOTICE text from
+the Work, provided that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a
+whole, provided Your use, reproduction, and distribution of the Work otherwise
+complies with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms
+of any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides
+the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License
+or out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction,
+or any and all other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License.
+However, in accepting such obligations, You may act only on Your own behalf and
+on Your sole responsibility, not on behalf of any other Contributor, and only
+if You agree to indemnify, defend, and hold each Contributor harmless for any
+liability incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+10. Noncompetition
+
+You may install and execute the Work only in conjunction with the direct use of
+Librato software.  This Work, any file or any derivative thereof shall not be
+used in conjunction with any product that competes with any Librato software.
+
+11. Termination
+
+The License stated above is automatically terminated and revoked if you exceed
+its scope or violate any of the terms of this License or any related License or
+notice.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,393 @@
+# Welcome to the AppOpticsAPM Ruby Gem
+
+The appoptics_apm gem provides [AppOptics APM](https://www.appoptics.com/) performance instrumentation for Ruby.
+
+![Ruby AppOpticsAPM](https://docs.appoptics.com/_images/ruby_trace.png)
+
+It has the ability to report performance metrics on an array of libraries, databases and frameworks such as Rails, 
+Mongo, Memcache, ActiveRecord, Cassandra, Rack, Resque 
+[and more](https://docs.appoptics.com/kb/apm_tracing/ruby/support-matrix/).
+
+It requires an [AppOptics](https://www.appoptics.com/) account to view metrics.  Get yours, 
+[it's free](https://my.appoptics.com/sign_up).
+
+[![Gem Version](https://badge.fury.io/rb/appoptics_apm.svg)](https://badge.fury.io/rb/appoptics_apm)
+[![Build Status](https://travis-ci.org/appoptics/appoptics-apm-ruby.png?branch=master)](https://travis-ci.org/appoptics/appoptics-apm-ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ac7f36241a23a3a82fc5/maintainability)](https://codeclimate.com/github/appoptics/appoptics-apm-ruby/maintainability)
+
+_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)
+
+# Installation
+
+_Before installing the gem below, make sure that you have the 
+[dependencies](http://docs.appoptics.com/kb/apm_tracing/ruby/install#dependencies) installed on your host first._
+
+The appoptics_apm gem is [available on Rubygems](https://rubygems.org/gems/appoptics_apm) and can be installed with:
+
+```bash
+gem install appoptics_apm
+```
+
+or added to **the end** of your Gemfile and running `bundle install`:
+
+```ruby
+gem 'appoptics_apm'
+```
+
+# Running
+
+Make sure to set `APPOPTICS_SERVICE_KEY` in the environment from where the app or service is run, e.g:
+```
+export APPOPTICS_SERVICE_KEY=795fb4947d15275d208c49cfd2412d4a5bf38742045b47236c94c4fe5f5b17c7:<your_app_name>
+```
+
+## Rails
+
+![Ruby on Rails](https://docs.appoptics.com/_images/rails.png)
+
+No special steps are needed to instrument Ruby on Rails.  Once part of the bundle, the appoptics gem will automatically 
+detect Rails and instrument on stack initialization.
+
+### The Install Generator
+
+The appoptics_apm gem provides a Rails generator used to seed an initializer where you can configure and control 
+`tracing_mode` and [other options](http://docs.appoptics.com/kb/apm_tracing/ruby/configure).
+
+To run the install generator run:
+
+```bash
+bundle exec rails generate appoptics_apm:install
+```
+
+After the prompts, this will create an initializer: `config/initializers/appoptics_apm.rb`.
+
+## Sinatra
+
+![Sinatra](https://docs.appoptics.com/_images/sinatra.png)
+
+You can instrument your Sinatra application by adding the following code to your `config.ru` Rackup file:
+
+```ruby
+# If you're not using Bundler.require.  Make sure this is done
+# after the Sinatra require directive.
+require 'appoptics_apm'
+```
+
+Make sure that the appoptics_apm gem is loaded _after_ Sinatra either by listing `gem 'appoptics_apm'` after Sinatra in 
+your Gemfile or calling the `require 'appoptics_gem'` directive after Sinatra is loaded.
+
+With this, the appoptics_apm gem will automatically detect Sinatra on boot and instrument key components.
+
+## Padrino
+
+![Padrino](https://docs.appoptics.com/_images/padrino.svg)
+
+As long as the appoptics_apm gem is in your `Gemfile` (inserted after the `gem 'padrino'` directive) and you are calling 
+`Bundler.require`, the appoptics_apm gem will automatically instrument Padrino applications.
+
+If you need to set `AppOpticsAPM::Config` values on stack boot, you can do so by adding the following
+to your `config/boot.rb` file:
+
+```ruby
+Padrino.before_load do
+  # Verbose output of instrumentation initialization
+  AppOpticsAPM
+end
+```
+
+## Grape
+
+![Grape](https://docs.appoptics.com/_images/grape.png)
+
+You can instrument your Grape application by adding the following code to your `config.ru` Rackup file:
+
+```ruby
+    # If you're not using Bundler.require.  Make sure this is done
+    # after the Grape require directive.
+    require 'appoptics_apm'
+
+    ...
+
+    class App < Grape::API
+      use AppOpticsAPM::Rack
+    end
+```
+
+Make sure that the appoptics gem is loaded _after_ Grape either by listing `gem 'appoptics_apm'` after Grape in your 
+Gemfile or calling the `require 'appoptics_apm'` directive after Grape is loaded.
+
+You must explicitly tell your Grape application to use AppOpticsAPM::Rack for tracing to occur.
+
+
+# SDK for Custom Tracing 
+
+The appoptics_apm gem has the ability to instrument any arbitrary Ruby application or script.
+
+```ruby
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
+
+require 'appoptics_apm'
+```
+
+You can add even more visibility into any part of your application or scripts by adding custom instrumentation.  
+
+## AppOpticsAPM::SDK.trace
+You can instrument any arbitrary block of code using `AppOpticsAPM::SDK.trace`.  
+
+```ruby
+# layer_name will show up in the AppOptics app dashboard
+layer_name = 'subsystemX'
+
+# report_kvs are a set of information Key/Value pairs that are sent to
+# AppOptics dashboard along with the performance metrics. These KV
+# pairs are used to report request, environment and/or client specific
+# information.
+
+report_kvs = {}
+report_kvs[:mykey] = @client.id
+
+AppOpticsAPM::SDK.trace(layer_name, report_kvs) do
+  # the block of code to be traced
+end
+```
+
+`AppOpticsAPM::SDK.trace` is used within the context of a request.  It will follow the upstream state of the request 
+being traced.  i.e. the block of code will only be traced when the parent request is being traced.
+
+This tracing state of a request can also be queried by using `AppOpticsAPM.tracing?`.
+
+## AppOpticsAPM::SDK.start_trace
+
+If you need to instrument code outside the context of a request (such as a cron job, background job or an arbitrary 
+ruby script), use `AppOpticsAPM::SDK.start_trace` instead which will initiate a new trace based on configuration and 
+probability (based on the sample rate).
+
+
+
+### Example
+
+```ruby
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
+
+# Make sure appoptics_apm is at the bottom of your Gemfile.
+# This is likely redundant but just in case.
+require 'appoptics_apm'
+ 
+
+# Tracing mode can be 'never', 'through' (to follow upstream) or 'always'
+AppOpticsAPM::Config[:tracing_mode] = 'always'
+ 
+#
+# Update April 9, 2015 - this is done automagically now
+# and doesn't have to be called manually
+#
+# Load library instrumentation to auto-capture stuff we know about...
+# e.g. ActiveRecord, Cassandra, Dalli, Redis, memcache, mongo
+# TraceView::Ruby.load
+ 
+# Some KVs to report to the dashboard
+report_kvs = {}
+report_kvs[:command_line_params] = ARGV.to_s
+report_kvs[:user_id] = `whoami`
+ 
+AppOpticsAPM::SDK.start_trace('my_background_job', nil, report_kvs ) do
+  #
+  # Initialization code
+  #
+  
+  tasks = get_all_tasks
+  
+  tasks.each do |t|
+    # Optional: Here we embed another 'trace' to separate actual 
+    # work for each task.  In the traces dashboard this will show 
+    # up as a large 'my_background_job' parent layer with many 
+    # child 'task' layers.
+    AppOpticsAPM::SDK.trace('task', { :task_id => t.id }) do
+      t.perform
+    end
+  end
+  
+  #
+  # cleanup code
+  #
+end
+ 
+
+# Note that we use 'start_trace' in the outer block and 'trace' for
+# any sub-blocks of code we wish to instrument.  The arguments for
+# both methods vary slightly. 
+``` 
+
+Find more details in the [RubyDoc page](https://www.rubydoc.info/gems/appoptics_apm/AppOpticsAPM/SDK) on how to use the Tracing SDK in an independent Ruby script.
+
+# Support
+
+If you find a bug or would like to request an enhancement, feel free to contact our tech support 
+[support@appoptics.com](support@appoptics.com).  
+
+# Contributing
+
+You are obviously a person of great sense and intelligence.  We happily appreciate all contributions to the appoptics 
+gem whether it is documentation, a bug fix, new instrumentation for a library or framework or anything else we haven't 
+thought of.
+
+We welcome you to send us PRs.  We also humbly request that any new instrumentation submissions have corresponding tests 
+that accompany them.  This way we don't break any of your additions when we (and others) make changes after the fact.
+
+
+## Layout of the Gem
+
+The appoptics gem uses a standard gem layout.  Here are the notable directories.
+
+    lib/appoptics/inst               # Auto load directory for various instrumented libraries
+    lib/appoptics/frameworks         # Framework instrumentation directory
+    lib/appoptics/frameworks/rails   # Files specific to Rails instrumentation
+    lib/rails                        # A Rails required directory for the Rails install generator
+    lib/api                          # The AppOpticsAPM Tracing API: layers, logging, tracing
+    ext/oboe_metal                   # The Ruby c extension that links against the system liboboe library
+
+## Building the Gem
+
+The appoptics gem is built with the standard `gem build` command passing in the gemspec:
+
+```bash
+gem build appoptics_apm.gemspec
+```
+
+## Writing Custom Instrumentation
+
+Custom instrumentation for a library, database or other service can be authored fairly easily.  Generally, 
+instrumentation of a library is done by wrapping select operations of that library and timing their execution using the 
+AppOpticsAPM Tracing SDK which then reports the metrics to the users' AppOptics dashboard.
+
+Here, I'll use a stripped down version of the Dalli instrumentation (`lib/appoptics/inst/dalli.rb`) as a quick example 
+of how to instrument a client library (the dalli gem).
+
+The Dalli gem nicely routes all memcache operations through a single `perform` operation.  Wrapping this method allows 
+us to capture all Dalli operations called by an application.
+
+First, we define a module (AppOpticsAPM::Inst::Dalli) and our own custom `perform_with_appoptics` method that we will 
+use as a wrapper around Dalli's `perform` method.  We also declare an `included` method which automatically gets called 
+when this module is included by another.  
+See [`Module#included` Ruby reference documentation](https://devdocs.io/ruby~2.5/module#method-i-included).
+
+```ruby
+module AppOpticsAPM
+  module Inst
+    module Dalli
+      include AppOpticsAPM::API::Memcache
+ 
+      def self.included(cls)
+        cls.class_eval do
+          if ::Dalli::Client.private_method_defined? :perform
+            alias perform_without_appoptics perform
+            alias perform perform_with_appoptics
+          end
+        end
+      end
+ 
+      def perform_with_appoptics(*all_args, &blk)
+        op, key, *args = *all_args
+ 
+        if AppOpticsAPM.tracing?
+          opts = {}
+          opts[:KVOp] = op
+          opts[:KVKey] = key
+ 
+          AppOpticsAPM::SDK.trace('memcache', opts || {}) do
+            result = perform_without_appoptics(*all_args, &blk)
+            if op == :get and key.class == String
+                AppOpticsAPM::API.log_info('memcache', { :KVHit => memcache_hit?(result) })
+            end
+            result
+          end
+        else
+          perform_without_appoptics(*all_args, &blk)
+        end
+      end
+       
+    end
+  end
+end
+```
+
+Second, we tail onto the end of the instrumentation file a simple `::Dalli::Client.module_eval` call to tell the Dalli 
+module to include our newly defined instrumentation module.  Doing this will invoke our previously defined `included` method.
+
+```ruby
+if defined?(Dalli) and AppOpticsAPM::Config[:dalli][:enabled]
+  ::Dalli::Client.module_eval do
+    include AppOpticsAPM::Inst::Dalli
+  end
+end
+```
+
+Third, in our wrapper method, we capture the arguments passed in, collect the operation and key information into a local 
+hash and then invoke the `AppOpticsAPM::SDK.trace` method to time the execution of the original operation.
+
+The `AppOpticsAPM::SDK.trace` method calls Dalli's native operation and reports the timing metrics and your custom 
+`report_kvs` up to AppOptics servers to be shown on the user's dashboard.
+
+Some other tips and guidelines:
+
+* You can point your Gemfile directly at your cloned appoptics gem source by using 
+`gem 'appoptics', :path => '/path/to/ruby-appoptics'`
+
+* If instrumenting a library, database or service, place your new instrumentation file into the `lib/appoptics/inst/` 
+directory.  From there, the appoptics gem will detect it and automatically load the instrumentation file.
+
+* If instrumenting a new framework, place your instrumentation file in `lib/appoptics/frameworks`.  Refer to the Rails 
+instrumentation for on ideas on how to load the appoptics gem correctly in your framework.
+
+* Review other existing instrumentation similar to the one you wish to author.  `lib/appoptics/inst/` is a great place 
+to start.
+
+* Depending on the configured `:sample_rate`, not all requests will be traced.  Use `AppOpticsAPM.tracing?` to determine 
+of this is a request that is being traced.
+
+* Performance is paramount.  Make sure that your wrapped methods don't slow down users applications.
+
+* Include tests with your instrumentation.  See `test/instrumentation/` for some examples of existing instrumentation 
+tests.
+
+## Compiling the C extension
+
+The appoptics gem utilizes a C extension to interface with a core library bundled in with the gem which handles 
+reporting the trace and performance data back to AppOptics servers.
+
+C extensions are usually built on `gem install` but when working out of a local git repository, it's required that you 
+manually build this C extension for the gem to function.
+
+To make this simpler, we've included a few rake tasks to automate this process:
+
+```bash
+rake compile             # Build the gem's c extension
+rake distclean           # Remove all built files and extensions
+rake recompile           # Rebuild the gem's c extension
+```
+
+To see the code related to the C extension, take a look at `ext/oboe_metal/extconf.rb` for details.
+
+You can read more about Ruby gems with C extensions in the 
+[Rubygems Guides](http://guides.rubygems.org/gems-with-extensions/).
+
+## Running the Tests
+
+See the README in the test directory.
+
+# License
+
+Copyright (c) 2018 SolarWinds, LLC
+
+Released under the [Librato Open License](https://docs.appoptics.com/kb/apm_tracing/librato-open-license/)