dogapi 1.37.1 → 1.42.0

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'
@@ -11,9 +15,15 @@ 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'
 require 'dogapi/v1/user'
 require 'dogapi/v1/hosts'
 require 'dogapi/v1/integration'
 require 'dogapi/v1/usage'
+require 'dogapi/v1/aws_integration'
+require 'dogapi/v1/aws_logs'
+require 'dogapi/v1/azure_integration'
+require 'dogapi/v1/gcp_integration'

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

@@ -0,0 +1,117 @@
+# 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
+  class V1 # for namespacing
+
+    # AwsIntegrationService for user interaction with AWS configs.
+    class AwsIntegrationService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      # Retrieve AWS integration information
+      def aws_integration_list
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/integration/aws", nil, nil, false)
+      end
+
+      # Create an AWS integration
+      # :config => Hash: integration config.
+      # config = {
+      #   :account_id => '<AWS_ACCOUNT>',
+      #   :host_tags => ['api:example'],
+      #   :role_name => '<AWS_ROLE_NAME>'
+      # }
+      #
+      # Access Key/Secret Access Key based accounts (GovCloud and China only)
+      #
+      # config = {
+      #   :access_key_id => '<AWS_ACCESS_KEY_ID>',
+      #   :host_tags => ['api:example'],
+      #   :secret_access_key => '<AWS_SECRET_ACCESS_KEY>'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.aws_integration_create(config)
+      def aws_integration_create(config)
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/integration/aws", nil, config, true)
+      end
+
+      # Delete an integration
+      # :config => Hash: integration config.
+      # config = {
+      #   :account_id => '<AWS_ACCOUNT>',
+      #   :role_name => '<AWS_ROLE_NAME>'
+      # }
+      # Access Key/Secret Access Key based accounts (GovCloud and China only)
+      #
+      # config = {
+      #   :access_key_id => '<AWS_ACCESS_KEY_ID>',
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.aws_integration_delete(config)
+      def aws_integration_delete(config)
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/integration/aws", nil, config, true)
+      end
+
+      # List available AWS namespaces
+      def aws_integration_list_namespaces
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/integration/aws/available_namespace_rules", nil, nil, false)
+      end
+
+      # Generate new AWS external ID for a specific integrated account
+      # :config => Hash: integration config.
+      # config = {
+      #   :account_id => '<AWS_ACCOUNT>',
+      #   :role_name => '<AWS_ROLE_NAME>'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.aws_integration_generate_external_id(config)
+      def aws_integration_generate_external_id(config)
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/integration/aws/generate_new_external_id", nil, config, true)
+      end
+
+      # Update integrated AWS account.
+      # :config => Hash: integration config.
+      # config = {
+      #   "account_id": '<EXISTING_AWS_ACCOUNT>',
+      #   "role_name": '<EXISTING_AWS_ROLE_NAME>'
+      # }
+      #
+      # new_config = {
+      #   "account_id": '<NEW_AWS_ACCOUNT>',
+      #   "host_tags": ['tag:example1,tag:example2'],
+      #   "filter_tags": ['datadog:true']
+      # }
+      #
+      # Access Key/Secret Access Key based accounts (GovCloud and China only)
+      #
+      # config = {
+      #   "access_key_id": '<EXISTING_ACCESS_KEY_ID>',
+      #   "secret_access_key": '<EXISTING_SECRET_ACCESS_KEY>'
+      # }
+      #
+      # new_config = {
+      #   "access_key_id": '<NEW_ACCESS_KEY_ID>',
+      #   "host_tags": ['new:tags'],
+      #   "filter_tags": ['datadog:true']
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+
+      # puts dog.aws_integration_update(config, new_config)
+      def aws_integration_update(config, new_config)
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/integration/aws", config, new_config, true)
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/v1/aws_logs.rb

@@ -0,0 +1,107 @@
+# 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
+  class V1 # for namespacing
+
+    # AwsLogsService for user interaction with AWS configs.
+    class AwsLogsService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      # Get the list of current AWS services for which Datadog offers automatic log collection.
+      # Use returned service IDs with the services parameter for the Enable
+      # an AWS service log collection API endpoint.
+      def aws_logs_list_services
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/integration/aws/logs/services", nil, nil, false)
+      end
+
+      # Create an AWS integration
+      # :config => Hash: integration config.
+      # config = {
+      #   :account_id => '<AWS_ACCOUNT>',
+      #   :lambda_arn => '<LAMBDA_ARN>'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.aws_logs_add_lambda(config)
+      def aws_logs_add_lambda(config)
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/integration/aws/logs", nil, config, true)
+      end
+
+      # List all Datadog-AWS Logs integrations configured in your Datadog account.
+      def aws_logs_integrations_list
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/integration/aws/logs", nil, nil, false)
+      end
+
+      # Enable automatic log collection for a list of services.
+      # This should be run after running 'aws_logs_add_lambda' to save the config.
+      # config = {
+      #   :account_id => '<AWS_ACCOUNT>',
+      #   :services => ['s3', 'elb', 'elbv2', 'cloudfront', 'redshift', 'lambda']
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.aws_logs_save_services(config)
+      def aws_logs_save_services(config)
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/integration/aws/logs/services", nil, config, true)
+      end
+
+      # Delete an AWS Logs integration
+      # :config => Hash: integration config.
+      # config = {
+      #   :account_id => '<AWS_ACCOUNT>',
+      #   :lambda_arn => '<LAMBDA_ARN>'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.aws_logs_integration_delete(config)
+      def aws_logs_integration_delete(config)
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/integration/aws/logs", nil, config, true)
+      end
+
+      # Check function to see if a lambda_arn exists within an account.
+      # This sends a job on our side if it does not exist, then immediately returns
+      # the status of that job. Subsequent requests will always repeat the above, so this endpoint
+      # can be polled intermittently instead of blocking.
+
+      # Returns a status of 'created' when it's checking if the Lambda exists in the account.
+      # Returns a status of 'waiting' while checking.
+      # Returns a status of 'checked and ok' if the Lambda exists.
+      # Returns a status of 'error' if the Lambda does not exist.
+
+      # contents of config should be
+      # >>> :account_id => '<AWS_ACCOUNT_ID>'
+      # >>> :lambda_arn => '<AWS_LAMBDA_ARN>'
+
+      def aws_logs_check_lambda(config)
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/integration/aws/logs/check_async", nil, config, true)
+      end
+
+      # Test if permissions are present to add log-forwarding triggers for the
+      # given services + AWS account. Input is the same as for save_services.
+      # Done async, so can be repeatedly polled in a non-blocking fashion until
+      # the async request completes
+
+      # Returns a status of 'created' when it's checking if the permissions exists in the AWS account.
+      # Returns a status of 'waiting' while checking.
+      # Returns a status of 'checked and ok' if the Lambda exists.
+      # Returns a status of 'error' if the Lambda does not exist.
+
+      # contents of config should be
+      # :account_id => '<AWS_ACCOUNT_ID>'
+      # :services => ['s3', 'elb', 'elbv2', 'cloudfront', 'redshift', 'lambda']
+      def aws_logs_check_services(config)
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/integration/aws/logs/services_async", nil, config, true)
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/v1/azure_integration.rb

@@ -0,0 +1,85 @@
+# 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
+  class V1 # for namespacing
+
+    # AzureIntegrationService for user interaction with Azure configs.
+    class AzureIntegrationService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+
+      # Retrieve Azure integration information
+      def azure_integration_list
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/integration/azure", nil, nil, false)
+      end
+
+      # Delete an Azure integration
+      # :config => Hash: integration config.
+      # config = {
+      #   :tenant_name => '<TENANT_NAME>',
+      #   :client_id => '<CLIENT_ID>'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.azure_integration_delete(config)
+      def azure_integration_delete(config)
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/integration/azure", nil, config, true)
+      end
+
+      # Create an Azure integration
+      # :config => Hash: integration config.
+      # config = {
+      #   :tenant_name => '<TENANT_NAME>',
+      #   :host_filters => 'new:filter',
+      #   :client_id => '<CLIENT_ID>',
+      #   :client_secret => '<CLIENT_SECRET>'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.azure_integration_create(config)
+      def azure_integration_create(config)
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/integration/azure", nil, config, true)
+      end
+
+      # Update an Azure integrations host filters
+      # :config => Hash: integration config.
+      # config = {
+      #   :tenant_name => '<TENANT_NAME>',
+      #   :host_filters => 'new:filter',
+      #   :client_id => '<CLIENT_ID>'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.azure_integration_update_host_filters(config)
+      def azure_integration_update_host_filters(config)
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/integration/azure/host_filters", nil, config, true)
+      end
+
+      # Update a configured Azure account.
+      # :config => Hash: integration config.
+      # config = {
+      #   :tenant_name => '<TENANT_NAME>',
+      #   :new_tenant_name => '<NEW_TENANT_NAME>',
+      #   :host_filters => '<KEY>:<VALUE>,<KEY>:<VALUE>',
+      #   :client_id => '<CLIENT_ID>',
+      #   :new_client_id => '<NEW_CLIENT_ID>'
+      # }
+      #
+      # dog = Dogapi::Client.new(api_key, app_key)
+      #
+      # puts dog.azure_integration_update(config)
+      def azure_integration_update(config)
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/integration/azure", nil, config, true)
+      end
+
+    end
+
+  end
+end

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
@@ -24,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 = {
@@ -36,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
@@ -56,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 = {
@@ -68,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/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