routes_alerts 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3af83f1b06855dd7430a019b27ed602e73198df30946387c9cd4872b7e53e31e
+  data.tar.gz: d638319a534fc7e17dd9efc9b9db6d21340ac4a7538448db25bf8e7176f6dd4b
+SHA512:
+  metadata.gz: 2cc5fe7a72e69f74ccebf5c5f352377937088616ccd02486af085ccf72c82f2b3d3ef3b7395cae3573c65fc83801b4c90e976751293588d347b4d0d757335e22
+  data.tar.gz: 99d8ca7e90ee2a3a84f7674f6e0b4f4e0a732f6f4be236e91c6273f41ce9727153e7ea1bc7169e64e6fa5ddbedb5f83c9faeb458089006961c47c02d1f22518f

data/lib/routes_alerts/configuration.rb

@@ -0,0 +1,54 @@
+require 'aws-sdk-cloudwatchlogs'
+require_relative "./metrics.rb"
+require_relative "./route_info.rb"
+
+module RoutesAlerts
+  class Configuration
+    DEFAULT_ALARM_PERIOD = 300
+    DEFAULT_NUMBER_OF_DATAPOINTS = 2
+    DEFAULT_MAX_DURATION = 100.0
+    DEFAULT_MIN_COUNT = 1
+    DEFAULT_SUCCESS_RATE = 99.0
+
+    attr_accessor :routes,
+                  :default_alarm_period,
+                  :default_number_of_datapoints,
+                  :default_max_duration,
+                  :default_min_count,
+                  :default_success_rate,
+                  :default_metrics,
+                  :default_log_group_name,
+                  :default_namespace,
+                  :cloudwatch_logs,
+                  :default_actions
+
+    def initialize
+      @cloudwatch_logs = Aws::CloudWatchLogs::Client.new(region: "us-west-2")
+      @default_alarm_period = DEFAULT_ALARM_PERIOD
+      @default_number_of_datapoints = DEFAULT_NUMBER_OF_DATAPOINTS
+      @default_max_duration = DEFAULT_MAX_DURATION
+      @default_min_count = DEFAULT_MIN_COUNT
+      @default_success_rate = DEFAULT_SUCCESS_RATE
+      @default_metrics = RoutesAlerts::Metrics::DEFAULT_METRICS
+      @routes = []
+      @default_actions = []
+    end
+
+    def add_route(path:, method:, max_duration:, min_count:, success_rate:, alarm_period:, number_of_datapoints:, metrics:, namespace:, log_group_name:, actions:)
+      route_info = RoutesAlerts::RouteInfo.new(
+        path: path.to_s,
+        method: method.to_s.upcase,
+        max_duration: (max_duration || default_max_duration).to_f,
+        min_count: (min_count || default_min_count).to_i,
+        success_rate: (success_rate || default_success_rate).to_f,
+        alarm_period: (alarm_period || default_alarm_period).to_i,
+        number_of_datapoints: (number_of_datapoints || default_number_of_datapoints).to_i,
+        log_group_name: (log_group_name || default_log_group_name),
+        namespace: (namespace || default_namespace),
+        actions: (actions || default_actions),
+        metrics: (metrics || default_metrics)
+      )
+      self.routes << route_info
+    end
+  end
+end

data/lib/routes_alerts/metrics/base.rb

@@ -0,0 +1,37 @@
+class RoutesAlerts::Base
+  attr_reader :route_info, :config
+
+  def initialize(config, route_info)
+    @config = config
+    @route_info = route_info
+  end
+
+  def metric_params
+    raise NotImplementedError, "Subclasses must implement the metric_params method"
+  end
+
+  def alarm_params
+    raise NotImplementedError, "Subclasses must implement the alarm_params method"
+  end
+
+  def create!
+    config.cloudwatch_logs.put_metric_filter(metric_params)
+    config.cloudwatch_logs.put_metric_alarm(alarm_params)
+  end
+
+  def log_group_name
+    route_info.log_group_name
+  end
+
+  def namespace
+    route_info.namespace
+  end
+
+  def route_name
+    "#{route_info.method}-#{route_info.path.gsub("/", "_").gsub("{", "").gsub("}", "")}"
+  end
+
+  def actions
+    route_info.actions.any? ? route_info.actions : nil
+  end
+end

data/lib/routes_alerts/metrics/count.rb

@@ -0,0 +1,44 @@
+require_relative "./base.rb"
+
+class RoutesAlerts::Count < RoutesAlerts::Base
+  def filter_pattern
+    "{ $.path = \"#{route_info.path}\" && $.method = \"#{route_info.method}\" }"
+  end
+
+  def metric_params
+    {
+      log_group_name: log_group_name,
+      filter_name: "#{RoutesAlerts::Metrics::COUNT_METRIC_NAME}-#{route_name}",
+      filter_pattern: filter_pattern,
+      metric_transformations: [
+        {
+          metric_name: "#{RoutesAlerts::Metrics::COUNT_METRIC_NAME}-#{route_name}",
+          metric_namespace: namespace,
+          metric_value: "1",
+          default_value: 0,
+          unit: "Count",
+        },
+      ]
+    }
+  end
+
+  def alarm_params
+    {
+      alarm_name: "Alarm-#{RoutesAlerts::Metrics::COUNT_METRIC_NAME}-#{route_name}",
+      actions_enabled: !!actions&.any?,
+      ok_actions: actions,
+      alarm_actions: actions,
+      metric_name: "#{RoutesAlerts::Metrics::COUNT_METRIC_NAME}-#{route_name}",
+      namespace: namespace,
+      statistic: "Sum",
+      dimensions: [],
+      period: route_info.alarm_period,
+      unit: "Count",
+      evaluation_periods: route_info.number_of_datapoints,
+      datapoints_to_alarm: route_info.number_of_datapoints,
+      threshold: route_info.min_count,
+      comparison_operator: "LessThanOrEqualToThreshold",
+      treat_missing_data: "notBreaching",
+    }
+  end
+end

data/lib/routes_alerts/metrics/duration.rb

@@ -0,0 +1,44 @@
+require_relative "./base.rb"
+
+class RoutesAlerts::Duration < RoutesAlerts::Base
+  def filter_pattern
+    "{ $.path = \"#{route_info.path}\" && $.method = \"#{route_info.method}\" && EXISTS($.duration) }"
+  end
+
+  def metric_params
+    {
+      log_group_name: log_group_name,
+      filter_name: "#{RoutesAlerts::Metrics::DURATION_METRIC_NAME}-#{route_name}",
+      filter_pattern: filter_pattern,
+      metric_transformations: [
+        {
+          metric_name: "#{RoutesAlerts::Metrics::DURATION_METRIC_NAME}-#{route_name}",
+          metric_namespace: namespace,
+          metric_value: "$.duration",
+          default_value: 0,
+          unit: "Milliseconds",
+        },
+      ]
+    }
+  end
+
+  def alarm_params
+    {
+      alarm_name: "Alarm-#{RoutesAlerts::Metrics::DURATION_METRIC_NAME}-#{route_name}",
+      actions_enabled: !!actions&.any?,
+      ok_actions: actions,
+      alarm_actions: actions,
+      metric_name: "#{RoutesAlerts::Metrics::DURATION_METRIC_NAME}-#{route_name}",
+      namespace: namespace,
+      statistic: "Average",
+      dimensions: [],
+      period: route_info.alarm_period,
+      unit: "Milliseconds",
+      evaluation_periods: route_info.number_of_datapoints,
+      datapoints_to_alarm: route_info.number_of_datapoints,
+      threshold: route_info.max_duration,
+      comparison_operator: "GreaterThanThreshold",
+      treat_missing_data: "notBreaching",
+    }
+  end
+end

data/lib/routes_alerts/metrics/success_rate.rb

@@ -0,0 +1,44 @@
+require_relative "./base.rb"
+
+class RoutesAlerts::SuccessRate < RoutesAlerts::Base
+  def filter_pattern
+    "{ $.path = \"#{route_info.path}\" && $.method = \"#{route_info.method}\" && $.status >= 200 && $.status < 300 }"
+  end
+
+  def metric_params
+    {
+      log_group_name: log_group_name,
+      filter_name: "#{RoutesAlerts::Metrics::SUCCESS_METRIC_NAME}-#{route_name}",
+      filter_pattern: filter_pattern,
+      metric_transformations: [
+        {
+          metric_name: "#{RoutesAlerts::Metrics::SUCCESS_METRIC_NAME}-#{route_name}",
+          metric_namespace: namespace,
+          metric_value: "1",
+          default_value: 0,
+          unit: "Percent",
+        },
+      ]
+    }
+  end
+
+  def alarm_params
+    {
+      alarm_name: "Alarm-#{RoutesAlerts::Metrics::SUCCESS_METRIC_NAME}-#{route_name}",
+      actions_enabled: !!actions&.any?,
+      ok_actions: actions,
+      alarm_actions: actions,
+      metric_name: "#{RoutesAlerts::Metrics::SUCCESS_METRIC_NAME}-#{route_name}",
+      namespace: namespace,
+      statistic: "Average",
+      dimensions: [],
+      period: route_info.alarm_period,
+      unit: "Percent",
+      evaluation_periods: route_info.number_of_datapoints,
+      datapoints_to_alarm: route_info.number_of_datapoints,
+      threshold: route_info.success_rate,
+      comparison_operator: "LessThanThreshold",
+      treat_missing_data: "breaching",
+    }
+  end
+end

data/lib/routes_alerts/metrics.rb

@@ -0,0 +1,37 @@
+require_relative "./metrics/base.rb"
+require_relative "./metrics/count.rb"
+require_relative "./metrics/duration.rb"
+require_relative "./metrics/success_rate.rb"
+
+class RoutesAlerts::Metrics
+  COUNT_METRIC_NAME = "Count"
+  DURATION_METRIC_NAME = "Duration"
+  SUCCESS_METRIC_NAME = "SuccessRate"
+
+  DEFAULT_METRICS = [
+    COUNT_METRIC_NAME,
+    DURATION_METRIC_NAME,
+    SUCCESS_METRIC_NAME
+  ]
+
+  attr_reader :config
+
+  def initialize(config)
+    @config = config
+  end
+
+  def create_metrics!(route_info)
+    route_info.metrics.each do |metric|
+      case metric
+      when COUNT_METRIC_NAME
+        RoutesAlerts::Count.new(config, route_info).create!
+      when DURATION_METRIC_NAME
+        RoutesAlerts::Duration.new(config, route_info).create!
+      when SUCCESS_METRIC_NAME
+        RoutesAlerts::SuccessRate.new(config, route_info).create!
+      else
+        raise "Unknown metric type: #{metric}"
+      end
+    end
+  end
+end

data/lib/routes_alerts/route_info.rb

@@ -0,0 +1,20 @@
+
+class RoutesAlerts::RouteInfo
+  attr_reader :path, :method, :max_duration, :min_count, :success_rate, 
+              :alarm_period, :number_of_datapoints, :metrics, :namespace, 
+              :log_group_name, :actions
+
+  def initialize(path:, method:, max_duration:, min_count:, success_rate:, alarm_period:, number_of_datapoints:, metrics:, namespace:, log_group_name:, actions:)
+    @path = path.to_s
+    @method = method.to_s.upcase
+    @max_duration = max_duration.to_f
+    @min_count = min_count.to_i
+    @success_rate = success_rate.to_f
+    @alarm_period = alarm_period.to_i
+    @number_of_datapoints = number_of_datapoints.to_i
+    @metrics = metrics
+    @namespace = namespace.to_s
+    @log_group_name = log_group_name.to_s
+    @actions = actions || []
+  end
+end

data/lib/routes_alerts.rb

@@ -0,0 +1,19 @@
+module RoutesAlerts
+  require_relative "./routes_alerts/configuration.rb"
+  require_relative "./routes_alerts/metrics.rb"
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= RoutesAlerts::Configuration.new
+    yield(configuration)
+  end
+
+  def self.create_metrics!
+    configuration.routes.each do |route|
+      RoutesAlerts::Metrics.new(configuration).create_metrics!(route)
+    end
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: routes_alerts
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ''
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Allows you to create metrics (for reporting, dashboards) and alerts for
+  request time, count and response code based on your routes.
+email: jarrett.baugh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/routes_alerts.rb
+- lib/routes_alerts/configuration.rb
+- lib/routes_alerts/metrics.rb
+- lib/routes_alerts/metrics/base.rb
+- lib/routes_alerts/metrics/count.rb
+- lib/routes_alerts/metrics/duration.rb
+- lib/routes_alerts/metrics/success_rate.rb
+- lib/routes_alerts/route_info.rb
+homepage: https://rubygems.org/gems/routes_alerts
+licenses:
+- MIT
+metadata: {}
+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.6.7
+specification_version: 4
+summary: Create AWS alerts/metrics for routes
+test_files: []