Class: DatadogAPIClient::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



162
163
164
165
166
167
168
169
170
171
172
173
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
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
 
# File 'lib/datadog_api_client/configuration.rb', line 162

def initialize
  @scheme = 'https'
  @host = 'api.datadoghq.com'
  @base_path = ''
  @server_index = 0
  @server_operation_index = {}
  @server_variables = {}
  @server_operation_variables = {}
  @api_key = {}
  @api_key_prefix = {}
  @enable_retry = false
  @backoff_base = 2
  @backoff_multiplier = 2
  @max_retries = 3
  @timeout = nil
  @client_side_validation = true
  @verify_ssl = true
  @verify_ssl_host = true
  @cert_file = nil
  @key_file = nil
  @debugging = false
  @inject_format = false
  @force_ending_format = false
  @compress = true
  @http_proxyaddr = nil
  @http_proxyport = nil
  @http_proxyuser = nil
  @http_proxypass = nil
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
  @unstable_operations = {
        "v2.create_open_api": false,
        "v2.delete_open_api": false,
        "v2.get_open_api": false,
        "v2.list_apis": false,
        "v2.update_open_api": false,
        "v2.get_active_billing_dimensions": false,
        "v2.get_billing_dimension_mapping": false,
        "v2.get_monthly_cost_attribution": false,
        "v2.create_dora_deployment": false,
        "v2.create_dora_incident": false,
        "v2.create_incident": false,
        "v2.create_incident_integration": false,
        "v2.create_incident_todo": false,
        "v2.create_incident_type": false,
        "v2.delete_incident": false,
        "v2.delete_incident_integration": false,
        "v2.delete_incident_todo": false,
        "v2.delete_incident_type": false,
        "v2.get_incident": false,
        "v2.get_incident_integration": false,
        "v2.get_incident_todo": false,
        "v2.get_incident_type": false,
        "v2.list_incident_attachments": false,
        "v2.list_incident_integrations": false,
        "v2.list_incidents": false,
        "v2.list_incident_todos": false,
        "v2.list_incident_types": false,
        "v2.search_incidents": false,
        "v2.update_incident": false,
        "v2.update_incident_attachments": false,
        "v2.update_incident_integration": false,
        "v2.update_incident_todo": false,
        "v2.update_incident_type": false,
        "v2.get_finding": false,
        "v2.list_findings": false,
        "v2.mute_findings": false,
        "v2.create_scorecard_outcomes_batch": false,
        "v2.create_scorecard_rule": false,
        "v2.delete_scorecard_rule": false,
        "v2.list_scorecard_outcomes": false,
        "v2.list_scorecard_rules": false,
        "v2.update_scorecard_rule": false,
        "v2.create_incident_service": false,
        "v2.delete_incident_service": false,
        "v2.get_incident_service": false,
        "v2.list_incident_services": false,
        "v2.update_incident_service": false,
        "v2.create_slo_report_job": false,
        "v2.get_slo_report": false,
        "v2.get_slo_report_job_status": false,
        "v2.create_incident_team": false,
        "v2.delete_incident_team": false,
        "v2.get_incident_team": false,
        "v2.list_incident_teams": false,
        "v2.update_incident_team": false,
  }
  @server_variables[:site] = ENV['DD_SITE'] if ENV.key? 'DD_SITE'
  @api_key['apiKeyAuth'] = ENV['DD_API_KEY'] if ENV.key? 'DD_API_KEY'
  @api_key['appKeyAuth'] = ENV['DD_APP_KEY'] if ENV.key? 'DD_APP_KEY'

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



66
67
68
 
# File 'lib/datadog_api_client/configuration.rb', line 66

def access_token
  @access_token
end

#api_key ⇒ Hash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • (Hash) —

    key: parameter name, value: parameter value (API key)



45
46
47
 
# File 'lib/datadog_api_client/configuration.rb', line 45

def api_key
  @api_key
end

#api_key_prefix ⇒ Hash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • (Hash) —

    key: parameter name, value: API key prefix



53
54
55
 
# File 'lib/datadog_api_client/configuration.rb', line 53

def api_key_prefix
  @api_key_prefix
end

#backoff_base ⇒ Object

Retry backoff calculation parameters



156
157
158
 
# File 'lib/datadog_api_client/configuration.rb', line 156

def backoff_base
  @backoff_base
end

#backoff_multiplier ⇒ Object

Returns the value of attribute backoff_multiplier.



157
158
159
 
# File 'lib/datadog_api_client/configuration.rb', line 157

def backoff_multiplier
  @backoff_multiplier
end

#base_path ⇒ Object

Defines url base path



25
26
27
 
# File 'lib/datadog_api_client/configuration.rb', line 25

def base_path
  @base_path
end

#cert_file ⇒ Object

TLS/SSL setting Client certificate file (for client certificate)



126
127
128
 
# File 'lib/datadog_api_client/configuration.rb', line 126

def cert_file
  @cert_file
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false) 


95
96
97
 
# File 'lib/datadog_api_client/configuration.rb', line 95

def client_side_validation
  @client_side_validation
end

#compress ⇒ Object

Set this to add accept encoding header for compression



137
138
139
 
# File 'lib/datadog_api_client/configuration.rb', line 137

def compress
  @compress
end

#debugging ⇒ true, false

Set this to enable/disable debugging. When enabled (set to true), HTTP request/response details will be logged with ‘logger.debug` (see the `logger` attribute). Default to false.

Returns:

  • (true, false) 


73
74
75
 
# File 'lib/datadog_api_client/configuration.rb', line 73

def debugging
  @debugging
end

#enable_retry ⇒ Object

Enable retry when rate limited



153
154
155
 
# File 'lib/datadog_api_client/configuration.rb', line 153

def enable_retry
  @enable_retry
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



134
135
136
 
# File 'lib/datadog_api_client/configuration.rb', line 134

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



22
23
24
 
# File 'lib/datadog_api_client/configuration.rb', line 22

def host
  @host
end

#http_proxyaddr ⇒ Object

Proxy settings Address of proxy server to use



141
142
143
 
# File 'lib/datadog_api_client/configuration.rb', line 141

def http_proxyaddr
  @http_proxyaddr
end

#http_proxypass ⇒ Object

Password for proxy server authentication



150
151
152
 
# File 'lib/datadog_api_client/configuration.rb', line 150

def http_proxypass
  @http_proxypass
end

#http_proxyport ⇒ Object

Port of proxy server to use



144
145
146
 
# File 'lib/datadog_api_client/configuration.rb', line 144

def http_proxyport
  @http_proxyport
end

#http_proxyuser ⇒ Object

User for proxy server authentication



147
148
149
 
# File 'lib/datadog_api_client/configuration.rb', line 147

def http_proxyuser
  @http_proxyuser
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



132
133
134
 
# File 'lib/datadog_api_client/configuration.rb', line 132

def inject_format
  @inject_format
end

#key_file ⇒ Object

TLS/SSL setting Client private key file (for client certificate)



130
131
132
 
# File 'lib/datadog_api_client/configuration.rb', line 130

def key_file
  @key_file
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

Returns:

  • (#debug) 


79
80
81
 
# File 'lib/datadog_api_client/configuration.rb', line 79

def logger
  @logger
end

#max_retries ⇒ Object

Maximum number of retry attempts allowed



160
161
162
 
# File 'lib/datadog_api_client/configuration.rb', line 160

def max_retries
  @max_retries
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


63
64
65
 
# File 'lib/datadog_api_client/configuration.rb', line 63

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



19
20
21
 
# File 'lib/datadog_api_client/configuration.rb', line 19

def scheme
  @scheme
end

#server_index ⇒ Object

Define server configuration index



28
29
30
 
# File 'lib/datadog_api_client/configuration.rb', line 28

def server_index
  @server_index
end

#server_operation_index ⇒ Object

Define server operation configuration index



31
32
33
 
# File 'lib/datadog_api_client/configuration.rb', line 31

def server_operation_index
  @server_operation_index
end

#server_operation_variables ⇒ Object

Default server operation variables



37
38
39
 
# File 'lib/datadog_api_client/configuration.rb', line 37

def server_operation_variables
  @server_operation_variables
end

#server_variables ⇒ Object

Default server variables



34
35
36
 
# File 'lib/datadog_api_client/configuration.rb', line 34

def server_variables
  @server_variables
end

#ssl_ca_cert ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

Returns:

  • (String) —

    the path to the certificate file



122
123
124
 
# File 'lib/datadog_api_client/configuration.rb', line 122

def ssl_ca_cert
  @ssl_ca_cert
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

Returns:

  • (String) 


86
87
88
 
# File 'lib/datadog_api_client/configuration.rb', line 86

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to 0 (never times out).



90
91
92
 
# File 'lib/datadog_api_client/configuration.rb', line 90

def timeout
  @timeout
end

#unstable_operations ⇒ Object

Keep track of the unstable operations, and if they have been enabled



98
99
100
 
# File 'lib/datadog_api_client/configuration.rb', line 98

def unstable_operations
  @unstable_operations
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


58
59
60
 
# File 'lib/datadog_api_client/configuration.rb', line 58

def username
  @username
end

#verify_ssl ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server. Default to true.

Returns:

  • (true, false) 


107
108
109
 
# File 'lib/datadog_api_client/configuration.rb', line 107

def verify_ssl
  @verify_ssl
end

#verify_ssl_host ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL host name Default to true.

Returns:

  • (true, false) 


116
117
118
 
# File 'lib/datadog_api_client/configuration.rb', line 116

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.default ⇒ Object

The default Configuration object.



256
257
258
 
# File 'lib/datadog_api_client/configuration.rb', line 256

def self.default
  @@default ||= Configuration.new
end

Instance Method Details

#api_key_with_prefix(param_name, param_alias = nil) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



297
298
299
300
301
302
303
304
305
 
# File 'lib/datadog_api_client/configuration.rb', line 297

def api_key_with_prefix(param_name, param_alias = nil)
  key = @api_key[param_name]
  key = @api_key.fetch(param_alias, key) unless param_alias.nil?
  if @api_key_prefix[param_name]
    "#{@api_key_prefix[param_name]} #{key}"
  else
    key
  end
end

#application_key=(app_key) ⇒ Object

Sets application key.



313
314
315
 
# File 'lib/datadog_api_client/configuration.rb', line 313

def application_key=(app_key)
  @api_key['appKeyAuth'] = app_key
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



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
 
# File 'lib/datadog_api_client/configuration.rb', line 323

def auth_settings
  {
    AuthZ:
      {
        type: 'oauth2',
        in: 'header',
        key: 'Authorization',
        value: "Bearer #{access_token}"
      },
    apiKeyAuth:
      {
        type: 'api_key',
        in: 'header',
        key: 'DD-API-KEY',
        value: api_key_with_prefix('apiKeyAuth')
      },
    appKeyAuth:
      {
        type: 'api_key',
        in: 'header',
        key: 'DD-APPLICATION-KEY',
        value: api_key_with_prefix('appKeyAuth')
      },
  }
end

#base_url(operation = nil) ⇒ Object

Returns base URL for specified operation based on server settings



288
289
290
291
292
293
 
# File 'lib/datadog_api_client/configuration.rb', line 288

def base_url(operation = nil)
  index = server_operation_index.fetch(operation.to_sym, server_index)
  return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil

  server_url(index, server_operation_variables.fetch(operation.to_sym, server_variables), operation_server_settings[operation.to_sym])
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



318
319
320
 
# File 'lib/datadog_api_client/configuration.rb', line 318

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

#configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



267
268
269
 
# File 'lib/datadog_api_client/configuration.rb', line 267

def configure
  yield(self) if block_given?
end

#operation_server_settings ⇒ Object 



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
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
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
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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/datadog_api_client/configuration.rb', line 405

def operation_server_settings
  {
    "v1.get_ip_ranges": [
      {
        url: "https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The regional site for Datadog customers.",
            default_value: "datadoghq.com",
            enum_values: [
              "datadoghq.com",
              "us3.datadoghq.com",
              "us5.datadoghq.com",
              "ap1.datadoghq.com",
              "datadoghq.eu",
              "ddog-gov.com"
            ]
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "ip-ranges",
          }
        }
      },
      {
        url: "{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "ip-ranges.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: "https://{subdomain}.datadoghq.com",
        description: "No description provided",
        variables: {
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "ip-ranges",
          }
        }
      }  
    ],
    "v1.submit_log": [
      {
        url: "https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The regional site for Datadog customers.",
            default_value: "datadoghq.com",
            enum_values: [
              "datadoghq.com",
              "us3.datadoghq.com",
              "us5.datadoghq.com",
              "ap1.datadoghq.com",
              "datadoghq.eu",
              "ddog-gov.com"
            ]
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "http-intake.logs",
          }
        }
      },
      {
        url: "{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "http-intake.logs.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: "https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "http-intake.logs",
          }
        }
      }  
    ],
    "v2.submit_log": [
      {
        url: "https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "The regional site for customers.",
            default_value: "datadoghq.com",
            enum_values: [
              "datadoghq.com",
              "us3.datadoghq.com",
              "us5.datadoghq.com",
              "ap1.datadoghq.com",
              "datadoghq.eu",
              "ddog-gov.com"
            ]
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "http-intake.logs",
          }
        }
      },
      {
        url: "{protocol}://{name}",
        description: "No description provided",
        variables: {
          name: {
            description: "Full site DNS name.",
            default_value: "http-intake.logs.datadoghq.com",
          },
          protocol: {
            description: "The protocol for accessing the API.",
            default_value: "https",
          }
        }
      },
      {
        url: "https://{subdomain}.{site}",
        description: "No description provided",
        variables: {
          site: {
            description: "Any Datadog deployment.",
            default_value: "datadoghq.com",
          },
          subdomain: {
            description: "The subdomain where the API is deployed.",
            default_value: "http-intake.logs",
          }
        }
      }  
    ],
  }
end

#server_settings ⇒ Object

Returns an array of Server setting



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
402
403
 
# File 'lib/datadog_api_client/configuration.rb', line 350

def server_settings
  [
    {
      url: "https://{subdomain}.{site}",
      description: "No description provided",
      variables: {
        site: {
          description: "The regional site for Datadog customers.",
          default_value: "datadoghq.com",
          enum_values: [
            "datadoghq.com",
            "us3.datadoghq.com",
            "us5.datadoghq.com",
            "ap1.datadoghq.com",
            "datadoghq.eu",
            "ddog-gov.com"
          ]
        },
        subdomain: {
          description: "The subdomain where the API is deployed.",
          default_value: "api",
        }
      }
    },
    {
      url: "{protocol}://{name}",
      description: "No description provided",
      variables: {
        name: {
          description: "Full site DNS name.",
          default_value: "api.datadoghq.com",
        },
        protocol: {
          description: "The protocol for accessing the API.",
          default_value: "https",
        }
      }
    },
    {
      url: "https://{subdomain}.{site}",
      description: "No description provided",
      variables: {
        site: {
          description: "Any Datadog deployment.",
          default_value: "datadoghq.com",
        },
        subdomain: {
          description: "The subdomain where the API is deployed.",
          default_value: "api",
        }
      }
    }
  ]
end

#server_url(index, variables = {}, servers = nil) ⇒ Object

Returns URL based on server settings

Parameters:

  • index —

    array index of the server settings

  • variables (defaults to: {}) —

    hash of variable and the corresponding value



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/datadog_api_client/configuration.rb', line 566

def server_url(index, variables = {}, servers = nil)
  servers = server_settings if servers == nil

  # check array index out of bound
  if (index < 0 || index >= servers.size)
    fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
  end

  server = servers[index]
  url = server[:url]

  return url unless server.key? :variables

  # go through variable and assign a value
  server[:variables].each do |name, variable|
    if variables.key?(name)
      if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
        url.gsub! "{" + name.to_s + "}", variables[name]
      else
        fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
      end
    else
      # use default value
      url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
    end
  end

  url
end