Class: DatadogAPIClient::V2::DORAMetricsAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V2::DORAMetricsAPI
- Defined in:
- lib/datadog_api_client/v2/api/dora_metrics_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_dora_deployment(body, opts = {}) ⇒ Object
Send a deployment event for DORA Metrics.
-
#create_dora_deployment_with_http_info(body, opts = {}) ⇒ Array<(DORADeploymentResponse, Integer, Hash)>
Send a deployment event for DORA Metrics.
-
#create_dora_failure(body, opts = {}) ⇒ Object
Send a failure event for DORA Metrics.
-
#create_dora_failure_with_http_info(body, opts = {}) ⇒ Array<(DORAFailureResponse, Integer, Hash)>
Send a failure event for DORA Metrics.
-
#create_dora_incident(body, opts = {}) ⇒ Object
Send an incident event for DORA Metrics.
-
#create_dora_incident_with_http_info(body, opts = {}) ⇒ Array<(DORAFailureResponse, Integer, Hash)>
deprecated
Deprecated.
This API is deprecated.
-
#get_dora_deployment(deployment_id, opts = {}) ⇒ Object
Get a deployment event.
-
#get_dora_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(DORAFetchResponse, Integer, Hash)>
Get a deployment event.
-
#get_dora_failure(failure_id, opts = {}) ⇒ Object
Get a failure event.
-
#get_dora_failure_with_http_info(failure_id, opts = {}) ⇒ Array<(DORAFetchResponse, Integer, Hash)>
Get a failure event.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ DORAMetricsAPI
constructor
A new instance of DORAMetricsAPI.
-
#list_dora_deployments(body, opts = {}) ⇒ Object
Get a list of deployment events.
-
#list_dora_deployments_with_http_info(body, opts = {}) ⇒ Array<(DORAListResponse, Integer, Hash)>
Get a list of deployment events.
-
#list_dora_failures(body, opts = {}) ⇒ Object
Get a list of failure events.
-
#list_dora_failures_with_http_info(body, opts = {}) ⇒ Array<(DORAListResponse, Integer, Hash)>
Get a list of failure events.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ DORAMetricsAPI
Returns a new instance of DORAMetricsAPI.
22 23 24 |
# File 'lib/datadog_api_client/v2/api/dora_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/dora_metrics_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#create_dora_deployment(body, opts = {}) ⇒ Object
Send a deployment event for DORA Metrics.
29 30 31 32 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 29 def create_dora_deployment(body, opts = {}) data, _status_code, _headers = create_dora_deployment_with_http_info(body, opts) data end |
#create_dora_deployment_with_http_info(body, opts = {}) ⇒ Array<(DORADeploymentResponse, Integer, Hash)>
Send a deployment event for DORA Metrics.
Use this API endpoint to provide data about deployments for DORA metrics.
This is necessary for:
- Deployment Frequency
- Change Lead Time
- Change Failure Rate
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 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 46 def create_dora_deployment_with_http_info(body, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.create_dora_deployment".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_dora_deployment") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_dora_deployment")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.create_dora_deployment ...' 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 DORAMetricsAPI.create_dora_deployment" end # resource path local_var_path = '/api/v2/dora/deployment' # 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] || 'DORADeploymentResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth] = opts.merge( :operation => :create_dora_deployment, :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: DORAMetricsAPI#create_dora_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_dora_failure(body, opts = {}) ⇒ Object
Send a failure event for DORA Metrics.
101 102 103 104 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 101 def create_dora_failure(body, opts = {}) data, _status_code, _headers = create_dora_failure_with_http_info(body, opts) data end |
#create_dora_failure_with_http_info(body, opts = {}) ⇒ Array<(DORAFailureResponse, Integer, Hash)>
Send a failure event for DORA Metrics.
Use this API endpoint to provide failure data for DORA metrics.
This is necessary for:
- Change Failure Rate
- Time to Restore
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 166 167 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 117 def create_dora_failure_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.create_dora_failure ...' 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 DORAMetricsAPI.create_dora_failure" end # resource path local_var_path = '/api/v2/dora/failure' # 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] || 'DORAFailureResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth] = opts.merge( :operation => :create_dora_failure, :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: DORAMetricsAPI#create_dora_failure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_dora_incident(body, opts = {}) ⇒ Object
Send an incident event for DORA Metrics.
107 108 109 110 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 107 def create_dora_incident(body, opts = {}) data, _status_code, _headers = create_dora_incident_with_http_info(body, opts) data end |
#create_dora_incident_with_http_info(body, opts = {}) ⇒ Array<(DORAFailureResponse, Integer, Hash)>
This API is deprecated.
Send an incident event for DORA Metrics.
Note: This endpoint is deprecated. Please use /api/v2/dora/failure
instead.
Use this API endpoint to provide failure data for DORA metrics.
This is necessary for:
- Change Failure Rate
- Time to Restore
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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 123 def create_dora_incident_with_http_info(body, opts = {}) unstable_enabled = @api_client.config.unstable_operations["v2.create_dora_incident".to_sym] if unstable_enabled @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_dora_incident") else raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_dora_incident")) end if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.create_dora_incident ...' 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 DORAMetricsAPI.create_dora_incident" end # resource path local_var_path = '/api/v2/dora/incident' # 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] || 'DORAIncidentResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth] = opts.merge( :operation => :create_dora_incident, :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: DORAMetricsAPI#create_dora_incident\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_dora_deployment(deployment_id, opts = {}) ⇒ Object
Get a deployment event.
248 249 250 251 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 248 def get_dora_deployment(deployment_id, opts = {}) data, _status_code, _headers = get_dora_deployment_with_http_info(deployment_id, opts) data end |
#get_dora_deployment_with_http_info(deployment_id, opts = {}) ⇒ Array<(DORAFetchResponse, Integer, Hash)>
Get a deployment event.
Use this API endpoint to get a deployment event.
260 261 262 263 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 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 260 def get_dora_deployment_with_http_info(deployment_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.get_dora_deployment ...' end # verify the required parameter 'deployment_id' is set if @api_client.config.client_side_validation && deployment_id.nil? fail ArgumentError, "Missing the required parameter 'deployment_id' when calling DORAMetricsAPI.get_dora_deployment" end # resource path local_var_path = '/api/v2/dora/deployments/{deployment_id}'.sub('{deployment_id}', CGI.escape(deployment_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] || 'DORAFetchResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :get_dora_deployment, :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: DORAMetricsAPI#get_dora_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_dora_failure(failure_id, opts = {}) ⇒ Object
Get a failure event.
313 314 315 316 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 313 def get_dora_failure(failure_id, opts = {}) data, _status_code, _headers = get_dora_failure_with_http_info(failure_id, opts) data end |
#get_dora_failure_with_http_info(failure_id, opts = {}) ⇒ Array<(DORAFetchResponse, Integer, Hash)>
Get a failure event.
Use this API endpoint to get a failure event.
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 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 325 def get_dora_failure_with_http_info(failure_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.get_dora_failure ...' end # verify the required parameter 'failure_id' is set if @api_client.config.client_side_validation && failure_id.nil? fail ArgumentError, "Missing the required parameter 'failure_id' when calling DORAMetricsAPI.get_dora_failure" end # resource path local_var_path = '/api/v2/dora/failures/{failure_id}'.sub('{failure_id}', CGI.escape(failure_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] || 'DORAFetchResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :get_dora_failure, :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: DORAMetricsAPI#get_dora_failure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_dora_deployments(body, opts = {}) ⇒ Object
Get a list of deployment events.
378 379 380 381 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 378 def list_dora_deployments(body, opts = {}) data, _status_code, _headers = list_dora_deployments_with_http_info(body, opts) data end |
#list_dora_deployments_with_http_info(body, opts = {}) ⇒ Array<(DORAListResponse, Integer, Hash)>
Get a list of deployment events.
Use this API endpoint to get a list of deployment events.
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 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 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 390 def list_dora_deployments_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.list_dora_deployments ...' 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 DORAMetricsAPI.list_dora_deployments" end # resource path local_var_path = '/api/v2/dora/deployments' # 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] || 'DORAListResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :list_dora_deployments, :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: DORAMetricsAPI#list_dora_deployments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_dora_failures(body, opts = {}) ⇒ Object
Get a list of failure events.
445 446 447 448 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 445 def list_dora_failures(body, opts = {}) data, _status_code, _headers = list_dora_failures_with_http_info(body, opts) data end |
#list_dora_failures_with_http_info(body, opts = {}) ⇒ Array<(DORAListResponse, Integer, Hash)>
Get a list of failure events.
Use this API endpoint to get a list of failure events.
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 |
# File 'lib/datadog_api_client/v2/api/dora_metrics_api.rb', line 457 def list_dora_failures_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DORAMetricsAPI.list_dora_failures ...' 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 DORAMetricsAPI.list_dora_failures" end # resource path local_var_path = '/api/v2/dora/failures' # 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] || 'DORAListResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth] = opts.merge( :operation => :list_dora_failures, :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: DORAMetricsAPI#list_dora_failures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |