sinatra-instrumentation 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a6183a762b5a91f46d31d970a9ddf81277ba47e
+  data.tar.gz: 71966212c8ddef8a4a5422713633f8d7044aa347
+SHA512:
+  metadata.gz: 5a581486793ee3b2298b1432858fd0e5a24201c10c1581d8e79a28e0e5fe316eafce04a8e9a803806eac2049338b6c72a718054a97083b24640f54790db3d6a6
+  data.tar.gz: d7df4aa626712a6523d042ad3e8765cd74b16585a9e3793d2f80cf7c7e9770a22f9a3fc2321db04a8dc4d4eb2b993f28a326dcf8cd55887f3420d833d2a18d00

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Appraisals

@@ -0,0 +1,24 @@
+appraise 'sinatra-latest' do
+  gem 'sinatra'
+end
+
+appraise 'sinatra-2.0.0' do
+  gem 'sinatra', '2.0.0'
+end
+
+appraise 'sinatra-1.4.8' do
+  gem 'sinatra', '1.4.8'
+end
+
+appraise 'sinatra-1.3.6' do
+  gem 'sinatra', '1.3.6'
+end
+
+appraise 'sinatra-1.2.9' do
+  gem 'sinatra', '1.2.9'
+end
+
+appraise 'sinatra-1.1.4' do
+  gem 'sinatra', '1.1.4'
+end
+

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sinatra-tracer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ashwin Chandrasekar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Sinatra::Instrumentation
+
+Auto-instrumenter for Sinatra applications. It traces routes using
+`Rack::Tracer` and patches Sinatra to trace template rendering.
+
+## Supported Versions
+
+- MRI Ruby 2.0 and newer
+- Sinatra 1.1.4 and newer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sinatra-instrumentation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-instrumentation
+
+## Usage
+
+In a classic Sinatra application, this can be used by requiring the library:
+
+```ruby
+require 'sinatra/instrumentation'
+```
+
+A modular application will need to register it manually:
+
+```ruby
+class SinatraApp < Sinatra::Base
+    register Sinatra::Instrumentation
+    ...
+end
+```
+
+## Tags
+
+In addition to the standard OpenTracing tags, the instrumentation also adds:
+- `sinatra.template`: the name of the view template, or if rendering a string with view code, the contents of the string.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/signalfx/ruby-sinatra-instrumentation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sinatra/instrumentation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/sinatra_1.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sinatra", "1.0"
+
+gemspec path: "../"

data/gemfiles/sinatra_1.1.4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sinatra", "1.1.4"
+
+gemspec path: "../"

data/gemfiles/sinatra_1.2.9.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sinatra", "1.2.9"
+
+gemspec path: "../"

data/gemfiles/sinatra_1.3.6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sinatra", "1.3.6"
+
+gemspec path: "../"

data/gemfiles/sinatra_1.4.8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sinatra", "1.4.8"
+
+gemspec path: "../"

data/gemfiles/sinatra_2.0.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sinatra", "2.0.0"
+
+gemspec path: "../"

data/gemfiles/sinatra_latest.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sinatra"
+
+gemspec path: "../"

data/lib/sinatra/instrumentation.rb

@@ -0,0 +1,40 @@
+require 'rack/tracer'
+require 'sinatra/base'
+require 'sinatra/instrumentation/version'
+require 'opentracing'
+
+module Sinatra
+  module Instrumentation
+
+    class << self
+
+      def registered(app)
+        # enable the Rack Tracer middleware
+        app.use Rack::Tracer
+
+        patch_render if !@patched
+        @patched = true
+      end
+
+      def patch_render
+        ::Sinatra::Base.module_eval do
+          alias_method :render_original, :render
+
+          def render(engine, data, options = {}, locals = {}, &block)
+            result = ""
+
+            OpenTracing.global_tracer.start_active_span("sinatra.render", tags: {}) do |scope|
+              result = render_original(engine, data, options, locals, &block)
+              scope.span.set_tag("sinatra.template", data)
+            end
+
+            result
+          end
+        end
+      end
+
+    end
+  end
+
+  register Instrumentation
+end

data/lib/sinatra/instrumentation/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Instrumentation
+    VERSION = "0.1.1"
+  end
+end

data/sinatra-tracer.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sinatra/instrumentation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-instrumentation"
+  spec.version       = Sinatra::Instrumentation::VERSION
+  spec.authors       = ["Ashwin Chandrasekar"]
+  spec.email         = ["achandrasekar@signalfx.com"]
+
+  spec.summary       = %q{Instrumentation for Sinatra applications}
+  spec.description   = %q{OpenTracing compatible auto-instrumentation for Sinatra web applications.}
+  spec.homepage      = "http://github.com/signalfx/ruby-sinatra-instrumentation"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "opentracing_test_tracer", "~> 0.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.60"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.30.0"
+  spec.add_development_dependency "appraisal", "~> 2.2"
+  spec.add_development_dependency "sinatra", "~> 1.4"
+  spec.add_development_dependency "rack-test", "~> 1.1"
+
+  spec.add_dependency "opentracing", "~> 0.3"
+  spec.add_dependency "rack-tracer", "~>0.8.0"
+
+end

data/test_app/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'opentracing'
+gem 'sinatra', '~> 1.4'
+gem 'jaeger-client', '~> 0.6.1'
+gem 'sinatra-instrumentation', '~> 0.1.0'

data/test_app/hello.rb

@@ -0,0 +1,35 @@
+require 'sinatra'
+require 'opentracing'
+require 'jaeger/client'
+require 'jaeger/client/http_sender'
+require 'logger'
+
+require 'sinatra/instrumentation'
+
+accessToken = ""
+headers = { }
+service_name = "sinatra-tracer-test"
+encoder = Jaeger::Client::Encoders::ThriftEncoder.new(service_name: service_name)
+httpsender = Jaeger::Client::HttpSender.new(url: "http://localhost:14268/api/traces", headers: headers, encoder: encoder, logger: Logger.new(STDOUT))
+OpenTracing.global_tracer = Jaeger::Client.build(service_name: service_name, sender: httpsender, propagate_b3: true)
+
+get '/' do
+  "#{hello}"
+end
+
+get '/render' do
+  code = "<%= Time.now %>"
+  erb code
+end
+
+get '/rendererb' do
+  erb :index
+end
+
+def hello
+  hello_str = "hello"
+  OpenTracing.start_active_span("hello") do
+    puts hello_str
+  end
+  hello_str
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-instrumentation
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ashwin Chandrasekar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: opentracing_test_tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: opentracing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rack-tracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: OpenTracing compatible auto-instrumentation for Sinatra web applications.
+email:
+- achandrasekar@signalfx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/sinatra_1.0.gemfile
+- gemfiles/sinatra_1.1.4.gemfile
+- gemfiles/sinatra_1.2.9.gemfile
+- gemfiles/sinatra_1.3.6.gemfile
+- gemfiles/sinatra_1.4.8.gemfile
+- gemfiles/sinatra_2.0.0.gemfile
+- gemfiles/sinatra_latest.gemfile
+- lib/sinatra/instrumentation.rb
+- lib/sinatra/instrumentation/version.rb
+- sinatra-tracer.gemspec
+- test_app/Gemfile
+- test_app/hello.rb
+homepage: http://github.com/signalfx/ruby-sinatra-instrumentation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Instrumentation for Sinatra applications
+test_files: []