dogapi 1.37.0 → 1.41.0

data/lib/dogapi.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'dogapi/common'
 require 'dogapi/facade'
 require 'dogapi/event'

data/lib/dogapi/common.rb

@@ -1,5 +1,10 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'cgi'
 require 'net/https'
+require 'rbconfig'
 require 'socket'
 require 'uri'
 require 'English'
@@ -7,8 +12,18 @@ require 'English'
 require 'rubygems'
 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
@@ -83,13 +98,12 @@ module Dogapi
     def connect
       connection = Net::HTTP
 
-      # After ruby 2.0 Net::HTTP looks for the env variable but not ruby 1.9
-      if RUBY_VERSION < '2.0.0'
-        proxy = ENV['HTTPS_PROXY'] || ENV['https_proxy'] || ENV['HTTP_PROXY'] || ENV['http_proxy']
-        if proxy
-          proxy_uri = URI.parse(proxy)
-          connection = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
-        end
+      # Expose using a proxy without setting the HTTPS_PROXY or HTTP_PROXY variables
+      proxy = Dogapi.find_proxy()
+
+      if proxy
+        proxy_uri = URI.parse(proxy)
+        connection = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
       end
 
       uri = URI.parse(@api_host)
@@ -118,17 +132,12 @@ module Dogapi
       resp = nil
       connect do |conn|
         begin
-          current_url = url + prepare_params(extra_params, url, with_app_key)
-          req = method.new(current_url)
-          req['DD-API-KEY'] = @api_key
-          req['DD-APPLICATION-KEY'] = @application_key if with_app_key
-
-          if send_json
-            req.content_type = 'application/json'
-            req.body = MultiJson.dump(body)
-          end
-
+          params = prepare_params(extra_params, url, with_app_key)
+          req = prepare_request(method, url, params, body, send_json, with_app_key)
           resp = conn.request(req)
+          if resp.code.to_i / 100 == 3
+            resp = handle_redirect(conn, req, resp)
+          end
           return handle_response(resp)
         rescue Exception => e
           suppress_error_if_silent e
@@ -136,29 +145,37 @@ module Dogapi
       end
     end
 
-    def prepare_params(extra_params, url, with_app_key)
-      params = set_api_and_app_keys_in_params(url, with_app_key)
-      params = extra_params.merge params unless extra_params.nil?
-      qs_params = params.map { |k, v| CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s) }
-      qs = '?' + qs_params.join('&')
-      qs
+    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)
+      end
+      return req
     end
 
-    def set_api_and_app_keys_in_params(url, with_app_key)
-      set_of_urls = Set.new ['/api/v1/series',
-                             '/api/v1/check_run',
-                             '/api/v1/events',
-                             '/api/v1/screen']
-
-      include_in_params = set_of_urls.include?(url)
-
-      if include_in_params
+    def prepare_params(extra_params, url, with_app_key)
+      if should_set_api_and_app_keys_in_params?(url)
         params = { api_key: @api_key }
         params[:application_key] = @application_key if with_app_key
       else
         params = {}
       end
-      return params
+      params = extra_params.merge params unless extra_params.nil?
+      qs_params = params.map { |k, v| CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s) }
+      qs = '?' + qs_params.join('&')
+      qs
+    end
+
+    def should_set_api_and_app_keys_in_params?(url)
+      set_of_urls = Set.new ['/api/v1/series', '/api/v1/check_run', '/api/v1/events', '/api/v1/screen']
+      return set_of_urls.include?(url)
     end
 
     def handle_response(resp)
@@ -173,6 +190,15 @@ module Dogapi
         raise 'Invalid JSON Response: ' + resp.body
       end
     end
+
+    def handle_redirect(conn, req, resp, retries=10)
+      req.uri = URI.parse(resp.header['location'])
+      new_response = conn.request(req)
+      if retries > 1 && new_response.code / 100 == 3
+        new_response = handle_redirect(conn, req, new_response, retries - 1)
+      end
+      new_response
+    end
   end
 
   def Dogapi.find_datadog_host
@@ -184,9 +210,38 @@ module Dogapi
   @@hostname = nil
 
   def Dogapi.find_localhost
-    @@hostname ||= %x[hostname -f].strip
+    unless @@hostname
+      out, status = Open3.capture2('hostname', '-f', err: File::NULL)
+      # Get status to check if the call was successful
+      raise SystemCallError, 'Could not get hostname with `hostname -f`' unless status.exitstatus.zero?
+      @@hostname = out.strip
+    end
   rescue SystemCallError
-    raise $ERROR_INFO unless $ERROR_INFO.class.name == 'Errno::ENOENT'
     @@hostname = Addrinfo.getaddrinfo(Socket.gethostname, nil, nil, nil, nil, Socket::AI_CANONNAME).first.canonname
   end
+
+  def Dogapi.find_proxy
+    ENV['DD_PROXY_HTTPS'] || ENV['dd_proxy_https'] ||
+      ENV['DD_PROXY_HTTP'] || ENV['dd_proxy_http'] ||
+      ENV['HTTPS_PROXY'] || ENV['https_proxy'] || ENV['HTTP_PROXY'] || ENV['http_proxy']
+  end
+
+  def Dogapi.validate_tags(tags)
+    unless tags.is_a? Array
+      raise ArgumentError, "The tags parameter needs to be an array of string. Current value: #{tags}"
+    end
+    tags.each do |tag|
+      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/event.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'net/http'
 
 require 'rubygems'

data/lib/dogapi/facade.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'time'
 require 'dogapi/v1'
 require 'dogapi/v2'
@@ -59,6 +63,7 @@ module Dogapi
     attr_accessor :v2
     # 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)
 
       if api_key
@@ -89,12 +94,17 @@ module Dogapi
       @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)
       @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)
       @service_level_objective_svc = Dogapi::V1::ServiceLevelObjectiveService.new(@api_key, @application_key, silent,
                                                                                   timeout, @datadog_host)
 
@@ -102,6 +112,7 @@ module Dogapi
       @v2 = Dogapi::ClientV2.new(@api_key, @application_key, true, true, @datadog_host)
 
     end
+    # rubocop:enable Metrics/MethodLength, Metrics/LineLength
 
     #
     # METRICS
@@ -114,7 +125,7 @@ module Dogapi
     #  :device    => String
     #  :options   => Map
     #
-    # options[:type] = "counter" to specify a counter metric
+    # options[:type] = "count" to specify a counter metric
     # options[:tags] = ["tag1", "tag2"] to tag the point
     def emit_point(metric, value, options= {})
       defaults = { :timestamp => Time.now }
@@ -136,7 +147,7 @@ module Dogapi
     #  :device => String
     #  :options   => Map
     #
-    # options[:type] = "counter" to specify a counter metric
+    # options[:type] = "count" to specify a counter metric
     # options[:tags] = ["tag1", "tag2"] to tag the point
     def emit_points(metric, points, options= {})
       scope = override_scope options
@@ -313,13 +324,13 @@ module Dogapi
     #
 
     # Create a dashboard.
-    def create_dashboard(title, description, graphs, template_variables=nil)
-      @dash_service.create_dashboard(title, description, graphs, template_variables)
+    def create_dashboard(title, description, graphs, template_variables = nil, read_only = false)
+      @dash_service.create_dashboard(title, description, graphs, template_variables, read_only)
     end
 
     # Update a dashboard.
-    def update_dashboard(dash_id, title, description, graphs, template_variables=nil)
-      @dash_service.update_dashboard(dash_id, title, description, graphs, template_variables)
+    def update_dashboard(dash_id, title, description, graphs, template_variables = nil, read_only = false)
+      @dash_service.update_dashboard(dash_id, title, description, graphs, template_variables, read_only)
     end
 
     # Fetch the given dashboard.
@@ -522,6 +533,49 @@ module Dogapi
       @screenboard_svc.revoke_screenboard(board_id)
     end
 
+    #
+    # SYNTHETICS
+    #
+    def create_synthetics_test(type, config, options = {})
+      @synthetics_svc.create_synthetics_test(type, config, options)
+    end
+
+    def update_synthetics_test(test_id, type, config, options = {})
+      @synthetics_svc.update_synthetics_test(test_id, type, config, options)
+    end
+
+    def delete_synthetics_tests(test_ids)
+      @synthetics_svc.delete_synthetics_tests(test_ids)
+    end
+
+    def start_pause_synthetics_test(test_id, new_status)
+      @synthetics_svc.start_pause_synthetics_test(test_id, new_status)
+    end
+
+    def get_all_synthetics_tests
+      @synthetics_svc.get_all_synthetics_tests()
+    end
+
+    def get_synthetics_test(test_id)
+      @synthetics_svc.get_synthetics_test(test_id)
+    end
+
+    def get_synthetics_results(test_id)
+      @synthetics_svc.get_synthetics_results(test_id)
+    end
+
+    def get_synthetics_result(test_id, result_id)
+      @synthetics_svc.get_synthetics_result(test_id, result_id)
+    end
+
+    def get_synthetics_devices
+      @synthetics_svc.get_synthetics_devices()
+    end
+
+    def get_synthetics_locations
+      @synthetics_svc.get_synthetics_locations()
+    end
+
     #
     # MONITORS
     #
@@ -538,8 +592,12 @@ module Dogapi
       @monitor_svc.get_monitor(monitor_id, options)
     end
 
-    def delete_monitor(monitor_id)
-      @monitor_svc.delete_monitor(monitor_id)
+    def can_delete_monitors(monitor_ids)
+      @monitor_svc.can_delete_monitors(monitor_ids)
+    end
+
+    def delete_monitor(monitor_id, options = {})
+      @monitor_svc.delete_monitor(monitor_id, options)
     end
 
     def get_all_monitors(options= {})
@@ -590,8 +648,8 @@ module Dogapi
       @monitor_svc.update_downtime(downtime_id, options)
     end
 
-    def get_downtime(downtime_id)
-      @monitor_svc.get_downtime(downtime_id)
+    def get_downtime(downtime_id, options = {})
+      @monitor_svc.get_downtime(downtime_id, options)
     end
 
     def cancel_downtime(downtime_id)
@@ -622,23 +680,12 @@ module Dogapi
     # SERVICE LEVEL OBJECTIVES
     #
 
-    def create_service_level_objective(type: , name: , description: nil, tags: nil, thresholds: nil, numerator: nil,
-                                       denominator: nil, monitor_ids: nil, monitor_search: nil, groups: nil)
-      @service_level_objective_svc.create_service_level_objective(type: type, name: name, description: description,
-                                                                  tags: tags, thresholds: thresholds,
-                                                                  numerator: numerator, denominator: denominator,
-                                                                  monitor_ids: monitor_ids,
-                                                                  monitor_search: monitor_search, groups: groups)
+    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: , name: nil, description: nil, tags: nil, thresholds: nil,
-                                       numerator: nil, denominator: nil, monitor_ids: nil, monitor_search: nil,
-                                       groups: nil)
-      @service_level_objective_svc.update_service_level_objective(slo_id: slo_id, type: type, name: name,
-                                                                  description: description, tags: tags,
-                                                                  thresholds: thresholds, numerator: numerator,
-                                                                  denominator: denominator, monitor_ids: monitor_ids,
-                                                                  monitor_search: monitor_search, groups: groups)
+    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)
@@ -649,9 +696,8 @@ module Dogapi
       @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: slo_ids, query: query, offset: offset,
-                                                                  limit: limit)
+    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)
@@ -736,6 +782,108 @@ module Dogapi
       @integration_svc.delete_integration(source_type_name)
     end
 
+    #
+    # AWS INTEGRATION
+    #
+    def aws_integration_list
+      @aws_integration_svc.aws_integration_list
+    end
+
+    def aws_integration_create(config)
+      @aws_integration_svc.aws_integration_create(config)
+    end
+
+    def aws_integration_delete(config)
+      @aws_integration_svc.aws_integration_delete(config)
+    end
+
+    def aws_integration_list_namespaces
+      @aws_integration_svc.aws_integration_list_namespaces
+    end
+
+    def aws_integration_generate_external_id(config)
+      @aws_integration_svc.aws_integration_generate_external_id(config)
+    end
+
+    def aws_integration_update(config, new_config)
+      @aws_integration_svc.aws_integration_update(config, new_config)
+    end
+
+    #
+    # AWS Logs Integration
+    #
+
+    def aws_logs_add_lambda(config)
+      @aws_logs_svc.aws_logs_add_lambda(config)
+    end
+
+    def aws_logs_list_services
+      @aws_logs_svc.aws_logs_list_services
+    end
+
+    def aws_logs_save_services(config)
+      @aws_logs_svc.aws_logs_save_services(config)
+    end
+
+    def aws_logs_integrations_list
+      @aws_logs_svc.aws_logs_integrations_list
+    end
+
+    def aws_logs_integration_delete(config)
+      @aws_logs_svc.aws_logs_integration_delete(config)
+    end
+
+    def aws_logs_check_lambda(config)
+      @aws_logs_svc.aws_logs_check_lambda(config)
+    end
+
+    def aws_logs_check_services(config)
+      @aws_logs_svc.aws_logs_check_services(config)
+    end
+
+    #
+    # AZURE INTEGRATION
+    #
+
+    def azure_integration_list
+      @azure_integration_svc.azure_integration_list
+    end
+
+    def azure_integration_create(config)
+      @azure_integration_svc.azure_integration_create(config)
+    end
+
+    def azure_integration_delete(config)
+      @azure_integration_svc.azure_integration_delete(config)
+    end
+
+    def azure_integration_update_host_filters(config)
+      @azure_integration_svc.azure_integration_update_host_filters(config)
+    end
+
+    def azure_integration_update(config)
+      @azure_integration_svc.azure_integration_update(config)
+    end
+
+    #
+    # GCP INTEGRATION
+    #
+    def gcp_integration_list
+      @gcp_integration_svc.gcp_integration_list
+    end
+
+    def gcp_integration_delete(config)
+      @gcp_integration_svc.gcp_integration_delete(config)
+    end
+
+    def gcp_integration_create(config)
+      @gcp_integration_svc.gcp_integration_create(config)
+    end
+
+    def gcp_integration_update(config)
+      @gcp_integration_svc.gcp_integration_update(config)
+    end
+
     #
     # USAGE
     #