Class: DatadogAPIClient::V2::ErrorTrackingAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::ErrorTrackingAPI
- Defined in:
- lib/datadog_api_client/v2/api/error_tracking_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_issue_assignee(issue_id, opts = {}) ⇒ Object
Remove the assignee of an issue.
-
#delete_issue_assignee_with_http_info(issue_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Remove the assignee of an issue.
-
#get_issue(issue_id, opts = {}) ⇒ Object
Get the details of an error tracking issue.
-
#get_issue_impact(issue_id, filter_from, filter_to, opts = {}) ⇒ Object
Get the impact of an error tracking issue.
-
#get_issue_impact_with_http_info(issue_id, filter_from, filter_to, opts = {}) ⇒ Array<(IssueImpactResponse, Integer, Hash)>
Get the impact of an error tracking issue.
-
#get_issue_with_http_info(issue_id, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>
Get the details of an error tracking issue.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ ErrorTrackingAPI
constructor
A new instance of ErrorTrackingAPI.
-
#search_issues(body, opts = {}) ⇒ Object
Search error tracking issues.
-
#search_issues_with_http_info(body, opts = {}) ⇒ Array<(IssuesSearchResponse, Integer, Hash)>
Search error tracking issues.
-
#snooze_issue(issue_id, body, opts = {}) ⇒ Object
Snooze an issue.
-
#snooze_issue_with_http_info(issue_id, body, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>
Snooze an issue.
-
#update_issue_assignee(issue_id, body, opts = {}) ⇒ Object
Update the assignee of an issue.
-
#update_issue_assignee_with_http_info(issue_id, body, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>
Update the assignee of an issue.
-
#update_issue_state(issue_id, body, opts = {}) ⇒ Object
Update the state of an issue.
-
#update_issue_state_with_http_info(issue_id, body, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>
Update the state of an issue.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ ErrorTrackingAPI
Returns a new instance of ErrorTrackingAPI.
22 23 24 |
# File 'lib/datadog_api_client/v2/api/error_tracking_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/error_tracking_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#delete_issue_assignee(issue_id, opts = {}) ⇒ Object
Remove the assignee of an issue.
29 30 31 32 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 29 def delete_issue_assignee(issue_id, opts = {}) delete_issue_assignee_with_http_info(issue_id, opts) nil end |
#delete_issue_assignee_with_http_info(issue_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Remove the assignee of an issue.
Remove the assignee of an issue by issue_id.
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 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 41 def delete_issue_assignee_with_http_info(issue_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.delete_issue_assignee ...' end # verify the required parameter 'issue_id' is set if @api_client.config.client_side_validation && issue_id.nil? fail ArgumentError, "Missing the required parameter 'issue_id' when calling ErrorTrackingAPI.delete_issue_assignee" end # resource path local_var_path = '/api/v2/error-tracking/issues/{issue_id}/assignee'.sub('{issue_id}', CGI.escape(issue_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, :AuthZ] = opts.merge( :operation => :delete_issue_assignee, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ErrorTrackingAPI#delete_issue_assignee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_issue(issue_id, opts = {}) ⇒ Object
Get the details of an error tracking issue.
94 95 96 97 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 94 def get_issue(issue_id, opts = {}) data, _status_code, _headers = get_issue_with_http_info(issue_id, opts) data end |
#get_issue_impact(issue_id, filter_from, filter_to, opts = {}) ⇒ Object
Get the impact of an error tracking issue.
164 165 166 167 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 164 def get_issue_impact(issue_id, filter_from, filter_to, opts = {}) data, _status_code, _headers = get_issue_impact_with_http_info(issue_id, filter_from, filter_to, opts) data end |
#get_issue_impact_with_http_info(issue_id, filter_from, filter_to, opts = {}) ⇒ Array<(IssueImpactResponse, Integer, Hash)>
Get the impact of an error tracking issue.
Get an issue's impact over a time window: its error counts by source, and the users, sessions, accounts,
RUM views, and endpoints it affects most.
Returns 403 if the caller lacks the error_tracking_read permission or does not have access to the issue's
data.
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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 181 def get_issue_impact_with_http_info(issue_id, filter_from, filter_to, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.get_issue_impact".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_issue_impact") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_issue_impact")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.get_issue_impact ...' end # verify the required parameter 'issue_id' is set if @api_client.config.client_side_validation && issue_id.nil? fail ArgumentError, "Missing the required parameter 'issue_id' when calling ErrorTrackingAPI.get_issue_impact" end # verify the required parameter 'filter_from' is set if @api_client.config.client_side_validation && filter_from.nil? fail ArgumentError, "Missing the required parameter 'filter_from' when calling ErrorTrackingAPI.get_issue_impact" end # verify the required parameter 'filter_to' is set if @api_client.config.client_side_validation && filter_to.nil? fail ArgumentError, "Missing the required parameter 'filter_to' when calling ErrorTrackingAPI.get_issue_impact" end # resource path local_var_path = '/api/v2/error-tracking/issues/{issue_id}/impact'.sub('{issue_id}', CGI.escape(issue_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'filter[from]'] = filter_from query_params[:'filter[to]'] = filter_to # 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] || 'IssueImpactResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :get_issue_impact, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ErrorTrackingAPI#get_issue_impact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_issue_with_http_info(issue_id, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>
Get the details of an error tracking issue.
Retrieve the full details for a specific error tracking issue, including attributes and relationships.
Returns 403 if the caller lacks the error_tracking_read permission or does not have access to the issue's data.
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 158 159 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 109 def get_issue_with_http_info(issue_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.get_issue ...' end # verify the required parameter 'issue_id' is set if @api_client.config.client_side_validation && issue_id.nil? fail ArgumentError, "Missing the required parameter 'issue_id' when calling ErrorTrackingAPI.get_issue" end # resource path local_var_path = '/api/v2/error-tracking/issues/{issue_id}'.sub('{issue_id}', CGI.escape(issue_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].nil? query_params[:'filter[samples.biases]'] = @api_client.build_collection_param(opts[:'filter_samples_biases'], :csv) if !opts[:'filter_samples_biases'].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] || 'IssueResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :get_issue, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ErrorTrackingAPI#get_issue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search_issues(body, opts = {}) ⇒ Object
Search error tracking issues.
250 251 252 253 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 250 def search_issues(body, opts = {}) data, _status_code, _headers = search_issues_with_http_info(body, opts) data end |
#search_issues_with_http_info(body, opts = {}) ⇒ Array<(IssuesSearchResponse, Integer, Hash)>
Search error tracking issues.
Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per issue state.
Returns 400 if neither track nor persona is specified, or if a team_ids value does not match an existing team.
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 264 def search_issues_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.search_issues ...' 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 ErrorTrackingAPI.search_issues" end # resource path local_var_path = '/api/v2/error-tracking/issues/search' # query parameters query_params = opts[:query_params] || {} query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :csv) if !opts[:'include'].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']) # 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] || 'IssuesSearchResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :search_issues, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ErrorTrackingAPI#search_issues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#snooze_issue(issue_id, body, opts = {}) ⇒ Object
Snooze an issue.
320 321 322 323 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 320 def snooze_issue(issue_id, body, opts = {}) data, _status_code, _headers = snooze_issue_with_http_info(issue_id, body, opts) data end |
#snooze_issue_with_http_info(issue_id, body, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>
Snooze an issue.
Snooze an issue by issue_id: move it to IGNORED until a condition is met, then back to OPEN.
The condition can be a number of occurrences, a number of distinct values of an attribute such as @usr.id,
an elapsed time, or any or all of several conditions.
Snoozing an issue that is already snoozed replaces its snooze. Updating the state of the issue with
UpdateIssueState cancels the snooze.
The response includes the watch that reopens the issue.
338 339 340 341 342 343 344 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 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 338 def snooze_issue_with_http_info(issue_id, body, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.snooze_issue".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.snooze_issue") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.snooze_issue")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.snooze_issue ...' end # verify the required parameter 'issue_id' is set if @api_client.config.client_side_validation && issue_id.nil? fail ArgumentError, "Missing the required parameter 'issue_id' when calling ErrorTrackingAPI.snooze_issue" 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 ErrorTrackingAPI.snooze_issue" end # resource path local_var_path = '/api/v2/error-tracking/issues/{issue_id}/snooze'.sub('{issue_id}', CGI.escape(issue_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] || 'IssueResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :snooze_issue, :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ErrorTrackingAPI#snooze_issue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_issue_assignee(issue_id, body, opts = {}) ⇒ Object
Update the assignee of an issue.
403 404 405 406 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 403 def update_issue_assignee(issue_id, body, opts = {}) data, _status_code, _headers = update_issue_assignee_with_http_info(issue_id, body, opts) data end |
#update_issue_assignee_with_http_info(issue_id, body, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>
Update the assignee of an issue.
Update the assignee of an issue by issue_id.
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 416 def update_issue_assignee_with_http_info(issue_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.update_issue_assignee ...' end # verify the required parameter 'issue_id' is set if @api_client.config.client_side_validation && issue_id.nil? fail ArgumentError, "Missing the required parameter 'issue_id' when calling ErrorTrackingAPI.update_issue_assignee" 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 ErrorTrackingAPI.update_issue_assignee" end # resource path local_var_path = '/api/v2/error-tracking/issues/{issue_id}/assignee'.sub('{issue_id}', CGI.escape(issue_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] || 'IssueResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :update_issue_assignee, :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::Put, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ErrorTrackingAPI#update_issue_assignee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_issue_state(issue_id, body, opts = {}) ⇒ Object
Update the state of an issue.
475 476 477 478 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 475 def update_issue_state(issue_id, body, opts = {}) data, _status_code, _headers = update_issue_state_with_http_info(issue_id, body, opts) data end |
#update_issue_state_with_http_info(issue_id, body, opts = {}) ⇒ Array<(IssueResponse, Integer, Hash)>
Update the state of an issue.
Update the state of an issue by issue_id. Use this endpoint to move an issue between states such as OPEN, RESOLVED, or IGNORED.
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
# File 'lib/datadog_api_client/v2/api/error_tracking_api.rb', line 488 def update_issue_state_with_http_info(issue_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ErrorTrackingAPI.update_issue_state ...' end # verify the required parameter 'issue_id' is set if @api_client.config.client_side_validation && issue_id.nil? fail ArgumentError, "Missing the required parameter 'issue_id' when calling ErrorTrackingAPI.update_issue_state" 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 ErrorTrackingAPI.update_issue_state" end # resource path local_var_path = '/api/v2/error-tracking/issues/{issue_id}/state'.sub('{issue_id}', CGI.escape(issue_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] || 'IssueResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :update_issue_state, :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::Put, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ErrorTrackingAPI#update_issue_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |