datadog_api_client 1.9.0 → 2.0.0

data/lib/datadog_api_client/v2/api/metrics_api.rb

@@ -19,7 +19,7 @@ module DatadogAPIClient::V2
   class MetricsAPI
     attr_accessor :api_client
 
-    def initialize(api_client = APIClient.default)
+    def initialize(api_client = DatadogAPIClient::APIClient.default)
       @api_client = api_client
     end
 
@@ -45,15 +45,6 @@ module DatadogAPIClient::V2
     # @return [Array<(MetricBulkTagConfigResponse, Integer, Hash)>] MetricBulkTagConfigResponse data, response status code and response headers
     def create_bulk_tags_metrics_configuration_with_http_info(body, opts = {})
 
-      if @api_client.config.unstable_operations.has_key?(:create_bulk_tags_metrics_configuration)
-        unstable_enabled = @api_client.config.unstable_operations[:create_bulk_tags_metrics_configuration]
-        if unstable_enabled
-          @api_client.config.logger.warn format("Using unstable operation '%s'", "create_bulk_tags_metrics_configuration")
-        else
-          raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_bulk_tags_metrics_configuration"))
-        end
-      end
-
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.create_bulk_tags_metrics_configuration ...'
       end
@@ -93,7 +84,8 @@ module DatadogAPIClient::V2
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type
+        :return_type => return_type,
+        :api_version => "V2"
       )
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
@@ -124,15 +116,6 @@ module DatadogAPIClient::V2
     # @return [Array<(MetricTagConfigurationResponse, Integer, Hash)>] MetricTagConfigurationResponse data, response status code and response headers
     def create_tag_configuration_with_http_info(metric_name, body, opts = {})
 
-      if @api_client.config.unstable_operations.has_key?(:create_tag_configuration)
-        unstable_enabled = @api_client.config.unstable_operations[:create_tag_configuration]
-        if unstable_enabled
-          @api_client.config.logger.warn format("Using unstable operation '%s'", "create_tag_configuration")
-        else
-          raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_tag_configuration"))
-        end
-      end
-
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.create_tag_configuration ...'
       end
@@ -176,7 +159,8 @@ module DatadogAPIClient::V2
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type
+        :return_type => return_type,
+        :api_version => "V2"
       )
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
@@ -206,15 +190,6 @@ module DatadogAPIClient::V2
     # @return [Array<(MetricBulkTagConfigResponse, Integer, Hash)>] MetricBulkTagConfigResponse data, response status code and response headers
     def delete_bulk_tags_metrics_configuration_with_http_info(body, opts = {})
 
-      if @api_client.config.unstable_operations.has_key?(:delete_bulk_tags_metrics_configuration)
-        unstable_enabled = @api_client.config.unstable_operations[:delete_bulk_tags_metrics_configuration]
-        if unstable_enabled
-          @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_bulk_tags_metrics_configuration")
-        else
-          raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_bulk_tags_metrics_configuration"))
-        end
-      end
-
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.delete_bulk_tags_metrics_configuration ...'
       end
@@ -254,7 +229,8 @@ module DatadogAPIClient::V2
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type
+        :return_type => return_type,
+        :api_version => "V2"
       )
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
@@ -282,15 +258,6 @@ module DatadogAPIClient::V2
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_tag_configuration_with_http_info(metric_name, opts = {})
 
-      if @api_client.config.unstable_operations.has_key?(:delete_tag_configuration)
-        unstable_enabled = @api_client.config.unstable_operations[:delete_tag_configuration]
-        if unstable_enabled
-          @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_tag_configuration")
-        else
-          raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_tag_configuration"))
-        end
-      end
-
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.delete_tag_configuration ...'
       end
@@ -328,7 +295,8 @@ module DatadogAPIClient::V2
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type
+        :return_type => return_type,
+        :api_version => "V2"
       )
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
@@ -338,6 +306,81 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Tag Configuration Cardinality Estimator.
+    #
+    # @see #estimate_metrics_output_series_with_http_info
+    def estimate_metrics_output_series(metric_name, opts = {})
+      data, _status_code, _headers = estimate_metrics_output_series_with_http_info(metric_name, opts)
+      data
+    end
+
+    # Tag Configuration Cardinality Estimator.
+    #
+    # Returns the estimated cardinality for a metric with a given tag, percentile and number of aggregations configuration using Metrics without Limits&trade;.
+    #
+    # @param metric_name [String] The name of the metric.
+    # @param opts [Hash] the optional parameters
+    # @option opts [String] :filter_groups Filtered tag keys that the metric is configured to query with.
+    # @option opts [Integer] :filter_hours_ago The number of hours of look back (from now) to estimate cardinality with.
+    # @option opts [Integer] :filter_num_aggregations The number of aggregations that a `count`, `rate`, or `gauge` metric is configured to use. Max number of aggregation combos is 9.
+    # @option opts [Boolean] :filter_pct A boolean, for distribution metrics only, to estimate cardinality if the metric includes additional percentile aggregators.
+    # @option opts [Integer] :filter_timespan_h A window, in hours, from the look back to estimate cardinality with.
+    # @return [Array<(MetricEstimateResponse, Integer, Hash)>] MetricEstimateResponse data, response status code and response headers
+    def estimate_metrics_output_series_with_http_info(metric_name, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetricsAPI.estimate_metrics_output_series ...'
+      end
+      # verify the required parameter 'metric_name' is set
+      if @api_client.config.client_side_validation && metric_name.nil?
+        fail ArgumentError, "Missing the required parameter 'metric_name' when calling MetricsAPI.estimate_metrics_output_series"
+      end
+      # resource path
+      local_var_path = '/api/v2/metrics/{metric_name}/estimate'.sub('{metric_name}', CGI.escape(metric_name.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[groups]'] = opts[:'filter_groups'] if !opts[:'filter_groups'].nil?
+      query_params[:'filter[hours_ago]'] = opts[:'filter_hours_ago'] if !opts[:'filter_hours_ago'].nil?
+      query_params[:'filter[num_aggregations]'] = opts[:'filter_num_aggregations'] if !opts[:'filter_num_aggregations'].nil?
+      query_params[:'filter[pct]'] = opts[:'filter_pct'] if !opts[:'filter_pct'].nil?
+      query_params[:'filter[timespan_h]'] = opts[:'filter_timespan_h'] if !opts[:'filter_timespan_h'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MetricEstimateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :estimate_metrics_output_series,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MetricsAPI#estimate_metrics_output_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List tag configuration by name.
     #
     # @see #list_tag_configuration_by_name_with_http_info
@@ -355,15 +398,6 @@ module DatadogAPIClient::V2
     # @return [Array<(MetricTagConfigurationResponse, Integer, Hash)>] MetricTagConfigurationResponse data, response status code and response headers
     def list_tag_configuration_by_name_with_http_info(metric_name, opts = {})
 
-      if @api_client.config.unstable_operations.has_key?(:list_tag_configuration_by_name)
-        unstable_enabled = @api_client.config.unstable_operations[:list_tag_configuration_by_name]
-        if unstable_enabled
-          @api_client.config.logger.warn format("Using unstable operation '%s'", "list_tag_configuration_by_name")
-        else
-          raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_tag_configuration_by_name"))
-        end
-      end
-
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.list_tag_configuration_by_name ...'
       end
@@ -392,7 +426,7 @@ module DatadogAPIClient::V2
       return_type = opts[:debug_return_type] || 'MetricTagConfigurationResponse'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
 
       new_options = opts.merge(
         :operation => :list_tag_configuration_by_name,
@@ -401,7 +435,8 @@ module DatadogAPIClient::V2
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type
+        :return_type => return_type,
+        :api_version => "V2"
       )
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
@@ -434,15 +469,6 @@ module DatadogAPIClient::V2
     # @return [Array<(MetricsAndMetricTagConfigurationsResponse, Integer, Hash)>] MetricsAndMetricTagConfigurationsResponse data, response status code and response headers
     def list_tag_configurations_with_http_info(opts = {})
 
-      if @api_client.config.unstable_operations.has_key?(:list_tag_configurations)
-        unstable_enabled = @api_client.config.unstable_operations[:list_tag_configurations]
-        if unstable_enabled
-          @api_client.config.logger.warn format("Using unstable operation '%s'", "list_tag_configurations")
-        else
-          raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_tag_configurations"))
-        end
-      end
-
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.list_tag_configurations ...'
       end
@@ -486,7 +512,8 @@ module DatadogAPIClient::V2
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type
+        :return_type => return_type,
+        :api_version => "V2"
       )
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
@@ -513,15 +540,6 @@ module DatadogAPIClient::V2
     # @return [Array<(MetricAllTagsResponse, Integer, Hash)>] MetricAllTagsResponse data, response status code and response headers
     def list_tags_by_metric_name_with_http_info(metric_name, opts = {})
 
-      if @api_client.config.unstable_operations.has_key?(:list_tags_by_metric_name)
-        unstable_enabled = @api_client.config.unstable_operations[:list_tags_by_metric_name]
-        if unstable_enabled
-          @api_client.config.logger.warn format("Using unstable operation '%s'", "list_tags_by_metric_name")
-        else
-          raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_tags_by_metric_name"))
-        end
-      end
-
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.list_tags_by_metric_name ...'
       end
@@ -559,7 +577,8 @@ module DatadogAPIClient::V2
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type
+        :return_type => return_type,
+        :api_version => "V2"
       )
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
@@ -581,8 +600,6 @@ module DatadogAPIClient::V2
     #
     # View distinct metrics volumes for the given metric name.
     #
-    # Custom distribution metrics will return both ingested and indexed custom metric volumes.
-    # For Metrics without Limits&trade; beta customers, all metrics will return both ingested/indexed volumes.
     # Custom metrics generated in-app from other products will return `null` for ingested volumes.
     #
     # @param metric_name [String] The name of the metric.
@@ -590,15 +607,6 @@ module DatadogAPIClient::V2
     # @return [Array<(MetricVolumesResponse, Integer, Hash)>] MetricVolumesResponse data, response status code and response headers
     def list_volumes_by_metric_name_with_http_info(metric_name, opts = {})
 
-      if @api_client.config.unstable_operations.has_key?(:list_volumes_by_metric_name)
-        unstable_enabled = @api_client.config.unstable_operations[:list_volumes_by_metric_name]
-        if unstable_enabled
-          @api_client.config.logger.warn format("Using unstable operation '%s'", "list_volumes_by_metric_name")
-        else
-          raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_volumes_by_metric_name"))
-        end
-      end
-
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.list_volumes_by_metric_name ...'
       end
@@ -636,7 +644,8 @@ module DatadogAPIClient::V2
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type
+        :return_type => return_type,
+        :api_version => "V2"
       )
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
@@ -646,6 +655,90 @@ module DatadogAPIClient::V2
       return data, status_code, headers
     end
 
+    # Submit metrics.
+    #
+    # @see #submit_metrics_with_http_info
+    def submit_metrics(body, opts = {})
+      data, _status_code, _headers = submit_metrics_with_http_info(body, opts)
+      data
+    end
+
+    # Submit metrics.
+    #
+    # The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards.
+    # The maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed size of less than 5 megabytes (5242880 bytes).
+    #
+    # If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:
+    #
+    # - 64 bits for the timestamp
+    # - 64 bits for the value
+    # - 20 bytes for the metric names
+    # - 50 bytes for the timeseries
+    # - The full payload is approximately 100 bytes.
+    #
+    # Host name is one of the resources in the Resources field.
+    #
+    # @param body [MetricPayload] 
+    # @param opts [Hash] the optional parameters
+    # @option opts [MetricContentEncoding] :content_encoding HTTP header used to compress the media-type.
+    # @return [Array<(IntakePayloadAccepted, Integer, Hash)>] IntakePayloadAccepted data, response status code and response headers
+    def submit_metrics_with_http_info(body, opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetricsAPI.submit_metrics ...'
+      end
+      allowable_values = ['deflate']
+      if @api_client.config.client_side_validation && opts[:'content_encoding'] && !allowable_values.include?(opts[:'content_encoding'])
+        fail ArgumentError, "invalid value for \"content_encoding\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling MetricsAPI.submit_metrics"
+      end
+      # resource path
+      local_var_path = '/api/v2/series'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params['Content-Encoding'] = opts[:'content_encoding'] if !opts[:'content_encoding'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IntakePayloadAccepted'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :submit_metrics,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MetricsAPI#submit_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a tag configuration.
     #
     # @see #update_tag_configuration_with_http_info
@@ -666,15 +759,6 @@ module DatadogAPIClient::V2
     # @return [Array<(MetricTagConfigurationResponse, Integer, Hash)>] MetricTagConfigurationResponse data, response status code and response headers
     def update_tag_configuration_with_http_info(metric_name, body, opts = {})
 
-      if @api_client.config.unstable_operations.has_key?(:update_tag_configuration)
-        unstable_enabled = @api_client.config.unstable_operations[:update_tag_configuration]
-        if unstable_enabled
-          @api_client.config.logger.warn format("Using unstable operation '%s'", "update_tag_configuration")
-        else
-          raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_tag_configuration"))
-        end
-      end
-
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MetricsAPI.update_tag_configuration ...'
       end
@@ -718,7 +802,8 @@ module DatadogAPIClient::V2
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type
+        :return_type => return_type,
+        :api_version => "V2"
       )
 
       data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)