Class: DatadogAPIClient::V2::SpansMetricsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/spans_metrics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ SpansMetricsAPI

Returns a new instance of SpansMetricsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_spans_metric(body, opts = {}) ⇒ Object

Create a span-based metric.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 29

def create_spans_metric(body, opts = {})
  data, _status_code, _headers = create_spans_metric_with_http_info(body, opts)
  data
end

#create_spans_metric_with_http_info(body, opts = {}) ⇒ Array<(SpansMetricResponse, Integer, Hash)>

Create a span-based metric.

Create a metric based on your ingested spans in your organization. Returns the span-based metric object from the request body when the request is successful.

Parameters:

  • body (SpansMetricCreateRequest) —

    The definition of the new span-based metric.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SpansMetricResponse, Integer, Hash)>) —

    SpansMetricResponse data, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 42

def create_spans_metric_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.create_spans_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 SpansMetricsAPI.create_spans_metric"
  end
  # resource path
  local_var_path = '/api/v2/apm/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] || 'SpansMetricResponse'

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

  new_options = opts.merge(
    :operation => :create_spans_metric,
    :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: SpansMetricsAPI#create_spans_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_spans_metric(metric_id, opts = {}) ⇒ Object

Delete a span-based metric.

See Also:



97
98
99
100
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 97

def delete_spans_metric(metric_id, opts = {})
  delete_spans_metric_with_http_info(metric_id, opts)
  nil
end

#delete_spans_metric_with_http_info(metric_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a span-based metric.

Delete a specific span-based metric from your organization.

Parameters:

  • metric_id (String) —

    The name of the span-based metric.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 109

def delete_spans_metric_with_http_info(metric_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.delete_spans_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 SpansMetricsAPI.delete_spans_metric"
  end
  # resource path
  local_var_path = '/api/v2/apm/config/metrics/{metric_id}'.sub('{metric_id}', CGI.escape(metric_id.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

  # 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_spans_metric,
    :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::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SpansMetricsAPI#delete_spans_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_spans_metric(metric_id, opts = {}) ⇒ Object

Get a span-based metric.

See Also:



162
163
164
165
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 162

def get_spans_metric(metric_id, opts = {})
  data, _status_code, _headers = get_spans_metric_with_http_info(metric_id, opts)
  data
end

#get_spans_metric_with_http_info(metric_id, opts = {}) ⇒ Array<(SpansMetricResponse, Integer, Hash)>

Get a span-based metric.

Get a specific span-based metric from your organization.

Parameters:

  • metric_id (String) —

    The name of the span-based metric.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SpansMetricResponse, Integer, Hash)>) —

    SpansMetricResponse data, response status code and response headers



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 174

def get_spans_metric_with_http_info(metric_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.get_spans_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 SpansMetricsAPI.get_spans_metric"
  end
  # resource path
  local_var_path = '/api/v2/apm/config/metrics/{metric_id}'.sub('{metric_id}', CGI.escape(metric_id.to_s).gsub('%2F', '/'))

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

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

  new_options = opts.merge(
    :operation => :get_spans_metric,
    :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: SpansMetricsAPI#get_spans_metric\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_spans_metrics(opts = {}) ⇒ Object

Get all span-based metrics.

See Also:



227
228
229
230
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 227

def list_spans_metrics(opts = {})
  data, _status_code, _headers = list_spans_metrics_with_http_info(opts)
  data
end

#list_spans_metrics_with_http_info(opts = {}) ⇒ Array<(SpansMetricsResponse, Integer, Hash)>

Get all span-based metrics.

Get the list of configured span-based metrics with their definitions.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SpansMetricsResponse, Integer, Hash)>) —

    SpansMetricsResponse data, response status code and response headers



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 238

def list_spans_metrics_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.list_spans_metrics ...'
  end
  # resource path
  local_var_path = '/api/v2/apm/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] || 'SpansMetricsResponse'

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

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

#update_spans_metric(metric_id, body, opts = {}) ⇒ Object

Update a span-based metric.

See Also:



287
288
289
290
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 287

def update_spans_metric(metric_id, body, opts = {})
  data, _status_code, _headers = update_spans_metric_with_http_info(metric_id, body, opts)
  data
end

#update_spans_metric_with_http_info(metric_id, body, opts = {}) ⇒ Array<(SpansMetricResponse, Integer, Hash)>

Update a span-based metric.

Update a specific span-based metric from your organization. Returns the span-based metric object from the request body when the request is successful.

Parameters:

  • metric_id (String) —

    The name of the span-based metric.

  • body (SpansMetricUpdateRequest) —

    New definition of the span-based metric.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SpansMetricResponse, Integer, Hash)>) —

    SpansMetricResponse data, response status code and response headers



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/datadog_api_client/v2/api/spans_metrics_api.rb', line 301

def update_spans_metric_with_http_info(metric_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpansMetricsAPI.update_spans_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 SpansMetricsAPI.update_spans_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 SpansMetricsAPI.update_spans_metric"
  end
  # resource path
  local_var_path = '/api/v2/apm/config/metrics/{metric_id}'.sub('{metric_id}', CGI.escape(metric_id.to_s).gsub('%2F', '/'))

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

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

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