slimy 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eaf9b13b8237cd4762f4c47604094655839f8a3038325e82f09c7f80332e8323
+  data.tar.gz: 1b0265a125ed7d39f19b82950a0e2b0ce26a42f6eed340125069366321fcf0f7
+SHA512:
+  metadata.gz: 7bb3891e0c988132baa3a795cef5405e9e458f1d2d423948d01a9aa6f199caa0f12a9470a09f4764eb8144d44e61c87f8185e88939ce5efe94c6ec81924fccfb
+  data.tar.gz: e305fa2a3d37ae07567e34aad79c40a606c507006d018a7a0179acc27b40842541b2e5c9dbc7e12fa31c0b34b6ba987a69d844f5f60038e50ca7d9b379b7b4a8

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,8 @@
+
+AllCops:
+  TargetRubyVersion: 2.6
+  TargetRailsVersion: 6.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.tool-versions

@@ -0,0 +1,3 @@
+ruby 2.6.5
+nodejs 10.23.0
+yarn 1.19.1

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### v0.0.3 - 2020-12-04
+- Tested changelog
+### v0.0.2 - 2020-12-04
+- Added changelog

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    slimy (0.0.3)
+      rack (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.1)
+    builder (3.2.4)
+    bump (0.10.0)
+    jaro_winkler (1.5.3)
+    minitest (5.14.2)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.75.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    timecop (0.9.2)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bump
+  bundler (>= 1.0, < 3)
+  minitest (~> 5.14)
+  minitest-reporters (~> 1.4)
+  rake (~> 10.4, >= 10.4.2)
+  rubocop
+  slimy!
+  timecop (~> 0.9)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Lessonly
+
+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,39 @@
+# slimy
+
+SLI middleware for rack.  Most monitoring instrumentation is organized around Golden Signals, USE, RED, etc.  The goal of this library is to provide direct measurement useful for determining SLIs, SLOs and error budgets.
+## What is a Service Level Indicator (SLI)?
+
+This is a concept we learned from the [Google SRE BOOK (free)](https://sre.google/sre-book/service-level-objectives/).  Simply put this is a measure of (good event) / (total events).  Ideally this should measure of how the system is meeting user expectations.
+
+### Example
+
+Maybe your target for your homepage is to respond to requests within 50 milliseconds.
+
+
+* If you get 100 requests and all responses are then your SLI value is 100/100 (100%)
+* If you get 100 requests and 5 of the responses are errors and 5 of them take 100ms then your SLI value is 90/100 (90%)
+
+## What is a Service Level Objective (SLO)?
+
+An SLO is an SLI with some threshold you're trying to meet.
+
+In the homepage example above, that would be a high visiblity, high importance page so maybe you want 99.95% of requests to meet your success criteria.
+
+Maybe you have report that is fast for some customers, and slow for others.  The slow customers don't need the data urgently and everybody is happy so you might be happy with 90% of reports being generated in 120 seconds.
+
+This allows us to define error budgets and gives us a firm framework for prioritizing feature work vs performance issues that can often be seen as a "Nice to have" until it becomes an "Ooops this is functionally not working."
+
+
+
+[Error Budgets](https://sre.google/sre-book/embracing-risk/#xref_risk-management_unreliability-budgets)
+
+
+## SLAs?
+
+Service Level Agreements are contracts with external teams.  They're not unrelated but a bit beyond the scope of the goal here.
+
+## SLIs and other types of Monitoring
+
+There are many ways to monitoring running systems.  Golden Signals, RED, USE, are all important frameworks for monitoring and analyzing the health of a running system.  SLOs are 
+
+

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rake/testtask'
+require 'bump/tasks'
+require 'rubocop/rake_task'
+
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+desc "Run tests"
+
+task default: [:test, :rubocop]

data/lib/slimy.rb

@@ -0,0 +1,19 @@
+require "slimy/version"
+require "slimy/context"
+require "slimy/config"
+require "slimy/rack"
+require "slimy/rails"
+require "slimy/reporters"
+
+
+module Slimy
+  class << self
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/slimy/config.rb

@@ -0,0 +1,19 @@
+module Slimy
+  class Configuration
+
+    def initialize
+      @reporter = nil
+    end
+
+    attr_accessor :reporter
+
+
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+  end
+end

data/lib/slimy/context.rb

@@ -0,0 +1,104 @@
+module Slimy
+
+  # Slimy::Context
+  #
+  # This is a group of metadata that exists for the duration of some request to be measured
+  # as part of an SLI.
+  #
+  class Context
+
+    # Create a new context sets the `start_time` to now
+    #
+    # == Parameters
+    # start_time::
+    #   An overriden Time at which the event started.  Defaults to now.
+    #
+    # deadline::
+    #   ms that this context should be finished in to be considered acceptable
+    #
+    def initialize(start_time: nil, type: "request", deadline: nil)
+      @start_time = start_time || Time.now
+      @deadline = deadline
+      @result_status = :success
+      @end_time = nil
+      @tags = {}
+      @reportable = true
+      @type = type
+    end
+
+    attr_reader :start_time, :end_time, :type
+
+
+    attr_accessor :tags, :deadline
+
+    # Set the end_time value for the context if not already set
+    #
+    # == Parameters
+    # end_time::
+    #   An overriden Time at which the event ended.  Defaults to now.
+    #
+    def finish(end_time: nil)
+      @end_time = end_time || Time.now unless finished?
+    end
+
+    # Whether or not an end time has been set
+    def finished?
+      !@end_time.nil?
+    end
+
+    # mark request as having an error, or otherwise unacceptable for users
+    def result_error!
+      @result_status = :error
+    end
+
+    # was the result of the request an error?
+    def result_error?
+      @result_status == :error
+    end
+
+    # mark the result as being successful.
+    # This will not override deadline failure
+    def result_success!
+      @result_status = :success
+    end
+
+    # Was the execution path of this request normal (not an error)?
+    # This does not include deadline failures
+    def result_success?
+      @result_status == :success
+    end
+
+    # Returns true if there was no error and if the deadline was not reached.
+    def success?
+      result_success? && deadline_success?
+    end
+
+    # duration in ms of the event
+    def duration
+      return -1 unless finished?
+      [@end_time - @start_time,0].max * 1000.0
+    end
+
+    # Did the request finish before the deadline (or was there no deadline)
+    def deadline_success?
+      return true if @deadline.nil? || ! finished?
+      duration < @deadline
+    end
+
+    # Whether or not this context should be reported
+    def reportable?
+      @reportable
+    end
+
+    def don_not_report!
+      @reportable = false
+    end
+
+    # tool for debugging 
+    def debug_format
+      "slimy_ctx:\n\tfinished: #{finished?}\n\tduration: #{duration}\n\tresult_success: #{result_success?}\n\tduration_success: #{deadline_success?}\n\tsuccess: #{success?}\n\tdeadline: #{deadline}\n\ttags: #{tags.inspect}"
+    end
+
+  end
+
+end

data/lib/slimy/rack.rb

@@ -0,0 +1,3 @@
+module Slimy::Rack
+  autoload :SLIMiddleware, "slimy/rack/middleware"
+end

data/lib/slimy/rack/middleware.rb

@@ -0,0 +1,31 @@
+module Slimy::Rack
+  class SLIMiddleware
+
+    MIDDLEWARE_CONTEXT_KEY="slimy.milddeware.context"
+
+    def initialize(app)
+      @app = app
+      @reporter = Slimy::Configuration.default.reporter
+    end
+
+    def call(env)
+      context = Slimy::Context.new(deadline: 200, type: 'rack')
+      env[MIDDLEWARE_CONTEXT_KEY] = context
+      begin
+        response = @app.call(env)
+        context.result_error! if response[0] >= 500
+      rescue Exception => error
+        context.result_error!
+        raise error
+      ensure
+        context.finish
+        report(context)
+        return response
+      end
+    end
+
+    def report(context)
+      @reporter.report(context) unless @reporter.nil?
+    end
+  end
+end

data/lib/slimy/rails.rb

@@ -0,0 +1,3 @@
+module Slimy::Rails
+  autoload :SLITools, "slimy/rails/sli_concern"
+end

data/lib/slimy/rails/sli_concern.rb

@@ -0,0 +1,52 @@
+module Slimy::Rails
+
+  module SLITools extend ActiveSupport::Concern
+
+    included do
+
+      # class-level meta commands
+      def self.sli_tag(tag, value, except: nil, only: nil)
+        self.before_action only: only, except: except do
+          add_sli_tag(tag,value)
+        end
+      end
+
+      def self.sli_ignore(except: nil, only: nil)
+        self.before_action only: only, except: except do
+          add_sli_ignore
+        end
+      end
+
+      def self.sli_deadline(deadline, except: nil, only: nil)
+        self.before_action only: only, except: except do
+          add_sli_deadline(deadline)
+        end
+      end
+
+      before_action do
+        add_sli_tag("controller", controller_name)
+        add_sli_tag("action", action_name)
+      end
+
+      # helpers
+      def slimy_context
+        request.env[Slimy::Rack::SLIMiddleware::MIDDLEWARE_CONTEXT_KEY]
+      end
+
+      def add_sli_tag(tag,value)
+        ctx = slimy_context
+        ctx.tags[tag] = value unless ctx.nil?
+      end
+
+      def add_sli_ignore
+        ctx = slimy_context
+        ctx.do_not_report! unless ctx.nil?
+      end
+
+      def add_sli_deadline(deadline)
+        ctx = slimy_context
+        ctx.deadline = deadline unless ctx.nil?
+      end
+    end
+  end
+end

data/lib/slimy/reporters.rb

@@ -0,0 +1,6 @@
+require "slimy/reporters/reporter"
+
+module Slimy::Reporters
+  autoload :RailsLogReporter, "slimy/reporters/rails_log_reporter"
+  autoload :DatadogReporter, "slimy/reporters/datadog"
+end

data/lib/slimy/reporters/datadog.rb

@@ -0,0 +1,25 @@
+module Slimy::Reporters
+  class DatadogReporter < BaseReporter
+
+    def initialize(dogstatsd)
+      @dogstatsd = dogstatsd
+    end
+
+    def report(context)
+      return unless context.reportable?
+
+      current_span = Datadog.tracer.active_span
+      unless current_span.nil?
+        sli_status =(context.success? ? "success" : "failure")
+        current_span.set_tag('sli_status', sli_status)
+        current_span.set_tag('sli_deadline', context.deadline)
+        context.tags.each_pair do |key, value|
+          current_span.set_tag(key,value)
+        end
+        @dogstatsd.increment("sli.#{context.type}.#{sli_status}", tags: context.tags)
+      else
+        Rails.logger.debug("COULD  NOT FIND SPAN")
+      end
+    end
+  end
+end

data/lib/slimy/reporters/rails_log_reporter.rb

@@ -0,0 +1,16 @@
+module Slimy::Reporters
+
+  class RailsLogReporter
+    def initialize(level: :debug)
+      @level = level
+    end
+
+    def report(context)
+      log(context.debug_format)
+    end
+
+    def log(msg)
+      Rails.logger.send(@level, msg)
+    end
+  end
+end

data/lib/slimy/reporters/reporter.rb

@@ -0,0 +1,9 @@
+module Slimy::Reporters
+
+  class BaseReporter
+
+    def report(context)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/slimy/version.rb

@@ -0,0 +1,3 @@
+module Slimy
+  VERSION = "0.0.3"
+end

data/slimy.gemspec

@@ -0,0 +1,28 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "slimy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "slimy"
+  s.version     = Slimy::VERSION
+  s.date        = "2020-12-01"
+  s.summary     = "SLI metrics middleware"
+  s.description = "Provide a simple and consistent library for recording SLI" \
+                  + "type metrics for Rack, Sidekiq, and maybe more."
+  s.authors     = ["Tyler Henrichs", "Stephen Gregory"]
+  s.email       = "devops+slimy@lessonly.com"
+  s.homepage    = "https://rubygems.org/gems/slimy"
+  s.license     = "MIT"
+  s.files       = `git ls-files`.split("\n")
+
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "rack", "~> 2.0"
+
+  s.add_development_dependency "bump"
+  s.add_development_dependency "bundler", ">= 1.0", "< 3"
+  s.add_development_dependency "minitest", "~> 5.14"
+  s.add_development_dependency "minitest-reporters", "~> 1.4"
+  s.add_development_dependency "rake", "~> 10.4", ">= 10.4.2"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "timecop", "~> 0.9"
+end

data/test/slimy/context_test.rb

@@ -0,0 +1,48 @@
+require "test_helper"
+
+class ContextTest < Minitest::Test
+
+  def test_that_context_new_works
+    context = Slimy::Context.new
+    refute_nil context
+    refute context.finished?
+  end
+
+  def test_finish_exceeds_deadline
+    context = Slimy::Context.new(deadline: 20)
+
+    freeze_ms(30) do
+      context.finish
+      assert context.finished?
+      refute context.deadline_success?, "duration: #{context.duration} should be less than 20"
+      assert context.result_success?
+      refute context.success?
+    end
+  end
+
+  def test_finish_within_deadline
+    context = Slimy::Context.new(deadline: 200)
+
+    freeze_ms(100) do
+      context.finish
+      assert context.finished?
+      assert context.deadline_success?
+      assert context.result_success?
+      assert context.success?
+    end
+  end
+
+  def test_error_finish_within_deadline
+    context = Slimy::Context.new(deadline: 200)
+
+    freeze_ms(100) do
+      context.result_error!
+      context.finish
+      assert context.finished?
+      assert context.deadline_success?
+      refute context.result_success?
+      refute context.success?
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'slimy'
+require 'timecop'
+
+
+def freeze_ms(duration_ms)
+  Timecop.freeze(Time.now+(duration_ms/1000.0)) do
+    yield
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: slimy
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Tyler Henrichs
+- Stephen Gregory
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Provide a simple and consistent library for recording SLItype metrics
+  for Rack, Sidekiq, and maybe more.
+email: devops+slimy@lessonly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/slimy.rb
+- lib/slimy/config.rb
+- lib/slimy/context.rb
+- lib/slimy/rack.rb
+- lib/slimy/rack/middleware.rb
+- lib/slimy/rails.rb
+- lib/slimy/rails/sli_concern.rb
+- lib/slimy/reporters.rb
+- lib/slimy/reporters/datadog.rb
+- lib/slimy/reporters/rails_log_reporter.rb
+- lib/slimy/reporters/reporter.rb
+- lib/slimy/version.rb
+- slimy.gemspec
+- test/slimy/context_test.rb
+- test/test_helper.rb
+homepage: https://rubygems.org/gems/slimy
+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: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: SLI metrics middleware
+test_files: []