influx_reporter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b0c481adf3b258ec29fc1a2a526d2d4053fbb50
+  data.tar.gz: f1fce2792f3ff3b7be73160c81aa9ce05dbd81d7
+SHA512:
+  metadata.gz: 345a3d341374f25b18ceed08ffd6ca770019e05b43c5391b716aec17ae3c63eb95af2287fa69e65a078feae930f2a6d4fc84be441b40143ead5df96e5a4d18cf
+  data.tar.gz: 54528657a0b66f92a36392f5dd768efd5137997ec8f1a1dc84d4174ec0982a320ca157000d594ff2a7cfa9fd186e100e5a221c2c50cba32e90f3101c74b155f4

data/.gitignore

@@ -0,0 +1,7 @@
+doc
+coverage
+Gemfile.lock
+influx_reporter*.gem
+.yardoc
+profile-*
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,51 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  TargetRailsVersion: 4.2
+  Exclude:
+    - 'Dangerfile'
+    - 'vendor/**.rb'
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 4
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: true
+#  Enabled: false
+Layout/FirstParameterIndentation:
+  IndentationWidth: 4
+Layout/IndentHash:
+  IndentationWidth: 4
+Layout/MultilineMethodCallIndentation:
+  IndentationWidth: 4
+  EnforcedStyle: indented_relative_to_receiver
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/EmptyElse:
+  EnforcedStyle: empty
+Style/FormatStringToken:
+  EnforcedStyle: template
+Metrics/LineLength:
+  Max: 180
+Metrics/ClassLength:
+  Max: 150
+Metrics/CyclomaticComplexity:
+  Max: 7
+Metrics/MethodLength:
+  Max: 20
+Metrics/ModuleLength:
+  Max: 150
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Max: 8
+Metrics/AbcSize:
+  Max: 17
+Metrics/BlockLength:
+  ExcludedMethods:
+    - context
+    - describe
+    - namespace
+    - resources
+    - it
+    - configure

data/.travis.yml

@@ -0,0 +1,42 @@
+---
+language: ruby
+cache: bundler
+env:
+  - CI=true
+before_install:
+  - gem install bundler
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.3
+  - 2.3.3
+  - 2.4.0
+gemfile:
+  - gemfiles/Gemfile.rails-3.2.x
+  - gemfiles/Gemfile.rails-4.0.x
+  - gemfiles/Gemfile.rails-4.1.x
+  - gemfiles/Gemfile.rails-4.2.x
+  - gemfiles/Gemfile.rails-5.0.x
+matrix:
+  include:
+    - rvm: 2.3.3
+      gemfile: gemfiles/Gemfile.rails-HEAD
+
+  exclude:
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile.rails-5.0.x
+    - rvm: 2.1.6
+      gemfile: gemfiles/Gemfile.rails-5.0.x
+    - rvm: 2.4.0
+      gemfile: gemfiles/Gemfile.rails-3.2.x
+    - rvm: 2.4.0
+      gemfile: gemfiles/Gemfile.rails-4.0.x
+    - rvm: 2.4.0
+      gemfile: gemfiles/Gemfile.rails-4.1.x
+    - rvm: 2.4.0
+      gemfile: gemfiles/Gemfile.rails-4.2.x
+
+notifications:
+  email: false
+  slack:
+    secure: IniiL3PdFsht2zykTwd/z5Et/L1U6GzsmMC1LrgccKCrvLsdcdlBU3VrAgIb1GT9FPEFpb5sl7FEBN80p6uW15uO57onUawFaSWDhSA3eXG1ImmunVPJ20U4NkJvMbnUdZXQ9XXqOw1ggkR7GrD0PM9Nzr4puWaaGq42UJjdaq0=

data/.yardopts

@@ -0,0 +1,3 @@
+--hide-api private
+--exclude lib/influx_reporter/integration
+lib/**/*.rb

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:alpine
+
+RUN apk upgrade --update && \
+    apk add --no-cache git libffi build-base zlib g++ ncurses readline yaml sqlite-dev ca-certificates \
+        tzdata libxml2-dev && \
+    mkdir -p /app
+WORKDIR /app
+COPY . /app/
+RUN bundle install

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+eval_gemfile 'gemfiles/Gemfile.rails-5.0.x'
+
+gem 'pry'
+gem 'ruby-debug-ide'
+gem 'debase'

data/HISTORY.md

@@ -0,0 +1 @@
+# 1.0.0

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2018, GenieBelt ApS
+All rights reserved.
+
+Library use code copyrighted by Opbeat Inc.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,189 @@
+## Installation
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem 'influx_reporter', '~> 1.0.0'
+```
+
+The InfluxReporter gem adheres to [Semantic
+Versioning](http://guides.rubygems.org/patterns/#semantic-versioning)
+and so you can safely trust all minor and patch versions (e.g. 1.x.x) to
+be backwards compatible.
+
+## Usage
+
+### Rails 3/4/5
+
+Add the following to your `config/environments/production.rb`:
+
+```ruby
+Rails.application.configure do |config|
+  # ...
+  config.influx_reporter.database = 'endpoints'
+  config.influx_reporter.influx_db = {
+    host: 'influxdb.local',
+    port: '8080'
+  }
+```
+
+### Rack
+
+```ruby
+require 'influx_reporter'
+
+# set up an InfluxReporter configuration
+config = InfluxReporter::Configuration.new do |conf|
+  conf.influx_reporter.database = 'endpoints'
+  conf.influx_reporter.influx_db = {
+      host: 'influxdb.local',
+      port: '8080'
+  }
+  conf.tags = { 
+    environment: ENV['RACK_ENV']
+  }
+end
+
+# start the InfluxReporter client
+InfluxReporter.start! config
+
+# install the InfluxReporter middleware
+use InfluxReporter::Middleware
+
+```
+
+## Configuration
+
+InfluxReporter works with just the InfluxDB host configuration.
+
+#### Enable in development and other environments
+
+As a default InfluxReporter only runs in production. You can make it run in other environments by adding them to the `enabled_environments` whitelist.
+
+```ruby
+config.influx_reporter.enabled_environments += %w{development}
+```
+
+#### Ignore specific exceptions
+
+```ruby
+config.influx_reporter.excluded_exceptions += %w{
+  ActiveRecord::RecordNotFound
+  ActionController::RoutingError
+}
+```
+
+### Sanitizing data
+
+InfluxReporter can strip certain data points from the reports it sends like passwords or other sensitive information. If you're on Rails the list will automatically include what you have in `config.filter_parameters`.
+
+Add or modify the list using the `filter_parameters` configuration:
+
+```ruby
+config.influx_reporter.filter_parameters += [/regex(p)?/, "string", :symbol]
+```
+
+### User information
+
+InfluxReporter can automatically add user information to errors. By default it looks for at method called `current_user` on the current controller. To change the method use `current_user_method`.
+
+```ruby
+config.influx_reporter.current_user_method = :current_employee
+```
+
+### Error context
+
+You may specify extra context for errors ahead of time by using `InfluxReporter.set_context` eg:
+
+```ruby
+class DashboardController < ApplicationController
+  before_action do
+    InfluxReporter.set_context(tags: { timezone: current_user.timezone }, values: { my_value: 11 })
+  end
+end
+```
+
+or by specifying it as a block using `InfluxReporter.with_context` eg:
+
+```ruby
+InfluxReporter.with_context(values: { user_id: @user.id }) do
+  UserMailer.welcome_email(@user).deliver_now
+end
+```
+
+### Transaction context
+You may specify extra context for performance transaction
+
+```ruby
+InfluxReporter.client&.current_transaction&.extra_tags do |tags|
+  tags[:locale] = I18n.locale
+end
+InfluxReporter.client&.current_transaction&.extra_values do |values|
+  values[:uuid] = request.uuid
+end
+```
+
+
+## Background processing
+
+InfluxReporter automatically catches exceptions in [delayed_job](https://github.com/collectiveidea/delayed_job) or [sidekiq](http://sidekiq.org/).
+
+To enable InfluxReporter for [resque](https://github.com/resque/resque), add the following (for example in `config/initializers/influx_reporter_resque.rb`):
+
+```ruby
+require "resque/failure/multiple"
+require "influx_reporter/integration/resque"
+
+Resque::Failure::Multiple.classes = [InfluxReporter::Integration::Resque]
+Resque::Failure.backend = Resque::Failure::Multiple
+```
+
+## Manual profiling
+
+It's easy to add performance tracking wherever you want using the `InfluxReporter` module.
+
+Basically you have to know about two concepts: `Transaction` and `Trace`.
+
+**Transactions** are a bundles of transactions. In a typical webapp every request is wrapped in a transaction. If you're instrumenting worker jobs, a single job run would be a transaction.
+
+**Traces** are spans of time that happen during a transaction. Like a call to the database, a render of a view or a HTTP request. InfluxReporter will automatically trace the libraries that it knows of and you can manually trace whatever else you'd like to.
+
+The basic api looks like this:
+
+```ruby
+InfluxReporter.transaction "Transaction identifier" do
+  data = InfluxReporter.trace "Preparation" do
+    prepare_data
+  end
+  InfluxReporter.trace "Description", "kind" do
+    perform_expensive_task data
+  end
+end.done(200)
+```
+
+If you are inside a web request, you are already inside a transaction so you only need to use trace:
+
+```ruby
+class UsersController < ApplicationController
+
+  def extend_profiles
+    users = User.all
+
+    InfluxReporter.trace "prepare users" do
+      users.each { |user| user.extend_profile! }
+    end
+
+    render text: 'ok'
+  end
+
+end
+```
+
+## Testing and development
+
+```bash
+$ bundle install
+$ rspec spec
+```
+
+## Resources

data/Rakefile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rubygems/package_task'
+gemspec = Gem::Specification.load(Dir['*.gemspec'].first)
+Gem::PackageTask.new(gemspec).define
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task default: :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+task :mem_profile do
+  require 'memory_profiler'
+  $LOAD_PATH.unshift Dir.pwd + '/lib'
+
+  filename = "profile-#{Time.now.to_i}.txt"
+
+  MemoryProfiler.report(allow_files: /influx_reporter/i) do
+    require 'influx_reporter'
+  end.pretty_print(to_file: filename)
+
+  filename
+end

data/gemfiles/Gemfile.base

@@ -0,0 +1,29 @@
+source "http://rubygems.org"
+
+gemspec path: File.expand_path('../..', __FILE__)
+
+ruby RUBY_VERSION
+
+gem 'rake'
+gem 'rspec'
+gem 'timecop'
+gem 'webmock'
+gem 'rack-test'
+
+gem 'yard'
+gem 'simplecov'
+
+# external libs
+
+gem 'redis'
+gem 'fakeredis'
+gem 'sqlite3', platform: :mri
+gem 'sequel'
+
+gem 'delayed_job', require: false
+gem 'resque', require: false
+
+# Freeze Sidekiq to < 5 in Ruby 2.2 Gemfiles
+if RUBY_VERSION >= '2'
+  gem 'sidekiq', (RUBY_VERSION >= '2.2.2' ? '~> 5' : '~> 4'), require: false
+end

data/gemfiles/Gemfile.rails-3.2.x

@@ -0,0 +1,4 @@
+eval_gemfile File.expand_path('../Gemfile.base', __FILE__)
+
+gem 'rails', '~> 3.2.0'
+gem 'sinatra'

data/gemfiles/Gemfile.rails-4.0.x

@@ -0,0 +1,4 @@
+eval_gemfile File.expand_path('../Gemfile.base', __FILE__)
+
+gem 'rails', '~> 4.0.0'
+gem 'sinatra'

data/gemfiles/Gemfile.rails-4.1.x

@@ -0,0 +1,4 @@
+eval_gemfile File.expand_path('../Gemfile.base', __FILE__)
+
+gem 'rails', '~> 4.1.0'
+gem 'sinatra'

data/gemfiles/Gemfile.rails-4.2.x

@@ -0,0 +1,5 @@
+eval_gemfile File.expand_path('../Gemfile.base', __FILE__)
+
+gem 'rails', '~> 4.2.0'
+gem 'nokogiri', '< 1.7'
+gem 'sinatra'

data/gemfiles/Gemfile.rails-5.0.x

@@ -0,0 +1,5 @@
+eval_gemfile File.expand_path('../Gemfile.base', __FILE__)
+
+gem 'rails', '~> 5.0.0'
+gem 'tzinfo-data'
+gem 'sinatra'

data/gemfiles/Gemfile.rails-HEAD

@@ -0,0 +1,7 @@
+eval_gemfile File.expand_path('../Gemfile.base', __FILE__)
+
+gem 'rack', git: 'https://github.com/rack/rack.git'
+gem 'arel', git: 'https://github.com/rails/arel.git'
+gem 'rails', git: 'https://github.com/rails/rails.git'
+gem 'sinatra', git: 'https://github.com/sinatra/sinatra.git'
+