datadog-compound-metrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81e2cccbdfe1ede252799a12fb7b335f7bb69f8a62910788a4d31a3312230f82
+  data.tar.gz: dda6d1593b416f625f9f7b8e82ed63ea218060d37c01ba4ed24ff82b8c2ae99f
+SHA512:
+  metadata.gz: 91550f3fffc294d83900ca69f72daec85f6514dff04e522449d661f1d29949a73f0098a5729c4bff2a5c30120c19f98792a392bac52992415c922abb31ae22ae
+  data.tar.gz: ce5587f36b1a6d0bb0eb2215aaa512ab73dbf74c7e5326a7c144e7f651d4a87172cd8cc5217bb1b4078257575a645b3b7e2e2c61b1d3d1fa356c403174dd5518

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,132 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  Exclude:
+    - "db/**/*"
+    - "bin/**/*"
+    - "tmp/**/*"
+    - "log/**/*"
+    - "vendor/**/*"
+    - "spec/rails_helper.rb"
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ArrayAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/SpaceBeforeBrackets:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+
+Metrics/ParameterLists:
+  MaxOptionalParameters: 4
+
+RSpec/ExpectChange:
+  EnforcedStyle: block
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 20
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/CommandLiteral:
+  EnforcedStyle: percent_x
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/datadog-compound-metrics.rb'
+
+RSpec/ExampleLength:
+  Max: 15
+
+
+Metrics/MethodLength:
+  Max: 20
+
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/integration_spec.rb'
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Layout/LineLength:
+  Exclude:
+    - 'datadog-compound-metrics.gemspec'
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/spec_helper.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0]
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in datadog-compound-metrics.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "dogstatsd-ruby"
+gem "rspec", "~> 3.0"
+gem "rubocop", require: false
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "sidekiq", "~> 6.0"

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    datadog-compound-metrics (0.1.0)
+      activesupport (>= 5)
+      sidekiq (>= 5)
+      sidekiq-cron
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.0)
+    diff-lcs (1.5.0)
+    dogstatsd-ruby (5.5.0)
+    et-orbi (1.2.7)
+      tzinfo
+    fugit (1.8.1)
+      et-orbi (~> 1, >= 1.2.7)
+      raabro (~> 1.4)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.18.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    raabro (1.4.0)
+    rack (2.2.6.4)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (4.8.1)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.49.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    sidekiq (6.5.8)
+      connection_pool (>= 2.2.5, < 3)
+      rack (~> 2.0)
+      redis (>= 4.5.0, < 5)
+    sidekiq-cron (1.10.0)
+      fugit (~> 1.8)
+      globalid (>= 1.0.1)
+      sidekiq (>= 6)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  datadog-compound-metrics!
+  dogstatsd-ruby
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  sidekiq (~> 6.0)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Karol Galanciak
+
+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,56 @@
+# DatadogCompoundMetrics
+
+A gem for building compound metric (a single metric from multiple ones). Mostly to have a single metric do Horizontal Pod Autoscaling for workers consuming from multiple queues.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add datadog-compound-metrics
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install datadog-compound-metrics
+
+## Usage
+
+
+In the initializer:
+
+
+``` rb
+Rails.application.config.to_prepare do
+  DatadogCompoundMetrics.configure do |config|
+    config.datadog_statsd_client = Datadog::Statsd.new(ENV.fetch("DD_AGENT_HOST"), ENV.fetch("DATADOG_PORT"), namespace: "app_name.production", tags: ["host:disabled"]) # required
+    config.sidekiq_queue = :critical # required
+    config.sidekiq_cron_schedule = "*/10 * * * * *" # required, you can also use extended syntax covering seconds
+  end
+
+  DatadogCompoundMetrics.add_compound_metric("sidekiq.autoscaling.high_concurrency_worker") do |compound_metric|
+    compound_metric.add_calculation(-> { Sidekiq::Queue.new("queue_1").latency })
+    compound_metric.add_calculation(-> { Sidekiq::Queue.new("queue_2").latency })
+    # to have a single metric taking the maximum from these latencies:
+    compound_metric.calculation_strategy = :max # :min/:max, in the end it's going to be a method call on the Array
+  end
+
+  DatadogCompoundMetrics.schedule_job # add it to cron jobs
+end
+
+# remember also to tweak cron poll interval if you are planning to use extended syntax covering seconds and schedule jobs more often
+Sidekiq::Options[:cron_poll_interval] = 10
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BookingSync/datadog-compound-metrics.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/datadog-compound-metrics.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "datadog_compound_metrics"

data/lib/datadog_compound_metrics/compound_metric.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class DatadogCompoundMetrics
+  class CompoundMetric
+    attr_reader :name, :calculations
+    attr_accessor :calculation_strategy
+
+    def initialize(name)
+      @name = name
+      @calculations = []
+    end
+
+    def add_calculation(calculation)
+      calculations << calculation
+    end
+
+    def compute
+      calculations
+        .map(&:call)
+        .public_send(calculation_strategy)
+    end
+  end
+end

data/lib/datadog_compound_metrics/compound_metrics_worker.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class DatadogCompoundMetrics
+  class CompoundMetricsWorker
+    include Sidekiq::Worker
+
+    sidekiq_options queue: :default
+
+    delegate :configuration, :compound_metrics, to: DatadogCompoundMetrics
+    delegate :datadog_statsd_client, to: :configuration
+
+    def perform
+      compound_metrics.each do |metric|
+        datadog_statsd_client.gauge(metric.name.to_s, metric.compute)
+      end
+    end
+  end
+end

data/lib/datadog_compound_metrics/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class DatadogCompoundMetrics
+  class Configuration
+    attr_accessor :datadog_statsd_client, :sidekiq_queue, :sidekiq_cron_schedule
+  end
+end

data/lib/datadog_compound_metrics/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class DatadogCompoundMetrics
+  module Version
+  end
+  VERSION = "0.1.0"
+end

data/lib/datadog_compound_metrics.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+require "sidekiq"
+require "sidekiq-cron"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/datadog-compound-metrics.rb")
+loader.setup
+
+class DatadogCompoundMetrics
+  def self.loader
+    @loader ||= Zeitwerk::Loader.for_gem.tap do |loader|
+      loader.ignore("#{__dir__}/datadog-compound-metrics.rb")
+    end
+  end
+
+  def self.configuration
+    @configuration ||= DatadogCompoundMetrics::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.add_compound_metric(metric_name)
+    compound_metric = DatadogCompoundMetrics::CompoundMetric.new(metric_name)
+    yield compound_metric
+    compound_metrics << compound_metric
+  end
+
+  def self.compound_metrics
+    @compound_metrics ||= []
+  end
+
+  def self.schedule_job
+    Sidekiq::Cron::Job.create(
+      name: "DatadogCompoundMetrics::CompoundMetricsWorker",
+      cron: configuration.sidekiq_cron_schedule,
+      class: "DatadogCompoundMetrics::CompoundMetricsWorker",
+      queue: configuration.sidekiq_queue,
+      args: [],
+      active_job: false
+    )
+  end
+
+  def self.reset_config
+    @configuration = nil
+  end
+
+  def self.reset_metrics
+    @compound_metrics = []
+  end
+end
+
+DatadogCompoundMetrics.loader.setup

data/sig/datadog/compound/metrics.rbs

@@ -0,0 +1,8 @@
+module Datadog
+  module Compound
+    module Metrics
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: datadog-compound-metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol Galanciak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem for building compound metric (a single metric from multiple ones).
+  Mostly to have a single metric do Horizontal Pod Autoscaling for workers consuming
+  from multiple queues.
+email:
+- karol@bookingsync.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/datadog-compound-metrics.rb
+- lib/datadog_compound_metrics.rb
+- lib/datadog_compound_metrics/compound_metric.rb
+- lib/datadog_compound_metrics/compound_metrics_worker.rb
+- lib/datadog_compound_metrics/configuration.rb
+- lib/datadog_compound_metrics/version.rb
+- sig/datadog/compound/metrics.rbs
+homepage: https://github.com/BookingSync/datadog-compound-metrics
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/BookingSync/datadog-compound-metrics
+  source_code_uri: https://github.com/BookingSync/datadog-compound-metrics
+  changelog_uri: https://github.com/BookingSync/datadog-compound-metrics/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A gem for building compound metric (a single metric from multiple ones).
+test_files: []