dogapi 1.39.0 → 1.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 220b05feea1448dc86ed0be4b9efdc730ff56d561965d9e004de6c6c2daf8091
-  data.tar.gz: 2d161a3452ad1e7fe0e4d0039bf10866f10fd868ac008fe6d0b17485395289fb
+  metadata.gz: c64317943c656727e705f3ba310961de9fa8b3fda8fbcb976095d634d7311ecd
+  data.tar.gz: bb3f1977f9bd6bcd6d22779e23e247803b7800a1a0770e266d461878b68d574c
 SHA512:
-  metadata.gz: 5c835303762440f2e6293d308dfd7cc19585194572960fd4244e8ac84035733d5fa47622b28b74b61ca5356a0f87aeba97385ee6dd3108b4a24f0c307fc5761b
-  data.tar.gz: b4ae214e6f20ae634e32492c87dd9c50010d0c9ef8e4635a1cd9e76ebef75992bc215e096673ad01052ea00a770b25e95e85ce8a4bd0ddfdb94f690738f1c6ce
+  metadata.gz: f2814b96964abfc35ade6827652aed52c0b2795aa71f47a4a8a9152d7f97a013bb18680060657df015aeb0cb925cce58a16780c67df56397256d9e4c10aa8fcc
+  data.tar.gz: f9b7cb7ec7486d40af67d12ad68e44787e3e890efb0a98a9a5093875eba00eb0c19556a6b4fd35246611ffdc4cfe3b1aa2750750d001f6e145a8fe52085aac46

data/.azure-pipelines/all.yml

@@ -9,10 +9,36 @@ pr:
     include:
     - master
 
+resources:
+  containers:
+  - container: datadog-agent
+    image: datadog/agent:7
+    options: --health-cmd="exit 0" --health-interval=1s
+    ports:
+    - 8125:8125
+    - 8126:8126/tcp
+    env:
+      DD_API_KEY: $(ddAPIKey)
+      DD_APM_ENABLED: "true"
+      DD_APM_NON_LOCAL_TRAFFIC: "true"
+      DD_LOGS_ENABLED: "true"
+      DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL: "true"
+      DD_AC_EXCLUDE: "name:datadog-agent"
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+      - /proc/:/host/proc/:ro
+      - /sys/fs/cgroup/:/host/sys/fs/cgroup:ro
+
 jobs:
 - job: UnitTests
   pool:
     vmImage: "Ubuntu-16.04"
+  container:
+    image: ruby:$(RUBY_VERSION)
+    options: >-
+      -l com.datadoghq.ad.logs="[{\"source\": \"Azure Pipeline\", \"service\": \"dogapi-rb\"}]"
+  services:
+    datadog-agent: datadog-agent
   strategy:
     matrix:
       Rb24:
@@ -31,17 +57,19 @@ jobs:
         RUBY_VERSION: '2.6'
         TASK: rubocop
   steps:
-    - task: UseRubyVersion@0
-      displayName: Use Ruby $(RUBY_VERSION)
-      inputs:
-        versionSpec: $(RUBY_VERSION)
-        addToPath: true
-    - script: |
-        gem install bundler
-        bundle install --retry=3 --jobs=4
+    - script: bundle install --retry=3 --jobs=4
       displayName: 'bundle install'
+      env:
+        GEM_HOME: '~/.gem'
     - script: bundle exec rake $(TASK)
       displayName: Run $(TASK) via bundle
+      env:
+        GEM_HOME: '~/.gem'
+        DD_AGENT_HOST: datadog-agent
+        DD_ENV: ci
+        DD_SERVICE: dogapi-rb
+        DD_TAGS: "team:integration-tools-and-libraries,runtime:ruby-$(RUBY_VERSION),ci.job.name:$(System.JobName),matrix:$(TASK)"
+        DD_TRACE_ANALYTICS_ENABLED: "true"
 - job: TestRuby19
   pool:
     vmImage: "Ubuntu-16.04"

data/.rubocop.yml

@@ -14,4 +14,8 @@ Metrics/LineLength:
 Metrics/ModuleLength:
   Max: 200
 
+# Our Client constructor has 8 arguments
+Metrics/ParameterLists:
+  Enabled: false
+
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -520,3 +520,6 @@ Style/YodaCondition:
 Style/ZeroLengthPredicate:
   Exclude:
     - 'lib/capistrano/datadog.rb'
+
+Style/SymbolArray:
+  EnforcedStyle: brackets # Since ruby1.9 is supported

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changes
 
+## 1.44.0 / 2020-12-10
+
+* [Added] Allow skipping SSL verification. See [#246](https://github.com/DataDog/dogapi-rb/pull/246).
+
+## 1.43.0 / 2020-12-07
+
+* [Fixed] find_localhost: Try both `hostname` and `hostname -f` before raising. See [#242](https://github.com/DataDog/dogapi-rb/pull/242).
+
+## 1.42.0 / 2020-09-17
+
+* [Added] Allow dashboard creation / updates using Template Variable Presets. See [#238](https://github.com/DataDog/dogapi-rb/pull/238).
+
+## 1.41.0 / 2020-07-27
+
+* [Added] Improve user-agent header to include telemetry information. See [#235](https://github.com/DataDog/dogapi-rb/pull/235).
+* [Added] Move setting hostname to end of method body in order to actually return it. See [#233](https://github.com/DataDog/dogapi-rb/pull/233).
+
+## 1.40.0 / 2020-04-06
+
+* [Added] Re-add service level objectives support. See [#224](https://github.com/DataDog/dogapi-rb/pull/224).
+
 ## 1.39.0 / 2020-02-04
 
 * [Added] Allow Setting Proxy without Using HTTP_PROXY, etc.. See [#180](https://github.com/DataDog/dogapi-rb/pull/180). Thanks [KingAlex42](https://github.com/KingAlex42).

data/Gemfile

@@ -3,8 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'ddtrace', git: 'https://github.com/datadog/dd-trace-rb'
   gem 'rubocop', "~> 0.49.0"
-  gem 'rake', '>= 2.4.2'
   gem 'rspec'
   gem 'simplecov'
   gem 'webmock'

data/Gemfile_1.9

@@ -4,7 +4,6 @@ gemspec
 
 group :test do
   gem 'rubocop', "~> 0.41.0"
-  gem 'rake', '>= 2.4.2'
   gem 'rspec'
   gem 'simplecov', "~> 0.11.2"
   gem 'webmock'

data/README.rdoc

@@ -154,6 +154,13 @@ data point you will need to pass a list of +Time+, +float+ pairs, instead of a s
 
     dog.emit_points('some.metric.name', [[t1, val1], [t2, val2], [t3, val3]], :host => "my_host", :device => "my_device")
 
+If you want to specify the metric type, using the example above you can pass in a symbol key with :type and a value of a metric type such as counter, gauge or rate. 
+
+    dog.emit_points('some.metric.name', [[t1, val1], [t2, val2], [t3, val3]], :host => "my_host", :device => "my_device", :type => 'counter' )
+
+If you want to add metric tags, using the example above you can pass in a symbol key with :tags and an array of tags.
+
+    dog.emit_points('some.metric.name', [[t1, val1], [t2, val2], [t3, val3]], :host => "my_host", :device => "my_device", :tags => ['frontend', 'app:webserver'] )
 
 == Get points from a Datadog metric
 

data/RELEASING.md

@@ -43,4 +43,4 @@ Install [bundler](https://bundler.io/) and setup your RubyGems credentials:
 1. Build the gem: `bundle exec gem build dogapi.gemspec`.
 1. Push the gem: `bundle exec gem push dogapi-x.x.x.gem`.
 1. Check that the [Ruby Gem is published](https://rubygems.org/gems/dogapi).
-1. Bump the version again in `lib/dogapi/version.rb` to a dev version (e.g. `1.39.0` -> `1.40.0.dev`), open a PR and merge it to master.
+1. Bump the version again in `lib/dogapi/version.rb` to a dev version (e.g. `1.42.0` -> `1.42.1.dev`), open a PR and merge it to master.

data/dogapi.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'multi_json'
 
   spec.add_development_dependency 'bundler', '>= 1.3'
+  # NOTE: rake < 12.3.3 is vulnerable to CVE-2020-8130, but we only use it as a test dependency
+  # and neither our users nor our CI is vulnerable in any way
   spec.add_development_dependency 'rake', '~> 10'
   spec.add_development_dependency 'rdoc'
 end

data/lib/dogapi/common.rb

@@ -4,6 +4,7 @@
 
 require 'cgi'
 require 'net/https'
+require 'rbconfig'
 require 'socket'
 require 'uri'
 require 'English'
@@ -13,7 +14,16 @@ require 'multi_json'
 require 'set'
 require 'open3'
 
+require 'dogapi/version'
+
 module Dogapi
+  USER_AGENT = format(
+    'dogapi-rb/%<version>s (ruby %<ruver>s; os %<os>s; arch %<arch>s)',
+    version: VERSION,
+    ruver: RUBY_VERSION,
+    os: RbConfig::CONFIG['host_os'].downcase,
+    arch: RbConfig::CONFIG['host_cpu']
+  )
 
   # Metadata class to hold the scope of an API call
   class Scope
@@ -76,11 +86,12 @@ module Dogapi
   # Superclass that deals with the details of communicating with the DataDog API
   class APIService
     attr_reader :api_key, :application_key
-    def initialize(api_key, application_key, silent=true, timeout=nil, endpoint=nil)
+    def initialize(api_key, application_key, silent=true, timeout=nil, endpoint=nil, skip_ssl_validation=false)
       @api_key = api_key
       @application_key = application_key
       @api_host = endpoint || Dogapi.find_datadog_host()
       @silent = silent
+      @skip_ssl_validation = skip_ssl_validation
       @timeout = timeout || 5
     end
 
@@ -100,6 +111,9 @@ module Dogapi
       session = connection.new(uri.host, uri.port)
       session.open_timeout = @timeout
       session.use_ssl = uri.scheme == 'https'
+      if @skip_ssl_validation
+        session.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
       session.start do |conn|
         conn.read_timeout = @timeout
         yield conn
@@ -138,11 +152,11 @@ module Dogapi
     def prepare_request(method, url, params, body, send_json, with_app_key)
       url_with_params = url + params
       req = method.new(url_with_params)
+      req['User-Agent'] = USER_AGENT
       unless should_set_api_and_app_keys_in_params?(url)
         req['DD-API-KEY'] = @api_key
         req['DD-APPLICATION-KEY'] = @application_key if with_app_key
       end
-
       if send_json
         req.content_type = 'application/json'
         req.body = MultiJson.dump(body)
@@ -200,14 +214,17 @@ module Dogapi
   @@hostname = nil
 
   def Dogapi.find_localhost
-    unless @@hostname
-      out, status = Open3.capture2('hostname', '-f', err: File::NULL)
-      @@hostname = out.strip
-      # Get status to check if the call was successful
-      raise SystemCallError, 'Could not get hostname with `hostname -f`' unless status.exitstatus.zero?
-    end
-  rescue SystemCallError
-    @@hostname = Addrinfo.getaddrinfo(Socket.gethostname, nil, nil, nil, nil, Socket::AI_CANONNAME).first.canonname
+    return @@hostname if @@hostname
+    out, status = Open3.capture2('hostname', '-f', err: File::NULL)
+    unless status.exitstatus.zero?
+      begin
+        out = Addrinfo.getaddrinfo(Socket.gethostname, nil, nil, nil, nil, Socket::AI_CANONNAME).first.canonname
+      rescue SocketError
+        out, status = Open3.capture2('hostname', err: File::NULL)
+        raise SystemCallError, 'Both `hostname` and `hostname -f` failed.' unless status.exitstatus.zero?
+      end
+    end
+    @@hostname = out.strip
   end
 
   def Dogapi.find_proxy
@@ -224,4 +241,14 @@ module Dogapi
       raise ArgumentError, "Each tag needs to be a string. Current value: #{tag}" unless tag.is_a? String
     end
   end
+
+  # Very simplified hash with indifferent access - access to string or symbol
+  # keys via symbols. E.g.:
+  # my_hash = { 'foo' => 1 }
+  # Dogapi.symbolized_access(my_hash)
+  # my_hash[:foo] # => 1
+  def Dogapi.symbolized_access(hash)
+    hash.default_proc = proc { |h, k| h.key?(k.to_s) ? h[k.to_s] : nil }
+    hash
+  end
 end

data/lib/dogapi/facade.rb

@@ -13,7 +13,8 @@ module Dogapi
   # See Dogapi::V2  for the thick underlying clients
   class ClientV2
     attr_accessor :datadog_host
-    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil, endpoint=nil)
+    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true,
+                   timeout=nil, endpoint=nil, skip_ssl_validation=false)
 
       if api_key
         @api_key = api_key
@@ -27,7 +28,7 @@ module Dogapi
       @device = device
 
       @dashboard_list_service_v2 = Dogapi::V2::DashboardListService.new(
-        @api_key, @application_key, silent, timeout, @datadog_host
+        @api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation
       )
 
     end
@@ -64,7 +65,7 @@ module Dogapi
     # Support for API version 2.
 
     # rubocop:disable Metrics/MethodLength, Metrics/LineLength
-    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil, endpoint=nil)
+    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil, endpoint=nil, skip_ssl_validation=false)
 
       if api_key
         @api_key = api_key
@@ -78,35 +79,38 @@ module Dogapi
       @device = device
 
       # FIXME: refactor to avoid all this code duplication
-      @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @event_svc = Dogapi::V1::EventService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @tag_svc = Dogapi::V1::TagService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @comment_svc = Dogapi::V1::CommentService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @search_svc = Dogapi::V1::SearchService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @dash_service = Dogapi::V1::DashService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @dashboard_service = Dogapi::V1::DashboardService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @event_svc = Dogapi::V1::EventService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @tag_svc = Dogapi::V1::TagService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @comment_svc = Dogapi::V1::CommentService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @search_svc = Dogapi::V1::SearchService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @dash_service = Dogapi::V1::DashService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @dashboard_service = Dogapi::V1::DashboardService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
       @dashboard_list_service = Dogapi::V1::DashboardListService.new(
-        @api_key, @application_key, silent, timeout, @datadog_host
+        @api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation
       )
-      @alert_svc = Dogapi::V1::AlertService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @user_svc = Dogapi::V1::UserService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @snapshot_svc = Dogapi::V1::SnapshotService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @embed_svc = Dogapi::V1::EmbedService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @screenboard_svc = Dogapi::V1::ScreenboardService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @monitor_svc = Dogapi::V1::MonitorService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @synthetics_svc = Dogapi::V1::SyntheticsService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @service_check_svc = Dogapi::V1::ServiceCheckService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @metadata_svc = Dogapi::V1::MetadataService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @alert_svc = Dogapi::V1::AlertService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @user_svc = Dogapi::V1::UserService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @snapshot_svc = Dogapi::V1::SnapshotService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @embed_svc = Dogapi::V1::EmbedService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @screenboard_svc = Dogapi::V1::ScreenboardService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @monitor_svc = Dogapi::V1::MonitorService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @synthetics_svc = Dogapi::V1::SyntheticsService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @service_check_svc = Dogapi::V1::ServiceCheckService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @metadata_svc = Dogapi::V1::MetadataService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
       @legacy_event_svc = Dogapi::EventService.new(@datadog_host)
-      @hosts_svc = Dogapi::V1::HostsService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @integration_svc = Dogapi::V1::IntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @aws_integration_svc = Dogapi::V1::AwsIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @aws_logs_svc = Dogapi::V1::AwsLogsService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @usage_svc = Dogapi::V1::UsageService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @azure_integration_svc = Dogapi::V1::AzureIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @gcp_integration_svc = Dogapi::V1::GcpIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @hosts_svc = Dogapi::V1::HostsService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @integration_svc = Dogapi::V1::IntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @aws_integration_svc = Dogapi::V1::AwsIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @aws_logs_svc = Dogapi::V1::AwsLogsService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @usage_svc = Dogapi::V1::UsageService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @azure_integration_svc = Dogapi::V1::AzureIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @gcp_integration_svc = Dogapi::V1::GcpIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @service_level_objective_svc = Dogapi::V1::ServiceLevelObjectiveService.new(@api_key, @application_key, silent,
+                                                                                  timeout, @datadog_host, skip_ssl_validation)
+
       # Support for Dashboard List API v2.
-      @v2 = Dogapi::ClientV2.new(@api_key, @application_key, true, true, @datadog_host)
+      @v2 = Dogapi::ClientV2.new(@api_key, @application_key, true, true, @datadog_host, skip_ssl_validation)
 
     end
     # rubocop:enable Metrics/MethodLength, Metrics/LineLength
@@ -673,6 +677,46 @@ module Dogapi
       @monitor_svc.unmute_host(hostname)
     end
 
+    #
+    # SERVICE LEVEL OBJECTIVES
+    #
+
+    def create_service_level_objective(type, slo_name, thresholds, options = {})
+      @service_level_objective_svc.create_service_level_objective(type, slo_name, thresholds, options)
+    end
+
+    def update_service_level_objective(slo_id, type, options = {})
+      @service_level_objective_svc.update_service_level_objective(slo_id, type, options)
+    end
+
+    def get_service_level_objective(slo_id)
+      @service_level_objective_svc.get_service_level_objective(slo_id)
+    end
+
+    def get_service_level_objective_history(slo_id, from_ts, to_ts)
+      @service_level_objective_svc.get_service_level_objective_history(slo_id, from_ts, to_ts)
+    end
+
+    def search_service_level_objective(slo_ids = nil, query = nil, offset = nil, limit = nil)
+      @service_level_objective_svc.search_service_level_objective(slo_ids, query, offset, limit)
+    end
+
+    def can_delete_service_level_objective(slo_ids)
+      @service_level_objective_svc.can_delete_service_level_objective(slo_ids)
+    end
+
+    def delete_service_level_objective(slo_id)
+      @service_level_objective_svc.delete_service_level_objective(slo_id)
+    end
+
+    def delete_many_service_level_objective(slo_ids)
+      @service_level_objective_svc.delete_many_service_level_objective(slo_ids)
+    end
+
+    def delete_timeframes_service_level_objective(ops)
+      @service_level_objective_svc.delete_timeframes_service_level_objective(ops)
+    end
+
     #
     # SERVICE CHECKS
     #

data/lib/dogapi/v1.rb

@@ -15,6 +15,7 @@ require 'dogapi/v1/monitor'
 require 'dogapi/v1/screenboard'
 require 'dogapi/v1/search'
 require 'dogapi/v1/service_check'
+require 'dogapi/v1/service_level_objective'
 require 'dogapi/v1/snapshot'
 require 'dogapi/v1/synthetics'
 require 'dogapi/v1/tag'

data/lib/dogapi/v1/dashboard.rb

@@ -28,6 +28,11 @@ module Dogapi
       #                           e.g. '["user1@domain.com", "user2@domain.com"]'
       # :template_variables    => JSON: List of template variables for this dashboard.
       #                           e.g. [{"name": "host", "prefix": "host", "default": "my-host"}]
+      # :template_variable_presets => JSON: List of template variables saved views
+      #                           e.g. {
+      #                                  "name": "my_template_variable_preset",
+      #                                  "template_variables": [{"name": "host", "prefix": "host", "default": "my-host"}]
+      #                                }
       def create_board(title, widgets, layout_type, options)
         # Required arguments
         body = {
@@ -40,6 +45,7 @@ module Dogapi
         body[:is_read_only] = options[:is_read_only] if options[:is_read_only]
         body[:notify_list] = options[:notify_list] if options[:notify_list]
         body[:template_variables] = options[:template_variables] if options[:template_variables]
+        body[:template_variable_presets] = options[:template_variable_presets] if options[:template_variable_presets]
 
         request(Net::HTTP::Post, "/api/#{API_VERSION}/#{RESOURCE_NAME}", nil, body, true)
       end
@@ -60,6 +66,11 @@ module Dogapi
       #                           e.g. '["user1@domain.com", "user2@domain.com"]'
       # :template_variables    => JSON: List of template variables for this dashboard.
       #                           e.g. [{"name": "host", "prefix": "host", "default": "my-host"}]
+      # :template_variable_presets => JSON: List of template variables saved views
+      #                           e.g. {
+      #                                  "name": "my_template_variable_preset",
+      #                                  "template_variables": [{"name": "host", "prefix": "host", "default": "my-host"}]
+      #                                }
       def update_board(dashboard_id, title, widgets, layout_type, options)
         # Required arguments
         body = {
@@ -72,6 +83,7 @@ module Dogapi
         body[:is_read_only] = options[:is_read_only] if options[:is_read_only]
         body[:notify_list] = options[:notify_list] if options[:notify_list]
         body[:template_variables] = options[:template_variables] if options[:template_variables]
+        body[:template_variable_presets] = options[:template_variable_presets] if options[:template_variable_presets]
 
         request(Net::HTTP::Put, "/api/#{API_VERSION}/#{RESOURCE_NAME}/#{dashboard_id}", nil, body, true)
       end

data/lib/dogapi/v1/service_level_objective.rb

@@ -0,0 +1,113 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    # Implements Service Level Objectives endpoints
+    class ServiceLevelObjectiveService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      def create_service_level_objective(type, slo_name, thresholds, options = {})
+        body = {
+          type: type,
+          name: slo_name,
+          thresholds: thresholds
+        }
+
+        symbolized_options = Dogapi.symbolized_access(options)
+        if type.to_s == 'metric'
+          body[:query] = {
+            numerator: symbolized_options[:numerator],
+            denominator: symbolized_options[:denominator]
+          }
+        else
+          body[:monitor_search] = symbolized_options[:monitor_search] if symbolized_options[:monitor_search]
+          body[:monitor_ids] = symbolized_options[:monitor_ids] if symbolized_options[:monitor_ids]
+          body[:groups] = symbolized_options[:groups] if symbolized_options[:groups]
+        end
+        body[:tags] = symbolized_options[:tags] if symbolized_options[:tags]
+        body[:description] = symbolized_options[:description] if symbolized_options[:description]
+
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/slo", nil, body, true)
+      end
+
+      def update_service_level_objective(slo_id, type, options = {})
+        body = {
+          type: type
+        }
+
+        symbolized_options = Dogapi.symbolized_access(options)
+        if type == 'metric'
+          if symbolized_options[:numerator] && symbolized_options[:denominator]
+            body[:query] = {
+              numerator: symbolized_options[:numerator],
+              denominator: symbolized_options[:denominator]
+            }
+          end
+        else
+          body[:monitor_search] = symbolized_options[:monitor_search] if symbolized_options[:monitor_search]
+          body[:monitor_ids] = symbolized_options[:monitor_ids] if symbolized_options[:monitor_ids]
+          body[:groups] = symbolized_options[:groups] if symbolized_options[:groups]
+        end
+        [:name, :thresholds, :tags, :description].each do |a|
+          body[a] = symbolized_options[a] if symbolized_options[a]
+        end
+
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/slo/#{slo_id}", nil, body, true)
+      end
+
+      def get_service_level_objective(slo_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/#{slo_id}", nil, nil, false)
+      end
+
+      def search_service_level_objective(slo_ids, query, offset, limit)
+        params = {}
+        params[:offset] = offset unless offset.nil?
+        params[:limit] = limit unless limit.nil?
+        if !slo_ids.nil?
+          params[:ids] = slo_ids.join(',')
+        else
+          params[:query] = query
+        end
+
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/", params, nil, false)
+      end
+
+      def delete_service_level_objective(slo_id)
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/slo/#{slo_id}", nil, nil, false)
+      end
+
+      def delete_many_service_level_objective(slo_ids)
+        body = {
+          ids: slo_ids
+        }
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/slo/", nil, body, true)
+      end
+
+      def delete_timeframes_service_level_objective(ops)
+        # ops is a hash of slo_id: [<timeframe>] to delete
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/slo/bulk_delete", nil, ops, true)
+      end
+
+      def get_service_level_objective_history(slo_id, from_ts, to_ts)
+        params = {
+          from_ts: from_ts,
+          to_ts: to_ts
+        }
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/#{slo_id}/history", params, nil, false)
+      end
+
+      def can_delete_service_level_objective(slo_ids)
+        params = {}
+        params[:ids] = if slo_ids.is_a? Array
+                         slo_ids.join(',')
+                       else
+                         slo_ids
+                       end
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/slo/can_delete", params, nil, false)
+      end
+
+    end
+  end
+end

data/lib/dogapi/version.rb

@@ -3,5 +3,5 @@
 # Copyright 2011-Present Datadog, Inc.
 
 module Dogapi
-  VERSION = '1.39.0'
+  VERSION = '1.44.0'
 end

data/spec/integration/dashboard_spec.rb

@@ -26,6 +26,15 @@ describe Dogapi::Client do
     'prefix' => 'host',
     'default' => 'my-host'
   }].freeze
+  TEMPLATE_VARIABLE_PRESETS = [{
+    'name' => 'preset1',
+    'template_variables' => [
+      {
+        'name' => 'host1',
+        'value' => 'my-host'
+      }
+    ]
+  }].freeze
 
   REQUIRED_ARGS = {
     title: TITLE,
@@ -37,7 +46,8 @@ describe Dogapi::Client do
     description: DESCRIPTION,
     is_read_only: IS_READ_ONLY,
     notify_list: NOTIFY_LIST,
-    template_variables: TEMPLATE_VARIABLES
+    template_variables: TEMPLATE_VARIABLES,
+    template_variable_presets: TEMPLATE_VARIABLE_PRESETS
   }
   DASHBOARD_ARGS = REQUIRED_ARGS.values + [OPTIONS]
   DASHBOARD_PAYLOAD = REQUIRED_ARGS.merge(OPTIONS)

data/spec/integration/service_level_objective_spec.rb

@@ -0,0 +1,73 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  SLO_ID = '42424242424242424242424242424242'.freeze
+  SLO_TYPE = 'metric'.freeze
+  SLO_NAME = 'test slo'.freeze
+  SLO_DESCRIPTION = 'test slo description'.freeze
+  SLO_QUERY_NUMERATOR = 'sum:test.metric.metric{type:good}.as_count()'.freeze
+  SLO_QUERY_DENOMINATOR = 'sum:test.metric.metric{*}.as_count()'.freeze
+  SLO_TAGS = ['type:test'].freeze
+  SLO_THRESHOLDS = [{ timeframe: '7d', target: 90 }, { timeframe: '30d', target: 95 }].freeze
+
+  describe '#create_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :create_service_level_objective, [SLO_TYPE, SLO_NAME, SLO_THRESHOLDS, {
+                      description: SLO_DESCRIPTION,
+                      tags: SLO_TAGS,
+                      numerator: SLO_QUERY_NUMERATOR,
+                      denominator: SLO_QUERY_DENOMINATOR
+                    }],
+                    :post, '/slo', 'type' => SLO_TYPE, 'name' => SLO_NAME, 'thresholds' => SLO_THRESHOLDS,
+                                   'query' => { numerator: SLO_QUERY_NUMERATOR, denominator: SLO_QUERY_DENOMINATOR },
+                                   'tags' => SLO_TAGS, 'description' => SLO_DESCRIPTION
+  end
+
+  describe '#update_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :update_service_level_objective, [SLO_ID, SLO_TYPE, { name: SLO_NAME }],
+                    :put, "/slo/#{SLO_ID}", 'type' => SLO_TYPE, 'name' => SLO_NAME
+  end
+
+  describe '#get_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :get_service_level_objective, [SLO_ID],
+                    :get, "/slo/#{SLO_ID}"
+  end
+
+  describe '#get_service_level_objective_history' do
+    it_behaves_like 'an api method with params',
+                    :get_service_level_objective_history, [SLO_ID],
+                    :get, "/slo/#{SLO_ID}/history", 'from_ts' => 0, 'to_ts' => 1_000_000
+  end
+
+  describe '#can_delete_service_level_objective' do
+    it_behaves_like 'an api method with params',
+                    :can_delete_service_level_objective, [],
+                    :get, '/slo/can_delete', 'ids' => [SLO_ID]
+  end
+
+  describe '#search_service_level_objective' do
+    it_behaves_like 'an api method with optional params',
+                    :search_service_level_objective, [[SLO_ID]],
+                    :get, '/slo/', 'ids' => SLO_ID
+  end
+
+  describe '#delete_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :delete_service_level_objective, [SLO_ID],
+                    :delete, "/slo/#{SLO_ID}"
+  end
+
+  describe '#delete_many_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :delete_many_service_level_objective, [[SLO_ID]],
+                    :delete, '/slo/', 'ids' => [SLO_ID]
+  end
+
+  describe '#delete_timeframes_service_level_objective' do
+    it_behaves_like 'an api method',
+                    :delete_timeframes_service_level_objective, [{ SLO_ID => ['7d'] }],
+                    :post, '/slo/bulk_delete', SLO_ID => ['7d']
+  end
+end

data/spec/spec_helper.rb

@@ -10,7 +10,19 @@ SimpleCov.start do
   add_filter 'spec'
 end
 
-WebMock.disable_net_connect!(allow_localhost: false)
+webmock_allow = []
+
+begin
+  require 'ddtrace'
+  Datadog.configure do |c|
+    c.use :rspec, service_name: 'dogapi-rb'
+  end
+  webmock_allow << "#{Datadog::Transport::HTTP.default_hostname}:#{Datadog::Transport::HTTP.default_port}"
+rescue LoadError
+  puts 'ddtrace gem not found'
+end
+
+WebMock.disable_net_connect!(allow_localhost: false, allow: webmock_allow)
 
 # include our code and methods
 require 'dogapi'

data/spec/unit/common_spec.rb

@@ -134,6 +134,15 @@ describe 'Common' do
         expect(req['DD-APPLICATION-KEY']).to eq service.application_key
       end
     end
+
+    it 'properly sets User-Agent header' do
+      service = Dogapi::APIService.new('api_key', 'app_key', true, nil, 'https://app.example.com')
+      params = service.prepare_params(nil, '/api/v1/validate', true)
+      req = service.prepare_request(Net::HTTP::Get, '/api/v1/validate', params, nil, false, true)
+
+      expect(req.key?('User-Agent')).to be true
+      expect(req['User-Agent']).to match(%r{dogapi-rb\/[^\s]+ \(ruby [^\s]+; os [^\s]+; arch [^\s]+\)})
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.39.0
+  version: 1.44.0
 platform: ruby
 authors:
 - Datadog, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -131,6 +131,7 @@ files:
 - lib/dogapi/v1/screenboard.rb
 - lib/dogapi/v1/search.rb
 - lib/dogapi/v1/service_check.rb
+- lib/dogapi/v1/service_level_objective.rb
 - lib/dogapi/v1/snapshot.rb
 - lib/dogapi/v1/synthetics.rb
 - lib/dogapi/v1/tag.rb
@@ -158,6 +159,7 @@ files:
 - spec/integration/screenboard_spec.rb
 - spec/integration/search_spec.rb
 - spec/integration/service_check_spec.rb
+- spec/integration/service_level_objective_spec.rb
 - spec/integration/snapshot_spec.rb
 - spec/integration/synthetics_spec.rb
 - spec/integration/tag_spec.rb
@@ -175,7 +177,7 @@ metadata:
   changelog_uri: https://github.com/DataDog/dogapi-rb/blob/master/CHANGELOG.md
   documentation_uri: https://docs.datadoghq.com/api/
   source_code_uri: https://github.com/DataDog/dogapi-rb
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - DogAPI -- Datadog Client
@@ -197,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby bindings for Datadog's API
 test_files:
@@ -220,6 +222,7 @@ test_files:
 - spec/integration/screenboard_spec.rb
 - spec/integration/search_spec.rb
 - spec/integration/service_check_spec.rb
+- spec/integration/service_level_objective_spec.rb
 - spec/integration/snapshot_spec.rb
 - spec/integration/synthetics_spec.rb
 - spec/integration/tag_spec.rb