datadog_backup 3.2.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e3e8528c064d05b09bd31080a7bcab7c77fcca8dde46949cf8c62a7702f2af1
-  data.tar.gz: 24c57007224fcf546b5a886e4b9f2a78f76b2a63fd2c64067ae2454192919848
+  metadata.gz: 48b1dae9a4913fddefcca2facdd992cec33d541de98f1cdb95db1435c908e0c8
+  data.tar.gz: ced45888346071657d3f7e43a123fcd30c70add2eefad3f59f60a80efcce502b
 SHA512:
-  metadata.gz: d5180a6ba1f92f5db842e88d337878eacd0bafe114fbbb8752153b85f7c47f682be3bdd529b694294cc5523fe4c94274a7ee78d15fc4798b327598fb7710303b
-  data.tar.gz: f4ccccd735136f06f92cc71f1df0176e5fa626fd36f5e60f4bc88ef93f9fcf31f8d840c523e1e70f08195faf8d32e8522fea3665e9b6f1efe280cf8b214331a9
+  metadata.gz: 3a48ffe5dcb9f78b2609b6e229f3a012fd5b0674280851dfc13385ab46ddacd387acb957089d57eb8f0095f90cb8ee0a3557a67bbf984eae5db896c37920e439
+  data.tar.gz: 6c7b23395d06767197a3a2ab7d5bb273a71ed15721da680a2f723f99551cd13b471d98035b5b1e6e5802dec4e798170b3c69e79e0b807959493922e8c5706f35

data/.github/workflows/rspec_and_release.yml

@@ -12,10 +12,10 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: [2.7, '3.0', '3.1']
+        ruby: ['3.0', '3.1', '3.2']
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -30,7 +30,7 @@ jobs:
     env:
       BUNDLE_DEPLOYMENT: true
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -40,7 +40,7 @@ jobs:
         zip -r datadog_backup.zip ./*
     - name: Semantic Release
       id: semantic
-      uses: cycjimmy/semantic-release-action@v3
+      uses: cycjimmy/semantic-release-action@v4
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_TOKEN }}

data/.github/workflows/validate-pr.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
     - name: Validate PR Title
-      uses: amannn/action-semantic-pull-request@v5.0.2
+      uses: amannn/action-semantic-pull-request@v5.4.0
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [4.0.0](https://github.com/scribd/datadog_backup/compare/v3.3.0...v4.0.0) (2024-04-30)
+
+
+### Bug Fixes
+
+* Deprecate Ruby 3.0 and Drop support for Ruby 2.7 ([#163](https://github.com/scribd/datadog_backup/issues/163)) ([3d81d65](https://github.com/scribd/datadog_backup/commit/3d81d652bfb35f06b61dfb679c4d9e0d3567efcb))
+
+
+### BREAKING CHANGES
+
+* ruby 2.7 is no longer supported. Please upgrade to ruby 3.0 or higher.
+
+# [3.3.0](https://github.com/scribd/datadog_backup/compare/v3.2.1...v3.3.0) (2023-08-17)
+
+
+### Features
+
+* backup SLOs ([#155](https://github.com/scribd/datadog_backup/issues/155)) ([6cca6e7](https://github.com/scribd/datadog_backup/commit/6cca6e7567895673e94c7de80022c821553698ee)), closes [#1](https://github.com/scribd/datadog_backup/issues/1)
+
 ## [3.2.1](https://github.com/scribd/datadog_backup/compare/v3.2.0...v3.2.1) (2023-02-11)
 
 

data/README.md

@@ -17,7 +17,7 @@ Additional features may be built out over time.
 v3 is a backwards incompatible change.
 
 - [ ] DATADOG_API_KEY and DATADOG_APP_KEY are no longer the environment variables used to authenticate to Datadog. Instead, set the environment variables DD_API_KEY and DD_APP_KEY.
-- [ ] ruby 2.6 is no longer supported. Please upgrade to ruby 2.7 or higher.
+- [ ] ruby 2.7 is no longer supported. Please upgrade to ruby 3.0 or higher.
 - [ ] The options `--ssh` and `--ssshh` are no longer supported. Instead, please use `--quiet` to supress logging. `--debug` remains supported.
 - [ ] The environment variable `DATADOG_HOST` is no longer supported. Instead, please use `DD_SITE_URL`.
 

data/bin/datadog_backup

@@ -48,6 +48,9 @@ def prereqs(defaults) # rubocop:disable Metrics/AbcSize
     opts.on('--dashboards-only') do
       result[:resources] = [DatadogBackup::Dashboards]
     end
+    opts.on('--slos-only') do
+      result[:resources] = [DatadogBackup::SLOs]
+    end
     opts.on('--synthetics-only') do
       result[:resources] = [DatadogBackup::Synthetics]
     end
@@ -83,7 +86,7 @@ defaults = {
   action: nil,
   backup_dir: File.join(ENV.fetch('PWD'), 'backup'),
   diff_format: :color,
-  resources: [DatadogBackup::Dashboards, DatadogBackup::Monitors, DatadogBackup::Synthetics],
+  resources: [DatadogBackup::Dashboards, DatadogBackup::Monitors, DatadogBackup::SLOs, DatadogBackup::Synthetics],
   output_format: :yaml,
   force_restore: false,
   disable_array_sort: false

data/datadog_backup.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.add_dependency 'amazing_print'
   spec.add_dependency 'concurrent-ruby'

data/example/.github/workflows/backup.yml

@@ -10,11 +10,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.7.1
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 3.1
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.1
+        ruby-version: 3.1
     - name: perform backup
       env:
         DD_API_KEY: ${{ secrets.DD_API_KEY }}
@@ -24,7 +24,7 @@ jobs:
           bundle install --jobs 4 --retry 3
           bundle exec datadog_backup backup
     - name: commit changes
-      uses: stefanzweifel/git-auto-commit-action@v4
+      uses: stefanzweifel/git-auto-commit-action@v5
       with:
         commit_message: "Changes as of run: ${{ github.run_id }}"
         file_pattern: backup/

data/lib/datadog_backup/deprecations.rb

@@ -4,7 +4,7 @@ module DatadogBackup
   # Notify the user if they are using deprecated features.
   module Deprecations
     def self.check
-      LOGGER.warn "ruby-#{RUBY_VERSION} is deprecated. Ruby 2.7 or higher will be required to use this gem after datadog_backup@v3" if RUBY_VERSION < '2.7'
+      LOGGER.warn "ruby-#{RUBY_VERSION} is deprecated. Ruby 3.1 or higher will be required to use this gem after datadog_backup@v3" if RUBY_VERSION < '3.1'
     end
   end
 end

data/lib/datadog_backup/resources.rb

@@ -16,7 +16,9 @@ module DatadogBackup
       max: 5,
       interval: 0.05,
       interval_randomness: 0.5,
-      backoff_factor: 2
+      backoff_factor: 2,
+      rate_limit_reset_header: 'x-ratelimit-reset',
+      exceptions: [Faraday::TooManyRequestsError] + Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS
     }.freeze
 
     def backup

data/lib/datadog_backup/slos.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module DatadogBackup
+  # SLO specific overrides for backup and restore.
+  class SLOs < Resources
+    def all
+      get_all
+    end
+
+    def backup
+      LOGGER.info("Starting diffs on #{::DatadogBackup::ThreadPool::TPOOL.max_length} threads")
+      futures = all.map do |slo|
+        Concurrent::Promises.future_on(::DatadogBackup::ThreadPool::TPOOL, slo) do |board|
+          id = board[id_keyname]
+          get_and_write_file(id)
+        end
+      end
+
+      watcher = ::DatadogBackup::ThreadPool.watcher
+      watcher.join if watcher.status
+
+      Concurrent::Promises.zip(*futures).value!
+    end
+
+    def get_by_id(id)
+      begin
+        slo = except(get(id))
+      rescue Faraday::ResourceNotFound => e
+        slo = {}
+      end
+      except(slo)
+    end
+
+    def initialize(options)
+      super(options)
+      @banlist = %w[modified_at url].freeze
+    end
+
+    # Return the Faraday body from a response with a 2xx status code, otherwise raise an error
+    def body_with_2xx(response)
+      unless response.status.to_s =~ /^2/
+        raise "#{caller_locations(1,
+                                  1)[0].label} failed with error #{response.status}"
+      end
+
+      response.body.fetch('data')
+    end
+
+    private
+
+    def api_version
+      'v1'
+    end
+
+    def api_resource_name
+      'slo'
+    end
+
+    def id_keyname
+      'id'
+    end
+  end
+end

data/lib/datadog_backup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatadogBackup
-  VERSION = '3.2.1'
+  VERSION = '4.0.0'
 end

data/lib/datadog_backup.rb

@@ -8,6 +8,7 @@ require_relative 'datadog_backup/cli'
 require_relative 'datadog_backup/resources'
 require_relative 'datadog_backup/dashboards'
 require_relative 'datadog_backup/monitors'
+require_relative 'datadog_backup/slos'
 require_relative 'datadog_backup/synthetics'
 require_relative 'datadog_backup/thread_pool'
 require_relative 'datadog_backup/version'

data/spec/datadog_backup/deprecations_spec.rb

@@ -12,7 +12,7 @@ describe DatadogBackup::Deprecations do
     allow(logger).to receive(:warn)
   end
 
-  %w[2.4.10 2.5.9 2.6.8].each do |ruby_version|
+  %w[2.5.9 2.6.8 2.7 3.0.4].each do |ruby_version|
     describe "#check#{ruby_version}" do
       it 'does warn' do
         stub_const('RUBY_VERSION', ruby_version)
@@ -22,7 +22,7 @@ describe DatadogBackup::Deprecations do
     end
   end
 
-  %w[2.7.4 3.0.4 3.1.2 3.2.0-preview1].each do |ruby_version|
+  %w[3.1.2 3.2.0-preview1].each do |ruby_version|
     describe "#check#{ruby_version}" do
       it 'does not warn' do
         stub_const('RUBY_VERSION', ruby_version)

data/spec/datadog_backup/slos_spec.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DatadogBackup::SLOs do
+  let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+  let(:api_client_double) { Faraday.new { |f| f.adapter :test, stubs } }
+  let(:tempdir) { Dir.mktmpdir }
+  let(:slos) do
+    slos = described_class.new(
+      action: 'backup',
+      backup_dir: tempdir,
+      output_format: :json,
+      resources: []
+    )
+    allow(slos).to receive(:api_service).and_return(api_client_double)
+    return slos
+  end
+  let(:fetched_slos) do
+    {
+      "data"=>[
+        {"id"=>"abc-123", "name"=>"CI Stability", "tags"=>["kind:availability", "team:my_team"], "monitor_tags"=>[], "thresholds"=>[{"timeframe"=>"7d", "target"=>98.0, "target_display"=>"98."}, {"timeframe"=>"30d", "target"=>98.0, "target_display"=>"98."}, {"timeframe"=>"90d", "target"=>98.0, "target_display"=>"98."}], "type"=>"metric", "type_id"=>1, "description"=>"something helpful", "timeframe"=>"30d", "target_threshold"=>98.0, "query"=>{"denominator"=>"sum:metric.ci_things{*}.as_count()", "numerator"=>"sum:metric.ci_things{*}.as_count()-sum:metric.ci_things{infra_failure}.as_count()"}, "creator"=>{"name"=>"Thelma Patterson", "handle"=>"thelma.patterson@example.com", "email"=>"thelma.patterson@example.com"}, "created_at"=>1571335531, "modified_at"=>1687844157},
+        {"id"=>"sbc-124", "name"=>"A Latency SLO", "tags"=>["team:my_team", "kind:latency"], "monitor_tags"=>[], "thresholds"=>[{"timeframe"=>"7d", "target"=>95.0, "target_display"=>"95."}, {"timeframe"=>"30d", "target"=>95.0, "target_display"=>"95."}, {"timeframe"=>"90d", "target"=>95.0, "target_display"=>"95."}], "type"=>"monitor", "type_id"=>0, "description"=>"", "timeframe"=>"30d", "target_threshold"=>95.0, "monitor_ids"=>[13158755], "creator"=>{"name"=>"Louise Montague", "handle"=>"louise.montague@example.com", "email"=>"louise.montague@example.com"}, "created_at"=>1573162531, "modified_at"=>1685819875}
+      ],
+      "errors"=>[],
+      "metadata"=>{"page"=>{"total_count"=>359, "total_filtered_count"=>359}}
+    }
+  end
+  let(:slo_abc_123) do
+    {
+      "id" => "abc-123",
+      "name" => "CI Stability",
+      "tags" => [
+        "kind:availability",
+        "team:my_team",
+      ],
+      "monitor_tags" => [],
+      "thresholds" => [
+        {
+          "timeframe" => "7d",
+          "target" => 98.0,
+          "target_display" => "98."
+        },
+        {
+          "timeframe" => "30d",
+          "target" => 98.0,
+          "target_display" => "98."
+        },
+        {
+          "timeframe" => "90d",
+          "target" => 98.0,
+          "target_display" => "98."
+        }
+      ],
+      "type" => "metric",
+      "type_id" => 1,
+      "description" => "something helpful",
+      "timeframe" => "30d",
+      "target_threshold" => 98.0,
+      "query" => {
+        "denominator" => "sum:metric.ci_things{*}.as_count()",
+        "numerator" => "sum:metric.ci_things{*}.as_count()-sum:metric.ci_things{infra_failure}.as_count()"
+      },
+      "creator" => {
+        "name" => "Thelma Patterson",
+        "handle" => "thelma.patterson@example.com",
+        "email" => "thelma.patterson@example.com"
+      },
+      "created_at" => 1571335531,
+      "modified_at" => 1687844157
+    }
+  end
+  let(:slo_sbc_124) do
+    {
+      "id" => "sbc-124",
+      "name" => "A Latency SLO",
+      "tags" => [
+        "kind:latency",
+        "team:my_team",
+      ],
+      "monitor_tags" => [],
+      "thresholds" => [
+        {
+          "timeframe" => "7d",
+          "target" => 98.0,
+          "target_display" => "98."
+        },
+        {
+          "timeframe" => "30d",
+          "target" => 98.0,
+          "target_display" => "98."
+        },
+        {
+          "timeframe" => "90d",
+          "target" => 98.0,
+          "target_display" => "98."
+        }
+      ],
+      "type" => "monitor",
+      "type_id"=>0,
+      "description"=>"",
+      "timeframe"=>"30d",
+      "target_threshold"=>95.0,
+      "monitor_ids"=>[ 13158755 ],
+      "creator"=>{
+        "name"=>"Louise Montague",
+        "handle"=>"louise.montague@example.com",
+        "email"=>"louise.montague@example.com"
+      },
+      "created_at"=>1573162531,
+      "modified_at"=>1685819875
+    }
+  end
+  let(:slo_abc_123_response) do
+    { "data" => slo_abc_123, "errors" => [] }
+  end
+  let(:slo_sbc_124_response) do
+    { "data" => slo_sbc_124, "errors" => [] }
+  end
+  let(:all_slos) { respond_with200(fetched_slos) }
+  let(:example_slo1) { respond_with200(slo_abc_123_response) }
+  let(:example_slo2) { respond_with200(slo_sbc_124_response) }
+
+  before do
+    stubs.get('/api/v1/slo') { all_slos }
+    stubs.get('/api/v1/slo/abc-123') { example_slo1 }
+    stubs.get('/api/v1/slo/sbc-124') { example_slo2 }
+  end
+
+  describe '#backup' do
+    subject { slos.backup }
+
+    it 'is expected to create two files' do
+      file1 = instance_double(File)
+      allow(File).to receive(:open).with(slos.filename('abc-123'), 'w').and_return(file1)
+      allow(file1).to receive(:write)
+      allow(file1).to receive(:close)
+
+      file2 = instance_double(File)
+      allow(File).to receive(:open).with(slos.filename('sbc-124'), 'w').and_return(file2)
+      allow(file2).to receive(:write)
+      allow(file2).to receive(:close)
+
+      slos.backup
+      expect(file1).to have_received(:write).with(::JSON.pretty_generate(slo_abc_123.deep_sort))
+      expect(file2).to have_received(:write).with(::JSON.pretty_generate(slo_sbc_124.deep_sort))
+    end
+  end
+
+  describe '#filename' do
+    subject { slos.filename('abc-123') }
+
+    it { is_expected.to eq("#{tempdir}/slos/abc-123.json") }
+  end
+
+  describe '#get_by_id' do
+    subject { slos.get_by_id('abc-123') }
+
+    it { is_expected.to eq slo_abc_123 }
+  end
+
+  describe '#diff' do
+    it 'calls the api only once' do
+      slos.write_file('{"a":"b"}', slos.filename('abc-123'))
+      expect(slos.diff('abc-123')).to eq(<<~EODASH
+         ---
+        -created_at: 1571335531
+        -creator:
+        -  email: thelma.patterson@example.com
+        -  handle: thelma.patterson@example.com
+        -  name: Thelma Patterson
+        -description: something helpful
+        -id: abc-123
+        -monitor_tags: []
+        -name: CI Stability
+        -query:
+        -  denominator: sum:metric.ci_things{*}.as_count()
+        -  numerator: sum:metric.ci_things{*}.as_count()-sum:metric.ci_things{infra_failure}.as_count()
+        -tags:
+        -- kind:availability
+        -- team:my_team
+        -target_threshold: 98.0
+        -thresholds:
+        -- target: 98.0
+        -  target_display: '98.'
+        -  timeframe: 30d
+        -- target: 98.0
+        -  target_display: '98.'
+        -  timeframe: 7d
+        -- target: 98.0
+        -  target_display: '98.'
+        -  timeframe: 90d
+        -timeframe: 30d
+        -type: metric
+        -type_id: 1
+        +a: b
+      EODASH
+      .chomp)
+    end
+  end
+
+  describe '#except' do
+    subject { slos.except({ :a => :b, 'modified_at' => :c, 'url' => :d }) }
+
+    it { is_expected.to eq({ a: :b }) }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datadog_backup
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Kamran Farhadi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -229,6 +229,7 @@ files:
 - lib/datadog_backup/monitors.rb
 - lib/datadog_backup/options.rb
 - lib/datadog_backup/resources.rb
+- lib/datadog_backup/slos.rb
 - lib/datadog_backup/synthetics.rb
 - lib/datadog_backup/thread_pool.rb
 - lib/datadog_backup/version.rb
@@ -239,6 +240,7 @@ files:
 - spec/datadog_backup/deprecations_spec.rb
 - spec/datadog_backup/local_filesystem_spec.rb
 - spec/datadog_backup/monitors_spec.rb
+- spec/datadog_backup/slos_spec.rb
 - spec/datadog_backup/synthetics_spec.rb
 - spec/datadog_backup_bin_spec.rb
 - spec/spec_helper.rb
@@ -255,7 +257,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="