Class: DatadogAPIClient::V2::LogsAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of LogsAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Aggregate events.

See Also:



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

def aggregate_logs(body, opts = {})
  data, _status_code, _headers = aggregate_logs_with_http_info(body, opts)
  data
end

#aggregate_logs_with_http_info(body, opts = {}) ⇒ Array<(LogsAggregateResponse, Integer, Hash)>

Aggregate events.

The API endpoint to aggregate events into buckets and compute metrics and timeseries.

Parameters:

Returns:

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

    LogsAggregateResponse data, response status code and response headers



41
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
 
# File 'lib/datadog_api_client/v2/api/logs_api.rb', line 41

def aggregate_logs_with_http_info(body, opts = {})

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

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

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

#list_logs(opts = {}) ⇒ Object

Search logs.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/logs_api.rb', line 96

def list_logs(opts = {})
  data, _status_code, _headers = list_logs_with_http_info(opts)
  data
end

#list_logs_get(opts = {}) ⇒ Object

Get a list of logs.

See Also:



190
191
192
193
 
# File 'lib/datadog_api_client/v2/api/logs_api.rb', line 190

def list_logs_get(opts = {})
  data, _status_code, _headers = list_logs_get_with_http_info(opts)
  data
end

#list_logs_get_with_http_info(opts = {}) ⇒ Array<(LogsListResponse, Integer, Hash)>

Get a list of logs.

List endpoint returns logs that match a log search query. [Results are paginated].

Use this endpoint to see your latest logs.

**If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation].**

[1]: /logs/guide/collect-multiple-logs-with-pagination [2]: docs.datadoghq.com/logs/archives

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_query (String) —

    Search query following logs syntax.

  • :filter_indexes (Array<String>) —

    For customers with multiple indexes, the indexes to search. Defaults to ‘*’ which means all indexes

  • :filter_from (Time) —

    Minimum timestamp for requested logs.

  • :filter_to (Time) —

    Maximum timestamp for requested logs.

  • :filter_storage_tier (LogsStorageTier) —

    Specifies the storage type to be used

  • :sort (LogsSort) —

    Order of logs in results.

  • :page_cursor (String) —

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

  • :page_limit (Integer) —

    Maximum number of logs in the response.

Returns:

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

    LogsListResponse data, response status code and response headers



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
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/datadog_api_client/v2/api/logs_api.rb', line 219

def list_logs_get_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsAPI.list_logs_get ...'
  end
  allowable_values = ['indexes', 'online-archives', 'flex']
  if @api_client.config.client_side_validation && opts[:'filter_storage_tier'] && !allowable_values.include?(opts[:'filter_storage_tier'])
    fail ArgumentError, "invalid value for \"filter_storage_tier\", must be one of #{allowable_values}"
  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 LogsAPI.list_logs_get, must be smaller than or equal to 1000.'
  end
  # resource path
  local_var_path = '/api/v2/logs/events'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil?
  query_params[:'filter[indexes]'] = @api_client.build_collection_param(opts[:'filter_indexes'], :csv) if !opts[:'filter_indexes'].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[:'filter[storage_tier]'] = opts[:'filter_storage_tier'] if !opts[:'filter_storage_tier'].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] || 'LogsListResponse'

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

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

#list_logs_get_with_pagination(opts = {}) {|Log| ... } ⇒ Object

Get a list of logs.

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

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

Yields:

  • (Log) —

    Paginated items



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/datadog_api_client/v2/api/logs_api.rb', line 291

def list_logs_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_logs_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_logs_with_http_info(opts = {}) ⇒ Array<(LogsListResponse, Integer, Hash)>

Search logs.

List endpoint returns logs that match a log search query. [Results are paginated].

Use this endpoint to build complex logs filtering and search.

**If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation].**

[1]: /logs/guide/collect-multiple-logs-with-pagination [2]: docs.datadoghq.com/logs/archives

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    LogsListResponse data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v2/api/logs_api.rb', line 118

def list_logs_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsAPI.list_logs ...'
  end
  # resource path
  local_var_path = '/api/v2/logs/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(opts[:'body'])

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

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

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

#list_logs_with_pagination(opts = {}) {|Log| ... } ⇒ Object

Search logs.

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

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

Yields:

  • (Log) —

    Paginated items



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

def list_logs_with_pagination(opts = {})
    api_version = "V2"
    page_size = @api_client.get_attribute_from_path(opts, "body.page.limit", 10)
    @api_client.set_attribute_from_path(api_version, opts, "body.page.limit", LogsListRequest, page_size)
    while true do
        response = list_logs(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, "body.page.cursor", LogsListRequest, @api_client.get_attribute_from_path(response, "meta.page.after"))
    end
end

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

Send logs.

See Also:



308
309
310
311
 
# File 'lib/datadog_api_client/v2/api/logs_api.rb', line 308

def submit_log(body, opts = {})
  data, _status_code, _headers = submit_log_with_http_info(body, opts)
  data
end

#submit_log_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Send logs.

Send your logs to your Datadog platform over HTTP. Limits per HTTP request are:

  • Maximum content size per payload (uncompressed): 5MB

  • Maximum size for a single log: 1MB

  • Maximum array size if sending multiple logs in an array: 1000 entries

Any log exceeding 1MB is accepted and truncated by Datadog:

  • For a single log request, the API truncates the log at 1MB and returns a 2xx.

  • For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx.

Datadog recommends sending your logs compressed. Add the ‘Content-Encoding: gzip` header to the request when sending compressed logs. Log events can be submitted with a timestamp that is up to 18 hours in the past.

The status codes answered by the HTTP API are:

  • 202: Accepted: the request has been accepted for processing

  • 400: Bad request (likely an issue in the payload formatting)

  • 401: Unauthorized (likely a missing API Key)

  • 403: Permission issue (likely using an invalid API Key)

  • 408: Request Timeout, request should be retried after some time

  • 413: Payload too large (batch is above 5MB uncompressed)

  • 429: Too Many Requests, request should be retried after some time

  • 500: Internal Server Error, the server encountered an unexpected condition that prevented it from fulfilling the request, request should be retried after some time

  • 503: Service Unavailable, the server is not ready to handle the request probably because it is overloaded, request should be retried after some time

Parameters:

  • body (Array<HTTPLogItem>) —

    Log to send (JSON format).

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

    the optional parameters

Options Hash (opts):

  • :content_encoding (ContentEncoding) —

    HTTP header used to compress the media-type.

  • :ddtags (String) —

    Log tags can be passed as query parameters with ‘text/plain` content type.

Returns:

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

    Object data, response status code and response headers



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/datadog_api_client/v2/api/logs_api.rb', line 345

def submit_log_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LogsAPI.submit_log ...'
  end
  allowable_values = ['identity', 'gzip', '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 LogsAPI.submit_log"
  end
  # resource path
  local_var_path = '/api/v2/logs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ddtags'] = opts[:'ddtags'] if !opts[:'ddtags'].nil?

  # 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', 'application/logplex-1', 'text/plain'])
  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] || 'Object'

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

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