Class: DatadogAPIClient::V2::SpansAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of SpansAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/spans_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_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Aggregate spans.

See Also:



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

def aggregate_spans(body, opts = {})
  data, _status_code, _headers = aggregate_spans_with_http_info(body, opts)
  data
end

#aggregate_spans_with_http_info(body, opts = {}) ⇒ Array<(SpansAggregateResponse, Integer, Hash)>

Aggregate spans.

The API endpoint to aggregate spans into buckets and compute metrics and timeseries. This endpoint is rate limited to ‘300` requests per hour.

Parameters:

Returns:

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

    SpansAggregateResponse 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_api.rb', line 42

def aggregate_spans_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpansAPI.aggregate_spans ...'
  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 SpansAPI.aggregate_spans"
  end
  # resource path
  local_var_path = '/api/v2/spans/analytics/aggregate'

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

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

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

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

Search spans.

See Also:



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

def list_spans(body, opts = {})
  data, _status_code, _headers = list_spans_with_http_info(body, opts)
  data
end

#list_spans_get(opts = {}) ⇒ Object

Get a list of spans.

See Also:



191
192
193
194
 
# File 'lib/datadog_api_client/v2/api/spans_api.rb', line 191

def list_spans_get(opts = {})
  data, _status_code, _headers = list_spans_get_with_http_info(opts)
  data
end

#list_spans_get_with_http_info(opts = {}) ⇒ Array<(SpansListResponse, Integer, Hash)>

Get a list of spans.

List endpoint returns spans that match a span search query. [Results are paginated].

Use this endpoint to see your latest spans. This endpoint is rate limited to ‘300` requests per hour.

[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_query (String) —

    Search query following spans syntax.

  • :filter_from (String) —

    Minimum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).

  • :filter_to (String) —

    Maximum timestamp for requested spans. Supports date-time ISO8601, date math, and regular timestamps (milliseconds).

  • :sort (SpansSort) —

    Order of spans in results.

  • :page_cursor (String) —

    List following results with a cursor provided in the previous query.

  • :page_limit (Integer) —

    Maximum number of spans in the response.

Returns:

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

    SpansListResponse data, response status code and response headers



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
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
 
# File 'lib/datadog_api_client/v2/api/spans_api.rb', line 214

def list_spans_get_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpansAPI.list_spans_get ...'
  end
  allowable_values = ['timestamp', '-timestamp']
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling SpansAPI.list_spans_get, must be smaller than or equal to 1000.'
  end
  # resource path
  local_var_path = '/api/v2/spans/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil?
  query_params[:'filter[from]'] = opts[:'filter_from'] if !opts[:'filter_from'].nil?
  query_params[:'filter[to]'] = opts[:'filter_to'] if !opts[:'filter_to'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].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] || 'SpansListResponse'

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

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

#list_spans_get_with_pagination(opts = {}) {|Span| ... } ⇒ Object

Get a list of spans.

Provide a paginated version of #list_spans_get, returning all items.

To use it you need to use a block: list_spans_get_with_pagination { |item| p item }

Yields:

  • (Span) —

    Paginated items



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/datadog_api_client/v2/api/spans_api.rb', line 280

def list_spans_get_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "page_limit", 10)
    @api_client.set_attribute_from_path(api_version, opts, "page_limit", Integer, page_size)
    while true do
        response = list_spans_get(opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, opts, "page_cursor", String, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end

#list_spans_with_http_info(body, opts = {}) ⇒ Array<(SpansListResponse, Integer, Hash)>

Search spans.

List endpoint returns spans that match a span search query. [Results are paginated].

Use this endpoint to build complex spans filtering and search. This endpoint is rate limited to ‘300` requests per hour.

[1]: /logs/guide/collect-multiple-logs-with-pagination?tab=v2api

Parameters:

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

    the optional parameters

Returns:

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

    SpansListResponse data, response status code and response headers



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
158
159
160
161
162
163
164
165
 
# File 'lib/datadog_api_client/v2/api/spans_api.rb', line 115

def list_spans_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SpansAPI.list_spans ...'
  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 SpansAPI.list_spans"
  end
  # resource path
  local_var_path = '/api/v2/spans/events/search'

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

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

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

#list_spans_with_pagination(body, opts = {}) {|Span| ... } ⇒ Object

Search spans.

Provide a paginated version of #list_spans, returning all items.

To use it you need to use a block: list_spans_with_pagination { |item| p item }

Yields:

  • (Span) —

    Paginated items



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/datadog_api_client/v2/api/spans_api.rb', line 174

def list_spans_with_pagination(body, opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(body, "data.attributes.page.limit", 10)
    @api_client.set_attribute_from_path(api_version, body, "data.attributes.page.limit", SpansListRequestData, page_size)
    while true do
        response = list_spans(body, opts)
        @api_client.get_attribute_from_path(response, "data").each { |item| yield(item) }
        if @api_client.get_attribute_from_path(response, "data").length < page_size
          break
        end
        @api_client.set_attribute_from_path(api_version, body, "data.attributes.page.cursor", SpansListRequestData, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end