inst_statsd 3.0.6 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f7ff23c72ad7a2d4055a5b511bc358d452d596b5a70b91b48dbab2837b57789
-  data.tar.gz: e90e0dafba21a6cd519ab4341963007132be3e7722bc81d8d013f250c3794cc4
+  metadata.gz: 57fa28e5cb8fa8bc63d35ca8233d41b3f79f58107c266b708f7d9c60e38d7f81
+  data.tar.gz: 45e23f3284b62308099fb6ab7167ef7036d4bbc4a87fb32dcf70a1bd246674b6
 SHA512:
-  metadata.gz: 721e8a6e1805deb8c63a2ccc9a69d29621e99d4e699f7faf9fac7d96e86396a358da68f49d391586bbda59414ce61143139f6bc551fdc8a85987c2fb7d579ec6
-  data.tar.gz: 57eabc93c85a1e6f2bd92632d8e1aa78ec365236c4d54f3ad3feffd934fba500f6357f4661b4172064376c825ff720bfde4f9428442858fa19d22f1e9350cad2
+  metadata.gz: 79d3b39e1de95726c07a623f2d317fa512f9d3fee346afbc26b1ec8435919783a46887292e54777a9e7ee19ca51314aa8e703729fa5bc5fc45bef121eebffe56
+  data.tar.gz: 3de309abbcc308546567c280c98c910b34cece7dd27dad1cea4911e3b5f7fb263a997f26128bfa1541ae5d23e87c93f36da98b8c13790c42734980444446f42a

data/lib/inst_statsd/event.rb

@@ -4,24 +4,55 @@ 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
+    DEPLOY_EVENT = "deploy"
+    FEATURE_EVENT = "feature"
+    PROVISION_EVENT = "provision"
+    REFRESH_EVENT = "refresh"
+
+    SUPPORTED_TYPES = [
+      DEPLOY_EVENT,
+      FEATURE_EVENT,
+      PROVISION_EVENT,
+      REFRESH_EVENT
     ].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.
+    # A dynamic method that uses the class constants to create a specific event type
+    #
+    # @param [String] title Event title
+    # @param [String] description Event description. Supports newlines (+\n+)
+    # @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 [String, nil] :date_happened (nil) Assign a timestamp
+    #
+    # @example Report a flag flip event:
+    #   InstStatsd::Statsd.feature_event(
+    #     "Feature Flag Change",
+    #     "Feature flag <flag_name> was flipped to <flag_state>",
+    #     tags: {foo: 'bar'}
+    #   )
+
+    SUPPORTED_TYPES.each do |event_name|
+      define_method("#{event_name}_event") do |*args, **kwargs|
+        event(
+          *args,
+          type: event_name,
+          alert_type: :success,
+          priority: :normal,
+          **kwargs
+        )
+      end
+    end
+
+    # This end point allows you to post events to the DataDog 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 [String] description Event description. Supports newlines (+\n+)
+    # @param [String, nil] :type. It is recommended to use the constants
     # @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.
@@ -38,12 +69,12 @@ module InstStatsd
     #       type: 'deploy',
     #       alert_type: :success
     #   )
-    def event(title, text, type: nil, tags: {}, alert_type: nil, priority: nil, date_happened: nil)
+    def event(title, description, type: nil, tags: {}, alert_type: nil, priority: nil, date_happened: nil)
       return unless instance && data_dog?
 
       instance.event(
         title,
-        text,
+        description,
         **{
           alert_type: alert_type,
           priority: priority,
@@ -57,7 +88,7 @@ module InstStatsd
 
     def tags_from_opts(tags, type, dd_tags)
       custom_tags = tags.merge(dd_tags)
-      custom_tags[:type] = type.to_sym if SUPPORTED_TYPES.include? type&.to_sym
+      custom_tags[:type] = type
       custom_tags.compact
     end
   end

data/lib/inst_statsd/version.rb

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

data/spec/inst_statsd/event_spec.rb

@@ -14,6 +14,49 @@ RSpec.describe InstStatsd::Event do
   let(:dog_tags) { {} }
   let(:opts) { {} }
 
+  describe "#feature_event" do
+    subject { feature_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,
+          alert_type: :success,
+          priority: :normal,
+          tags: { type: InstStatsd::Event::FEATURE_EVENT }
+        )
+
+        subject
+      end
+    end
+
+    context "with all opts set" do
+      let(:date_happened) { Time.now.to_i }
+      let(:opts) do
+        {
+          date_happened: date_happened,
+          tags: { foo: "bar" }
+        }
+      end
+
+      it "sets all arguments" do
+        expect(instance).to receive(:event).with(
+          title,
+          text,
+          alert_type: :success,
+          priority: :normal,
+          date_happened: date_happened,
+          tags: { foo: "bar", type: InstStatsd::Event::FEATURE_EVENT }
+        )
+
+        subject
+      end
+    end
+  end
+
   describe "#event" do
     subject { event(title, text, **opts) }
 
@@ -77,28 +120,14 @@ RSpec.describe InstStatsd::Event do
       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 } }
+      let(:opts) { { type: InstStatsd::Event::DEPLOY_EVENT } }
 
       it "sets the valid aggregation key" do
         expect(instance).to receive(:event).with(
           title,
           text,
-          tags: { type: :deploy }
+          tags: { type: InstStatsd::Event::DEPLOY_EVENT }
         )
 
         subject
@@ -112,7 +141,7 @@ RSpec.describe InstStatsd::Event do
         expect(instance).to receive(:event).with(
           title,
           text,
-          tags: { type: :deploy }
+          tags: { type: InstStatsd::Event::DEPLOY_EVENT }
         )
 
         subject
@@ -137,7 +166,7 @@ RSpec.describe InstStatsd::Event do
       let(:date_happened) { Time.now.to_i }
       let(:opts) do
         {
-          type: :deploy,
+          type: InstStatsd::Event::DEPLOY_EVENT,
           alert_type: :warning,
           priority: :low,
           date_happened: date_happened,
@@ -152,7 +181,7 @@ RSpec.describe InstStatsd::Event do
           alert_type: :warning,
           priority: :low,
           date_happened: date_happened,
-          tags: { foo: "bar", type: :deploy }
+          tags: { foo: "bar", type: InstStatsd::Event::DEPLOY_EVENT }
         )
 
         subject

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inst_statsd
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.1.0
 platform: ruby
 authors:
 - Nick Cloward
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aroi