inst_statsd 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4be1145693a7188f19fe5b64206465eeece936dd9220f9185d1d87e5d895e91c
-  data.tar.gz: f9f61e0ceb159ff2dabc3b8bda50e9ab5edb299e94d5ab3fed4a664815137697
+  metadata.gz: 8b3f7337500a808963c072d5a5f752cdb4c1934bfdbb597fb926bbde54b1ee7f
+  data.tar.gz: b6375958a56e88a8a0c1ffb766ae8ec31f517071f8032b8ef4947301aac9cbf8
 SHA512:
-  metadata.gz: c588cc8d11fc48e12808183efc310f98468b2c1e508e98864c8c796d60a22508fec115694dc56f03a311511e17cd221badff168bfaf77dc414581ca829f62a24
-  data.tar.gz: 7020ddd2f162501c846c280b7e93d4e037479edd7cea347267911607c3da3b578096cb2ef426f0fd86ddeac077b8ded803c7ebe50dd1c501704c9f537ce1e9af
+  metadata.gz: 23d76e604d9a734e6d1f8530ddbf169a0b6f8e429bdcfe6c15b474da4a9ce6d23e1bfcaef2657c7d7bbdb15ab8a33dc633a388712fe6e1900a3b52b132bbdab8
+  data.tar.gz: eec92096bc95d50b22cc2f2562d71f4843fa31b00578f34c5c46897a4a83f20666ff3dd47ad5be98c0d014c5ee6f533611047f91d0b6e60969c14b01388387f4

data/lib/inst_statsd/event.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module InstStatsd
+  # Mix-in methods for supporting DataDog events
+  # See https://docs.datadoghq.com/service_management/events/
+  module Event
+    SUPPORTED_TYPES = %i[
+      deploy
+      feature_disabled
+      feature_enabled
+      provision
+      refresh
+    ].freeze
+
+    def instance; end
+    def data_dog?; end
+    def dog_tags; end
+
+    # This end point allows you to post events to the DatDog event stream.
+    #
+    # @param [String] title Event title
+    # @param [String] text Event text. Supports newlines (+\n+)
+    # @param [String, nil] :type Can be "deploy", "feature_disabled",
+    #   "feature_enabled", "provision", or "refresh"
+    # @param [Hash] :tags tags to be added to event. Note that the
+    #   environment, service, and other data are automatically
+    #   added as tags for you without specifying them here.
+    # @param [Integer, String, nil] :date_happened (nil) Assign a timestamp
+    #   to the event. Default is now when none
+    # @param [String, nil] :priority ('normal') Can be "normal" or "low"
+    # @param [String, nil] :alert_type ('info') Can be "error", "warning", "info" or "success".
+    #
+    # @example Report an event:
+    #   InstStatsd::Statsd.event(
+    #       "Quiz API Deploy",
+    #       "<release> was deployed to Quiz API",
+    #       tags: {foo: 'bar'},
+    #       type: 'deploy',
+    #       alert_type: :success
+    #   )
+    def event(title, text, type: nil, tags: {}, alert_type: nil, priority: nil, date_happened: nil)
+      return unless instance && data_dog?
+
+      instance.event(
+        title,
+        text,
+        {
+          alert_type: alert_type,
+          priority: priority,
+          date_happened: date_happened,
+          tags: tags_from_opts(tags, type, dog_tags)
+        }.compact
+      )
+    end
+
+    private
+
+    def tags_from_opts(tags, type, dd_tags)
+      custom_tags = tags.merge(dd_tags)
+      custom_tags[:type] = type if SUPPORTED_TYPES.include? type
+      custom_tags.compact
+    end
+  end
+end

data/lib/inst_statsd/request_stat.rb

@@ -20,6 +20,7 @@ module InstStatsd
         self.short_stat = "request"
         self.tags[:controller] = controller if controller
         self.tags[:action] = action if action
+        self.tags[:status] = status if status
       else
         self.common_key = "request.#{controller}.#{action}" if controller && action
       end
@@ -48,6 +49,17 @@ module InstStatsd
       @payload.fetch(:params, {})['action']
     end
 
+    def status
+      status = @payload.fetch(:status, 0)
+      # Only return status group to reduce the number of indexed custom metrics (and cost) of datadog
+      return '1XX' if status >= 100 and status < 200
+      return '2XX' if status >= 200 and status < 300
+      return '3XX' if status >= 300 and status < 400
+      return '4XX' if status >= 400 and status < 500
+      return '5XX' if status >= 500 and status < 600
+      nil
+    end
+
     def total
       if (!@finish || !@start)
         return 0

data/lib/inst_statsd/statsd.rb

@@ -24,6 +24,8 @@
 
 module InstStatsd
   module Statsd
+    extend InstStatsd::Event
+
     # replace "." in key names with another character to avoid creating spurious sub-folders in graphite
     def self.escape(str, replacement = '_')
       str.respond_to?(:gsub) ? str.gsub('.', replacement) : str

data/lib/inst_statsd/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module InstStatsd
+  VERSION = "2.4.0"
+end

data/lib/inst_statsd.rb

@@ -8,6 +8,7 @@ module InstStatsd
 
   class ConfigurationError < StandardError; end
 
+  require 'inst_statsd/event'
   require 'inst_statsd/statsd'
   require 'inst_statsd/block_stat'
   require 'inst_statsd/block_tracking'

data/spec/inst_statsd/event_spec.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe InstStatsd::Event do
+  include described_class
+
+  let(:title) { "Title" }
+  let(:text) {"Some text."}
+
+  let(:instance) { double }
+  let(:data_dog?) { true }
+  let(:dog_tags) { {} }
+  let(:opts) { {} }
+
+  describe '#event' do
+    subject { event(title, text, opts) }
+
+    context 'with title and text only' do
+      let(:opts) { {} }
+
+      it 'invokes "event" on the instance with title and text' do
+        expect(instance).to receive(:event).with(
+          title,
+          text,
+          tags: {}
+        )
+
+        subject
+      end
+    end
+
+    context 'with alert_type set' do
+      let(:opts) { { alert_type: :error } }
+
+      it 'invokes "event" on the instance with expected arguments' do
+        expect(instance).to receive(:event).with(
+          title,
+          text,
+          alert_type: :error,
+          tags: {}
+        )
+
+        subject
+      end
+    end
+
+    context 'with priority set' do
+      let(:opts) { { priority: :low } }
+
+      it 'invokes "event" on the instance with expected arguments' do
+        expect(instance).to receive(:event).with(
+          title,
+          text,
+          priority: :low,
+          tags: {}
+        )
+
+        subject
+      end
+    end
+
+    context 'with date_happened set' do
+      let(:opts) { { date_happened: date_happened } }
+      let(:date_happened) { Time.now.to_i }
+
+      it 'invokes "event" on the instance with expected arguments' do
+        expect(instance).to receive(:event).with(
+          title,
+          text,
+          date_happened: date_happened,
+          tags: {}
+        )
+
+        subject
+      end
+    end
+
+    context 'with an invalid type set' do
+      let(:opts) { { type: :banana } }
+
+      it 'does not sent the invalid aggregation key' do
+        expect(instance).to receive(:event).with(
+          title,
+          text,
+          tags: {}
+        )
+
+        subject
+      end
+    end
+
+    context 'with a valid type set' do
+      let(:opts) { { type: :deploy } }
+
+      it 'sets the valid aggregation key' do
+        expect(instance).to receive(:event).with(
+          title,
+          text,
+          tags: {type: :deploy}
+        )
+
+        subject
+      end
+    end
+
+    context 'with custom tags' do
+      let(:opts) { { tags: { project: 'cool-project'} } }
+
+      it 'invokes "event" on the instance with expected arguments' do
+        expect(instance).to receive(:event).with(
+          title,
+          text,
+          tags: { project: 'cool-project' }
+        )
+
+        subject
+      end
+    end
+
+    context 'with all opts set' do
+      let(:date_happened) { Time.now.to_i }
+      let(:opts) do
+        {
+          type: :deploy,
+          alert_type: :warning,
+          priority: :low,
+          date_happened: date_happened,
+          tags: { foo: 'bar' }
+        }
+      end
+
+      it 'sets all arguments' do
+        expect(instance).to receive(:event).with(
+          title,
+          text,
+          alert_type: :warning,
+          priority: :low,
+          date_happened: date_happened,
+          tags: { foo: 'bar', type: :deploy }
+        )
+
+        subject
+      end
+    end
+
+    context 'when the instance is not DataDog' do
+      let(:data_dog?) { false }
+
+      it { is_expected.to eq nil }
+
+      it 'does not invoke "event" on the instance' do
+        expect(instance).not_to receive(:event)
+
+        subject
+      end
+    end
+  end
+end

data/spec/inst_statsd/request_stat_spec.rb

@@ -70,6 +70,22 @@ describe InstStatsd::RequestStat do
     end
   end
 
+  describe '#status' do
+    it 'should return nil if status is not defined' do
+      rs = create_subject
+      expect(rs.status).to eq nil
+    end
+
+    it 'should return HTTP status group if present' do
+      expect(create_subject({status: 200}).status).to eq '2XX'
+      expect(create_subject({status: 201}).status).to eq '2XX'
+      expect(create_subject({status: 302}).status).to eq '3XX'
+      expect(create_subject({status: 400}).status).to eq '4XX'
+      expect(create_subject({status: 404}).status).to eq '4XX'
+      expect(create_subject({status: 503}).status).to eq '5XX'
+    end
+  end
+
   describe '#total' do
     it 'correctly calculates milliseconds from start, finish' do
       rs = create_subject({params: {}})
@@ -113,10 +129,11 @@ describe InstStatsd::RequestStat do
         params: {
           'controller' => 'foo',
           'action'     => 'index'
-        }
+        },
+        status: 200
       }
       rs = create_subject(payload, statsd)
-      expect(statsd).to receive(:timing).with('request.total', 1000, {short_stat: 'request.total', tags: {action: "index", controller: "foo"}} )
+      expect(statsd).to receive(:timing).with('request.total', 1000, {short_stat: 'request.total', tags: {action: "index", controller: "foo", status: '2XX'}} )
       rs.report
     end
 

data/spec/inst_statsd/statsd_spec.rb

@@ -10,6 +10,10 @@ describe InstStatsd::Statsd do
     InstStatsd::Statsd.reset_instance
   end
 
+  it 'includes the events module' do
+    expect(described_class).to respond_to :event
+  end
+
   it 'appends the hostname to stat names by default' do
     allow(InstStatsd::Statsd).to receive(:hostname).and_return('testhost')
     statsd = double

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: inst_statsd
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Nick Cloward
 - Jason Madsen
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
@@ -123,7 +123,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - ncloward@instructure.com
 - jmadsen@instructure.com
@@ -136,15 +136,18 @@ files:
 - lib/inst_statsd/block_tracking.rb
 - lib/inst_statsd/counter.rb
 - lib/inst_statsd/default_tracking.rb
+- lib/inst_statsd/event.rb
 - lib/inst_statsd/null_logger.rb
 - lib/inst_statsd/request_logger.rb
 - lib/inst_statsd/request_stat.rb
 - lib/inst_statsd/request_tracking.rb
 - lib/inst_statsd/sql_tracker.rb
 - lib/inst_statsd/statsd.rb
+- lib/inst_statsd/version.rb
 - spec/inst_statsd/block_stat_spec.rb
 - spec/inst_statsd/block_tracking_spec.rb
 - spec/inst_statsd/counter_spec.rb
+- spec/inst_statsd/event_spec.rb
 - spec/inst_statsd/inst_statsd_spec.rb
 - spec/inst_statsd/null_logger_spec.rb
 - spec/inst_statsd/request_logger_spec.rb
@@ -159,7 +162,7 @@ homepage: https://github.com/instructure/inst_statsd
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -167,21 +170,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.24
-signing_key:
+rubygems_version: 3.2.6
+signing_key: 
 specification_version: 4
 summary: Statsd for Instructure
 test_files:
 - spec/inst_statsd/block_stat_spec.rb
 - spec/inst_statsd/block_tracking_spec.rb
 - spec/inst_statsd/counter_spec.rb
+- spec/inst_statsd/event_spec.rb
 - spec/inst_statsd/inst_statsd_spec.rb
 - spec/inst_statsd/null_logger_spec.rb
 - spec/inst_statsd/request_logger_spec.rb