class DatadogAPIClient::V2::LogsMetricsAPI

Attributes

api_client[RW]

Public Class Methods

new(api_client = APIClient.default) click to toggle source
# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 22
def initialize(api_client = APIClient.default)
  @api_client = api_client
end

Public Instance Methods

create_logs_metric(body, opts = {}) click to toggle source

Create a log-based metric Create a metric based on your ingested logs in your organization. Returns the log-based metric object from the request body when the request is successful. @param body [LogsMetricCreateRequest] The definition of the new log-based metric. @param [Hash] opts the optional parameters @return [LogsMetricResponse]

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 30
def create_logs_metric(body, opts = {})
  data, _status_code, _headers = create_logs_metric_with_http_info(body, opts)
  data
end
create_logs_metric_with_http_info(body, opts = {}) click to toggle source

Create a log-based metric Create a metric based on your ingested logs in your organization. Returns the log-based metric object from the request body when the request is successful. @param body [LogsMetricCreateRequest] The definition of the new log-based metric. @param [Hash] opts the optional parameters @return [Array<(LogsMetricResponse, Integer, Hash)>] LogsMetricResponse data, response status code and response headers

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 40
def create_logs_metric_with_http_info(body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:create_logs_metric)
    unstable_enabled = @api_client.config.unstable_operations[:create_logs_metric]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "create_logs_metric")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "create_logs_metric"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsMetricsAPI.create_logs_metric ...'
  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 LogsMetricsAPI.create_logs_metric"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/metrics'

  # 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'])

  # 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] || 'LogsMetricResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_logs_metric,
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LogsMetricsAPI#create_logs_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_logs_metric(metric_id, opts = {}) click to toggle source

Delete a log-based metric Delete a specific log-based metric from your organization. @param metric_id [String] The name of the log-based metric. @param [Hash] opts the optional parameters @return [nil]

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 105
def delete_logs_metric(metric_id, opts = {})
  delete_logs_metric_with_http_info(metric_id, opts)
  nil
end
delete_logs_metric_with_http_info(metric_id, opts = {}) click to toggle source

Delete a log-based metric Delete a specific log-based metric from your organization. @param metric_id [String] The name of the log-based metric. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 115
def delete_logs_metric_with_http_info(metric_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:delete_logs_metric)
    unstable_enabled = @api_client.config.unstable_operations[:delete_logs_metric]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "delete_logs_metric")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "delete_logs_metric"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsMetricsAPI.delete_logs_metric ...'
  end
  # verify the required parameter 'metric_id' is set
  if @api_client.config.client_side_validation && metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'metric_id' when calling LogsMetricsAPI.delete_logs_metric"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/metrics/{metric_id}'.sub('{' + 'metric_id' + '}', CGI.escape(metric_id.to_s))

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_logs_metric,
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LogsMetricsAPI#delete_logs_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_logs_metric(metric_id, opts = {}) click to toggle source

Get a log-based metric Get a specific log-based metric from your organization. @param metric_id [String] The name of the log-based metric. @param [Hash] opts the optional parameters @return [LogsMetricResponse]

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 178
def get_logs_metric(metric_id, opts = {})
  data, _status_code, _headers = get_logs_metric_with_http_info(metric_id, opts)
  data
end
get_logs_metric_with_http_info(metric_id, opts = {}) click to toggle source

Get a log-based metric Get a specific log-based metric from your organization. @param metric_id [String] The name of the log-based metric. @param [Hash] opts the optional parameters @return [Array<(LogsMetricResponse, Integer, Hash)>] LogsMetricResponse data, response status code and response headers

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 188
def get_logs_metric_with_http_info(metric_id, opts = {})

  if @api_client.config.unstable_operations.has_key?(:get_logs_metric)
    unstable_enabled = @api_client.config.unstable_operations[:get_logs_metric]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "get_logs_metric")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "get_logs_metric"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsMetricsAPI.get_logs_metric ...'
  end
  # verify the required parameter 'metric_id' is set
  if @api_client.config.client_side_validation && metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'metric_id' when calling LogsMetricsAPI.get_logs_metric"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/metrics/{metric_id}'.sub('{' + 'metric_id' + '}', CGI.escape(metric_id.to_s))

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LogsMetricResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_logs_metric,
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LogsMetricsAPI#get_logs_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_logs_metrics(opts = {}) click to toggle source

Get all log-based metrics Get the list of configured log-based metrics with their definitions. @param [Hash] opts the optional parameters @return [LogsMetricsResponse]

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 250
def list_logs_metrics(opts = {})
  data, _status_code, _headers = list_logs_metrics_with_http_info(opts)
  data
end
list_logs_metrics_with_http_info(opts = {}) click to toggle source

Get all log-based metrics Get the list of configured log-based metrics with their definitions. @param [Hash] opts the optional parameters @return [Array<(LogsMetricsResponse, Integer, Hash)>] LogsMetricsResponse data, response status code and response headers

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 259
def list_logs_metrics_with_http_info(opts = {})

  if @api_client.config.unstable_operations.has_key?(:list_logs_metrics)
    unstable_enabled = @api_client.config.unstable_operations[:list_logs_metrics]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "list_logs_metrics")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_logs_metrics"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsMetricsAPI.list_logs_metrics ...'
  end
  # resource path
  local_var_path = '/api/v2/logs/config/metrics'

  # 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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LogsMetricsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_logs_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LogsMetricsAPI#list_logs_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_logs_metric(metric_id, body, opts = {}) click to toggle source

Update a log-based metric Update a specific log-based metric from your organization. Returns the log-based metric object from the request body when the request is successful. @param metric_id [String] The name of the log-based metric. @param body [LogsMetricUpdateRequest] New definition of the log-based metric. @param [Hash] opts the optional parameters @return [LogsMetricResponse]

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 319
def update_logs_metric(metric_id, body, opts = {})
  data, _status_code, _headers = update_logs_metric_with_http_info(metric_id, body, opts)
  data
end
update_logs_metric_with_http_info(metric_id, body, opts = {}) click to toggle source

Update a log-based metric Update a specific log-based metric from your organization. Returns the log-based metric object from the request body when the request is successful. @param metric_id [String] The name of the log-based metric. @param body [LogsMetricUpdateRequest] New definition of the log-based metric. @param [Hash] opts the optional parameters @return [Array<(LogsMetricResponse, Integer, Hash)>] LogsMetricResponse data, response status code and response headers

# File lib/datadog_api_client/v2/api/logs_metrics_api.rb, line 330
def update_logs_metric_with_http_info(metric_id, body, opts = {})

  if @api_client.config.unstable_operations.has_key?(:update_logs_metric)
    unstable_enabled = @api_client.config.unstable_operations[:update_logs_metric]
    if unstable_enabled
      @api_client.config.logger.warn format("Using unstable operation '%s'", "update_logs_metric")
    else
      raise APIError.new(message: format("Unstable operation '%s' is disabled", "update_logs_metric"))
    end
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsMetricsAPI.update_logs_metric ...'
  end
  # verify the required parameter 'metric_id' is set
  if @api_client.config.client_side_validation && metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'metric_id' when calling LogsMetricsAPI.update_logs_metric"
  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 LogsMetricsAPI.update_logs_metric"
  end
  # resource path
  local_var_path = '/api/v2/logs/config/metrics/{metric_id}'.sub('{' + 'metric_id' + '}', CGI.escape(metric_id.to_s))

  # 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'])

  # 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] || 'LogsMetricResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_logs_metric,
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LogsMetricsAPI#update_logs_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end