dogapi 1.38.0 → 1.39.0

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'
@@ -90,6 +94,7 @@ 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)
@@ -117,7 +122,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 }
@@ -139,7 +144,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
@@ -316,13 +321,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.
@@ -525,6 +530,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
     #
@@ -545,8 +593,8 @@ module Dogapi
       @monitor_svc.can_delete_monitors(monitor_ids)
     end
 
-    def delete_monitor(monitor_id)
-      @monitor_svc.delete_monitor(monitor_id)
+    def delete_monitor(monitor_id, options = {})
+      @monitor_svc.delete_monitor(monitor_id, options)
     end
 
     def get_all_monitors(options= {})

data/lib/dogapi/metric.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/v1.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/v1/alert'
 require 'dogapi/v1/comment'
 require 'dogapi/v1/dash'
@@ -12,6 +16,7 @@ require 'dogapi/v1/screenboard'
 require 'dogapi/v1/search'
 require 'dogapi/v1/service_check'
 require 'dogapi/v1/snapshot'
+require 'dogapi/v1/synthetics'
 require 'dogapi/v1/tag'
 require 'dogapi/v1/user'
 require 'dogapi/v1/hosts'

data/lib/dogapi/v1/alert.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'
 
 module Dogapi

data/lib/dogapi/v1/aws_integration.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'
 
 module Dogapi

data/lib/dogapi/v1/aws_logs.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'
 
 module Dogapi

data/lib/dogapi/v1/azure_integration.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'
 
 module Dogapi

data/lib/dogapi/v1/comment.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'
 
 module Dogapi

data/lib/dogapi/v1/dash.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'
 
 module Dogapi
@@ -7,23 +11,25 @@ module Dogapi
 
       API_VERSION = 'v1'
 
-      def create_dashboard(title, description, graphs, template_variables = nil)
+      def create_dashboard(title, description, graphs, template_variables = nil, read_only = false)
         body = {
           :title => title,
           :description => description,
           :graphs => graphs,
-          :template_variables => (template_variables or [])
+          :template_variables => (template_variables or []),
+          :read_only => read_only
         }
 
         request(Net::HTTP::Post, "/api/#{API_VERSION}/dash", nil, body, true)
       end
 
-      def update_dashboard(dash_id, title, description, graphs, template_variables=nil)
+      def update_dashboard(dash_id, title, description, graphs, template_variables = nil, read_only = false)
         body = {
           :title => title,
           :description => description,
           :graphs => graphs,
-          :template_variables => (template_variables or [])
+          :template_variables => (template_variables or []),
+          :read_only => read_only
         }
 
         request(Net::HTTP::Put, "/api/#{API_VERSION}/dash/#{dash_id}", nil, body, true)

data/lib/dogapi/v1/dashboard.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'
 
 module Dogapi

data/lib/dogapi/v1/dashboard_list.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'
 
 module Dogapi

data/lib/dogapi/v1/embed.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'
 
 module Dogapi

data/lib/dogapi/v1/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 'dogapi'
 
 module Dogapi

data/lib/dogapi/v1/gcp_integration.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'
 
 module Dogapi

data/lib/dogapi/v1/hosts.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'
 
 module Dogapi

data/lib/dogapi/v1/integration.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'
 
 module Dogapi

data/lib/dogapi/v1/metadata.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'
 
 module Dogapi

data/lib/dogapi/v1/metric.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'
 
 module Dogapi

data/lib/dogapi/v1/monitor.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'
 
 module Dogapi
@@ -51,8 +55,8 @@ module Dogapi
         request(Net::HTTP::Get, "/api/#{API_VERSION}/monitor/can_delete", extra_params, nil, false)
       end
 
-      def delete_monitor(monitor_id)
-        request(Net::HTTP::Delete, "/api/#{API_VERSION}/monitor/#{monitor_id}", nil, nil, false)
+      def delete_monitor(monitor_id, options = {})
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/monitor/#{monitor_id}", options, nil, false)
       end
 
       def get_all_monitors(options = {})

data/lib/dogapi/v1/screenboard.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'
 
 module Dogapi

data/lib/dogapi/v1/search.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'
 
 module Dogapi

data/lib/dogapi/v1/service_check.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'
 
 module Dogapi

data/lib/dogapi/v1/snapshot.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'
 
 module Dogapi

data/lib/dogapi/v1/synthetics.rb

@@ -0,0 +1,80 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+    # SyntheticsService is the class responsible for dealing with the synthetics
+    class SyntheticsService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      # Create a synthetics test: POST /v1/synthetics/tests/
+      def create_synthetics_test(type, config, options = {})
+        body = {
+          'type' => type,
+          'config' => config
+        }.merge(options)
+
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/synthetics/tests", nil, body, true)
+      end
+
+      # Edit a synthetics test: PUT /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>
+      def update_synthetics_test(test_id, type, config, options = {})
+        body = {
+          'type' => type,
+          'config' => config
+        }.merge(options)
+
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/synthetics/tests/#{test_id}", nil, body, true)
+      end
+
+      # Delete synthetics tests
+      def delete_synthetics_tests(test_ids)
+        body = {
+          'public_ids' => test_ids
+        }
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/synthetics/tests/delete", nil, body, true)
+      end
+
+      # Start of pause a synthetics test: POST /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>/status
+      def start_pause_synthetics_test(test_id, new_status)
+        body = {
+          'new_status' => new_status
+        }
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/synthetics/tests/#{test_id}/status", nil, body, true)
+      end
+
+      # Get all synthetics tests: GET /v1/synthetics/tests
+      def get_all_synthetics_tests
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/tests", nil, nil, false)
+      end
+
+      # Get info on a synthetics test: GET /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>
+      def get_synthetics_test(test_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/tests/#{test_id}", nil, nil, false)
+      end
+
+      # Get the most recent results for a synthetics test: GET /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>/results
+      def get_synthetics_results(test_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/tests/#{test_id}/results", nil, nil, false)
+      end
+
+      # Get a specific result for a synthetics test:
+      # GET /v1/synthetics/tests/<SYNTHETICS_TEST_PUBLIC_ID>/results/<RESULT_ID>
+      def get_synthetics_result(test_id, result_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/tests/#{test_id}/results/#{result_id}", nil, nil, false)
+      end
+
+      # Get devices for browser checks: GET /v1/synthetics/browser/devices
+      def get_synthetics_devices
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/browser/devices", nil, nil, false)
+      end
+
+      # Get available locations: GET /v1/synthetics/locations
+      def get_synthetics_locations
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/synthetics/locations", nil, nil, false)
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/v1/tag.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'
 
 module Dogapi