datadog_api_client 1.8.0 → 1.11.0

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

@@ -23,28 +23,23 @@ module DatadogAPIClient::V2
       @api_client = api_client
     end
 
-    # Configure tags for multiple metrics
-    # Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
-    # Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
-    # Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
-    # If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not
-    # expect deterministic ordering of concurrent calls.
-    # Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
-    # @param body [MetricBulkTagConfigCreateRequest] 
-    # @param opts [Hash] the optional parameters
-    # @return [MetricBulkTagConfigResponse]
+    # Configure tags for multiple metrics.
+    #
+    # @see #create_bulk_tags_metrics_configuration_with_http_info
     def create_bulk_tags_metrics_configuration(body, opts = {})
       data, _status_code, _headers = create_bulk_tags_metrics_configuration_with_http_info(body, opts)
       data
     end
 
-    # Configure tags for multiple metrics
+    # Configure tags for multiple metrics.
+    #
     # Create and define a list of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
     # Metrics are selected by passing a metric name prefix. Use the Delete method of this API path to remove tag configurations.
     # Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
     # If multiple calls include the same metric, the last configuration applied (not by submit order) is used, do not
     # expect deterministic ordering of concurrent calls.
     # Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
+    #
     # @param body [MetricBulkTagConfigCreateRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(MetricBulkTagConfigResponse, Integer, Hash)>] MetricBulkTagConfigResponse data, response status code and response headers
@@ -101,32 +96,28 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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#create_bulk_tags_metrics_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Create a tag configuration
-    # Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
-    # Optionally, include percentile aggregations on any distribution metric or configure custom aggregations
-    # on any count, rate, or gauge metric.
-    # Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
-    # @param metric_name [String] The name of the metric.
-    # @param body [MetricTagConfigurationCreateRequest] 
-    # @param opts [Hash] the optional parameters
-    # @return [MetricTagConfigurationResponse]
+    # Create a tag configuration.
+    #
+    # @see #create_tag_configuration_with_http_info
     def create_tag_configuration(metric_name, body, opts = {})
       data, _status_code, _headers = create_tag_configuration_with_http_info(metric_name, body, opts)
       data
     end
 
-    # Create a tag configuration
+    # Create a tag configuration.
+    #
     # Create and define a list of queryable tag keys for an existing count/gauge/rate/distribution metric.
     # Optionally, include percentile aggregations on any distribution metric or configure custom aggregations
     # on any count, rate, or gauge metric.
     # Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
+    #
     # @param metric_name [String] The name of the metric.
     # @param body [MetricTagConfigurationCreateRequest] 
     # @param opts [Hash] the optional parameters
@@ -188,31 +179,28 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      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#create_tag_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Configure tags for multiple metrics
-    # Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
-    # Metrics are selected by passing a metric name prefix.
-    # Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
-    # Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
-    # @param body [MetricBulkTagConfigDeleteRequest] 
-    # @param opts [Hash] the optional parameters
-    # @return [MetricBulkTagConfigResponse]
+    # Configure tags for multiple metrics.
+    #
+    # @see #delete_bulk_tags_metrics_configuration_with_http_info
     def delete_bulk_tags_metrics_configuration(body, opts = {})
       data, _status_code, _headers = delete_bulk_tags_metrics_configuration_with_http_info(body, opts)
       data
     end
 
-    # Configure tags for multiple metrics
+    # Configure tags for multiple metrics.
+    #
     # Delete all custom lists of queryable tag keys for a set of existing count, gauge, rate, and distribution metrics.
     # Metrics are selected by passing a metric name prefix.
     # Results can be sent to a set of account email addresses, just like the same operation in the Datadog web app.
     # Can only be used with application keys of users with the `Manage Tags for Metrics` permission.
+    #
     # @param body [MetricBulkTagConfigDeleteRequest] 
     # @param opts [Hash] the optional parameters
     # @return [Array<(MetricBulkTagConfigResponse, Integer, Hash)>] MetricBulkTagConfigResponse data, response status code and response headers
@@ -269,27 +257,26 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: MetricsAPI#delete_bulk_tags_metrics_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Delete a tag configuration
-    # Deletes a metric's tag configuration. Can only be used with application
-    # keys from users with the `Manage Tags for Metrics` permission.
-    # @param metric_name [String] The name of the metric.
-    # @param opts [Hash] the optional parameters
-    # @return [nil]
+    # Delete a tag configuration.
+    #
+    # @see #delete_tag_configuration_with_http_info
     def delete_tag_configuration(metric_name, opts = {})
       delete_tag_configuration_with_http_info(metric_name, opts)
       nil
     end
 
-    # Delete a tag configuration
+    # Delete a tag configuration.
+    #
     # Deletes a metric's tag configuration. Can only be used with application
     # keys from users with the `Manage Tags for Metrics` permission.
+    #
     # @param metric_name [String] The name of the metric.
     # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -344,25 +331,108 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: MetricsAPI#delete_tag_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List tag configuration by name
-    # Returns the tag configuration for the given metric name.
+    # 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
-    # @return [MetricTagConfigurationResponse]
+    # @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.unstable_operations.has_key?(:estimate_metrics_output_series)
+        unstable_enabled = @api_client.config.unstable_operations[:estimate_metrics_output_series]
+        if unstable_enabled
+          @api_client.config.logger.warn format("Using unstable operation '%s'", "estimate_metrics_output_series")
+        else
+          raise APIError.new(message: format("Unstable operation '%s' is disabled", "estimate_metrics_output_series"))
+        end
+      end
+
+      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
+      )
+
+      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
     def list_tag_configuration_by_name(metric_name, opts = {})
       data, _status_code, _headers = list_tag_configuration_by_name_with_http_info(metric_name, opts)
       data
     end
 
-    # List tag configuration by name
+    # List tag configuration by name.
+    #
     # Returns the tag configuration for the given metric name.
+    #
     # @param metric_name [String] The name of the metric.
     # @param opts [Hash] the optional parameters
     # @return [Array<(MetricTagConfigurationResponse, Integer, Hash)>] MetricTagConfigurationResponse data, response status code and response headers
@@ -417,32 +487,26 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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#list_tag_configuration_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List tag configurations
-    # Returns all configured count/gauge/rate/distribution metric names
-    # (with additional filters if specified).
-    # @param opts [Hash] the optional parameters
-    # @option opts [Boolean] :filter_configured Filter metrics that have configured tags.
-    # @option opts [String] :filter_tags_configured Filter tag configurations by configured tags.
-    # @option opts [MetricTagConfigurationMetricTypes] :filter_metric_type Filter tag configurations by metric type.
-    # @option opts [Boolean] :filter_include_percentiles Filter distributions with additional percentile aggregations enabled or disabled.
-    # @option opts [String] :filter_tags Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters.
-    # @option opts [Integer] :window_seconds The number of seconds of look back (from now) to apply to a filter[tag] query. Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days).
-    # @return [MetricsAndMetricTagConfigurationsResponse]
+    # List tag configurations.
+    #
+    # @see #list_tag_configurations_with_http_info
     def list_tag_configurations(opts = {})
       data, _status_code, _headers = list_tag_configurations_with_http_info(opts)
       data
     end
 
-    # List tag configurations
+    # List tag configurations.
+    #
     # Returns all configured count/gauge/rate/distribution metric names
     # (with additional filters if specified).
+    #
     # @param opts [Hash] the optional parameters
     # @option opts [Boolean] :filter_configured Filter metrics that have configured tags.
     # @option opts [String] :filter_tags_configured Filter tag configurations by configured tags.
@@ -508,25 +572,25 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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#list_tag_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List tags by metric name
-    # View indexed tag key-value pairs for a given metric name.
-    # @param metric_name [String] The name of the metric.
-    # @param opts [Hash] the optional parameters
-    # @return [MetricAllTagsResponse]
+    # List tags by metric name.
+    #
+    # @see #list_tags_by_metric_name_with_http_info
     def list_tags_by_metric_name(metric_name, opts = {})
       data, _status_code, _headers = list_tags_by_metric_name_with_http_info(metric_name, opts)
       data
     end
 
-    # List tags by metric name
+    # List tags by metric name.
+    #
     # View indexed tag key-value pairs for a given metric name.
+    #
     # @param metric_name [String] The name of the metric.
     # @param opts [Hash] the optional parameters
     # @return [Array<(MetricAllTagsResponse, Integer, Hash)>] MetricAllTagsResponse data, response status code and response headers
@@ -581,33 +645,27 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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#list_tags_by_metric_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List distinct metric volumes by metric name
-    # View distinct metrics volumes for the given metric name.
+    # List distinct metric volumes by 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.
-    # @param opts [Hash] the optional parameters
-    # @return [MetricVolumesResponse]
+    # @see #list_volumes_by_metric_name_with_http_info
     def list_volumes_by_metric_name(metric_name, opts = {})
       data, _status_code, _headers = list_volumes_by_metric_name_with_http_info(metric_name, opts)
       data
     end
 
-    # List distinct metric volumes by metric name
+    # List distinct metric volumes by metric name.
+    #
     # 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.
     # @param opts [Hash] the optional parameters
     # @return [Array<(MetricVolumesResponse, Integer, Hash)>] MetricVolumesResponse data, response status code and response headers
@@ -662,30 +720,117 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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#list_volumes_by_metric_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Update a tag configuration
-    # Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations
-    # of a count, rate, or gauge metric.
-    # Can only be used with application keys from users with the `Manage Tags for Metrics` permission.
-    # @param metric_name [String] The name of the metric.
-    # @param body [MetricTagConfigurationUpdateRequest] 
+    # 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.
+    #
+    # @param body [MetricPayload] 
     # @param opts [Hash] the optional parameters
-    # @return [MetricTagConfigurationResponse]
+    # @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.unstable_operations.has_key?(:submit_metrics)
+        unstable_enabled = @api_client.config.unstable_operations[:submit_metrics]
+        if unstable_enabled
+          @api_client.config.logger.warn format("Using unstable operation '%s'", "submit_metrics")
+        else
+          raise APIError.new(message: format("Unstable operation '%s' is disabled", "submit_metrics"))
+        end
+      end
+
+      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
+      )
+
+      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
     def update_tag_configuration(metric_name, body, opts = {})
       data, _status_code, _headers = update_tag_configuration_with_http_info(metric_name, body, opts)
       data
     end
 
-    # Update a tag configuration
+    # Update a tag configuration.
+    #
     # Update the tag configuration of a metric or percentile aggregations of a distribution metric or custom aggregations
     # of a count, rate, or gauge metric.
     # Can only be used with application keys from users with the `Manage Tags for Metrics` permission.
+    #
     # @param metric_name [String] The name of the metric.
     # @param body [MetricTagConfigurationUpdateRequest] 
     # @param opts [Hash] the optional parameters
@@ -747,7 +892,7 @@ module DatadogAPIClient::V2
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: MetricsAPI#update_tag_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end