Class: DatadogAPIClient::V1::MonitorsAPI
- Inherits:
-
Object
- Object
- DatadogAPIClient::V1::MonitorsAPI
- Defined in:
- lib/datadog_api_client/v1/api/monitors_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#check_can_delete_monitor(monitor_ids, opts = {}) ⇒ Object
Check if a monitor can be deleted.
-
#check_can_delete_monitor_with_http_info(monitor_ids, opts = {}) ⇒ Array<(CheckCanDeleteMonitorResponse, Integer, Hash)>
Check if a monitor can be deleted.
-
#create_monitor(body, opts = {}) ⇒ Object
Create a monitor.
-
#create_monitor_with_http_info(body, opts = {}) ⇒ Array<(Monitor, Integer, Hash)>
Create a monitor.
-
#delete_monitor(monitor_id, opts = {}) ⇒ Object
Delete a monitor.
-
#delete_monitor_with_http_info(monitor_id, opts = {}) ⇒ Array<(DeletedMonitor, Integer, Hash)>
Delete a monitor.
-
#get_monitor(monitor_id, opts = {}) ⇒ Object
Get a monitor's details.
-
#get_monitor_with_http_info(monitor_id, opts = {}) ⇒ Array<(Monitor, Integer, Hash)>
Get a monitor's details.
-
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ MonitorsAPI
constructor
A new instance of MonitorsAPI.
-
#list_monitors(opts = {}) ⇒ Object
Get all monitors.
-
#list_monitors_with_http_info(opts = {}) ⇒ Array<(Array<Monitor>, Integer, Hash)>
Get all monitors.
-
#list_monitors_with_pagination(opts = {}) {|Monitor| ... } ⇒ Object
Get all monitors.
-
#search_monitor_groups(opts = {}) ⇒ Object
Monitors group search.
-
#search_monitor_groups_with_http_info(opts = {}) ⇒ Array<(MonitorGroupSearchResponse, Integer, Hash)>
Monitors group search.
-
#search_monitors(opts = {}) ⇒ Object
Monitors search.
-
#search_monitors_with_http_info(opts = {}) ⇒ Array<(MonitorSearchResponse, Integer, Hash)>
Monitors search.
-
#update_monitor(monitor_id, body, opts = {}) ⇒ Object
Edit a monitor.
-
#update_monitor_with_http_info(monitor_id, body, opts = {}) ⇒ Array<(Monitor, Integer, Hash)>
Edit a monitor.
-
#validate_existing_monitor(monitor_id, body, opts = {}) ⇒ Object
Validate an existing monitor.
-
#validate_existing_monitor_with_http_info(monitor_id, body, opts = {}) ⇒ Array<(Object, Integer, Hash)>
Validate an existing monitor.
-
#validate_monitor(body, opts = {}) ⇒ Object
Validate a monitor.
-
#validate_monitor_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>
Validate a monitor.
Constructor Details
#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ MonitorsAPI
Returns a new instance of MonitorsAPI.
22 23 24 |
# File 'lib/datadog_api_client/v1/api/monitors_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/v1/api/monitors_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#check_can_delete_monitor(monitor_ids, opts = {}) ⇒ Object
Check if a monitor can be deleted.
29 30 31 32 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 29 def check_can_delete_monitor(monitor_ids, opts = {}) data, _status_code, _headers = check_can_delete_monitor_with_http_info(monitor_ids, opts) data end |
#check_can_delete_monitor_with_http_info(monitor_ids, opts = {}) ⇒ Array<(CheckCanDeleteMonitorResponse, Integer, Hash)>
Check if a monitor can be deleted.
Check if the given monitors can be deleted.
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 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 41 def check_can_delete_monitor_with_http_info(monitor_ids, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.check_can_delete_monitor ...' end # verify the required parameter 'monitor_ids' is set if @api_client.config.client_side_validation && monitor_ids.nil? fail ArgumentError, "Missing the required parameter 'monitor_ids' when calling MonitorsAPI.check_can_delete_monitor" end # resource path local_var_path = '/api/v1/monitor/can_delete' # query parameters query_params = opts[:query_params] || {} query_params[:'monitor_ids'] = @api_client.build_collection_param(monitor_ids, :csv) # 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] || 'CheckCanDeleteMonitorResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :check_can_delete_monitor, :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 => "V1" ) 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: MonitorsAPI#check_can_delete_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_monitor(body, opts = {}) ⇒ Object
Create a monitor.
95 96 97 98 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 95 def create_monitor(body, opts = {}) data, _status_code, _headers = create_monitor_with_http_info(body, opts) data end |
#create_monitor_with_http_info(body, opts = {}) ⇒ Array<(Monitor, Integer, Hash)>
Create a monitor.
Create a monitor using the specified options.
Monitor Types
The type of monitor chosen from:
- anomaly:
query alert - APM:
query alertortrace-analytics alert - composite:
composite - custom:
service check - forecast:
query alert - host:
service check - integration:
query alertorservice check - live process:
process alert - logs:
log alert - metric:
query alert - network:
service check - outlier:
query alert - process:
service check - rum:
rum alert - SLO:
slo alert - watchdog:
event-v2 alert - event-v2:
event-v2 alert - audit:
audit alert - error-tracking:
error-tracking alert - database-monitoring:
database-monitoring alert - network-performance:
network-performance alert - cloud cost:
cost alert - network-path:
network-path alert
Notes:
- Synthetic monitors are created through the Synthetics API. See the Synthetics API documentation for more information.
- Log monitors require an unscoped App Key.
Query Types
Metric Alert Query
Example: time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #
time_aggr: avg, sum, max, min, change, or pct_changetime_window:last_#m(with#between 1 and 10080 depending on the monitor type) orlast_#h(with#between 1 and 168 depending on the monitor type) orlast_1d, orlast_1wspace_aggr: avg, sum, min, or maxtags: one or more tags (comma-separated), or *key: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert)operator: <, <=, >, >=, ==, or !=#: an integer or decimal number used to set the threshold
To use a dynamic threshold on a metric monitor with a formula query, replace # with the threshold keyword
(for example, ... > threshold) and provide the threshold as a query via critical_query on options.thresholds.
This feature is in preview.
If you are using the _change_ or _pct_change_ time aggregator, instead use change_aggr(time_aggr(time_window),
timeshift):space_aggr:metric{tags} [by {key}] operator # with:
change_aggrchange, pct_changetime_aggravg, sum, max, min Learn moretime_windowlast_#m (between 1 and 2880 depending on the monitor type), last_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2)timeshift#m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago
Use this to create an outlier monitor using the following query:
avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0
Service Check Query
Example: "check".over(tags).last(count).by(group).count_by_status()
checkname of the check, for exampledatadog.agent.uptagsone or more quoted tags (comma-separated), or "*". for example:.over("env:prod", "role:db");overcannot be blank.countmust be at greater than or equal to your max threshold (defined in theoptions). It is limited to 100. For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses,countshould be at least 3.groupmust be specified for check monitors. Per-check grouping is already explicitly known for some service checks. For example, Postgres integration monitors are tagged bydb,host, andport, and Network monitors byhost,instance, andurl. See Service Checks documentation for more information.
Event Alert Query
Note: The Event Alert Query has been replaced by the Event V2 Alert Query. For more information, see the Event Migration guide.
Event V2 Alert Query
Example: events(query).rollup(rollup_method[, measure]).last(time_window) operator #
queryThe search query - following the Log search syntax.rollup_methodThe stats roll-up method - supportscount,avgandcardinality.measureForavgand cardinalityrollup_method- specify the measure or the facet name you want to use.time_window#m (between 1 and 2880), #h (between 1 and 48).operator<,<=,>,>=,==, or!=.#an integer or decimal number used to set the threshold.
Process Alert Query
Example: processes(search).over(tags).rollup('count').last(timeframe) operator #
searchfree text search string for querying processes. Matching processes match results on the Live Processes page.tagsone or more tags (comma-separated)timeframethe timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and doperator<, <=, >, >=, ==, or !=#an integer or decimal number used to set the threshold
Logs Alert Query
Example: logs(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #
queryThe search query - following the Log search syntax.index_nameFor multi-index organizations, the log index in which the request is performed.rollup_methodThe stats roll-up method - supportscount,avgandcardinality.measureForavgand cardinalityrollup_method- specify the measure or the facet name you want to use.time_window#m (between 1 and 2880), #h (between 1 and 48).operator<,<=,>,>=,==, or!=.#an integer or decimal number used to set the threshold.
Composite Query
Example: 12345 && 67890, where 12345 and 67890 are the IDs of non-composite monitors
name[required, default = dynamic, based on query]: The name of the alert.message[required, default = dynamic, based on query]: A message to include with notifications for this monitor. Email notifications can be sent to specific users by using the same '@username' notation as events.tags[optional, default = empty list]: A list of tags to associate with your monitor. When getting all monitor details via the API, use themonitor_tagsargument to filter results by these tags. It is only available via the API and isn't visible or editable in the Datadog UI.
SLO Alert Query
Example: error_budget("slo_id").over("time_window") operator #
slo_id: The alphanumeric SLO ID of the SLO you are configuring the alert for.time_window: The time window of the SLO target you wish to alert on. Valid options:7d,30d,90d.operator:>=or>
Audit Alert Query
Example: audits(query).rollup(rollup_method[, measure]).last(time_window) operator #
queryThe search query - following the Log search syntax.rollup_methodThe stats roll-up method - supportscount,avgandcardinality.measureForavgand cardinalityrollup_method- specify the measure or the facet name you want to use.time_window#m (between 1 and 2880), #h (between 1 and 48).operator<,<=,>,>=,==, or!=.#an integer or decimal number used to set the threshold.
CI Pipelines Alert Query
Example: ci-pipelines(query).rollup(rollup_method[, measure]).last(time_window) operator #
queryThe search query - following the Log search syntax.rollup_methodThe stats roll-up method - supportscount,avg, andcardinality.measureForavgand cardinalityrollup_method- specify the measure or the facet name you want to use.time_window#m (between 1 and 2880), #h (between 1 and 48).operator<,<=,>,>=,==, or!=.#an integer or decimal number used to set the threshold.
CI Tests Alert Query
Example: ci-tests(query).rollup(rollup_method[, measure]).last(time_window) operator #
queryThe search query - following the Log search syntax.rollup_methodThe stats roll-up method - supportscount,avg, andcardinality.measureForavgand cardinalityrollup_method- specify the measure or the facet name you want to use.time_window#m (between 1 and 2880), #h (between 1 and 48).operator<,<=,>,>=,==, or!=.#an integer or decimal number used to set the threshold.
Error Tracking Alert Query
"New issue" example: error-tracking(query).source(issue_source).new().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #
"High impact issue" example: error-tracking(query).source(issue_source).impact().rollup(rollup_method[, measure]).by(group_by).last(time_window) operator #
queryThe search query - following the Log search syntax.issue_sourceThe issue source - supportsall,browser,mobileandbackendand defaults toallif omitted.rollup_methodThe stats roll-up method - supportscount,avg, andcardinalityand defaults tocountif omitted.measureForavgand cardinalityrollup_method- specify the measure or the facet name you want to use.group byComma-separated list of attributes to group by - should contain at leastissue.id.time_window#m (between 1 and 2880), #h (between 1 and 48).operator<,<=,>,>=,==, or!=.#an integer or decimal number used to set the threshold.
Database Monitoring Alert Query
Example: database-monitoring(query).rollup(rollup_method[, measure]).last(time_window) operator #
queryThe search query - following the Log search syntax.rollup_methodThe stats roll-up method - supportscount,avg, andcardinality.measureForavgand cardinalityrollup_method- specify the measure or the facet name you want to use.time_window#m (between 1 and 2880), #h (between 1 and 48).operator<,<=,>,>=,==, or!=.#an integer or decimal number used to set the threshold.
Network Performance Alert Query
Example: network-performance(query).rollup(rollup_method[, measure]).last(time_window) operator #
queryThe search query - following the Log search syntax.rollup_methodThe stats roll-up method - supportscount,avg, andcardinality.measureForavgand cardinalityrollup_method- specify the measure or the facet name you want to use.time_window#m (between 1 and 2880), #h (between 1 and 48).operator<,<=,>,>=,==, or!=.#an integer or decimal number used to set the threshold.
Cost Alert Query
Example: formula(query).timeframe_type(time_window).function(parameter) operator #
queryThe search query - following the Log search syntax.timeframe_typeThe timeframe type to evaluate the cost - forforecastsupportscurrent- forchange,anomaly,thresholdsupportslasttime_window- supports daily roll-up e.g.7dfunction- [optional, defaults tothresholdmonitor if omitted] supportschange,anomaly,forecastparameterSpecify the parameter of the type- for
change:- supports
relative,absolute - [optional] supports
#, where#is an integer or decimal number used to set the threshold
- supports
- for
anomaly:- supports
direction=both,direction=above,direction=below - [optional] supports
threshold=#, where#is an integer or decimal number used to set the threshold
- supports
- for
operator- for
thresholdsupports<,<=,>,>=,==, or!= - for
changesupports>,< - for
anomalysupports>= - for
forecastsupports>
- for
#an integer or decimal number used to set the threshold.
Network Path Alert Query
Example: network-path(query).index(index_name).rollup(rollup_method[, measure]).last(time_window) operator #
queryThe search query - following the Log search syntax.index_nameThe data type to monitor on - supportsnetpath-pathandnetpath-hop.rollup_methodThe stats roll-up method - supportscount,avg, andcardinality.measureForavgand cardinalityrollup_method- specify the measure or the facet name you want to use.time_window#m (between 1 and 2880), #h (between 1 and 48).operator<,<=,>,>=,==, or!=.#an integer or decimal number used to set the threshold.
Data Jobs Alert Query
Job status example: formula("failed_runs(run_query)").by(group_keys).last(time_window) > #
Job duration examples: formula("job_duration(run_query)").detection(static).by(group_keys) > duration
and formula("job_duration(run_query)").detection(anomaly).by(group_keys) > 0
run_query: The name of the single query variable inoptions.variables. Job status monitors use a data jobs query; job duration monitors use a data quality query with thedurationmeasure.group_keys: The tags to group by, such asentity_id,name,workspace_name.time_window: Number of minutes (#m), hours (#h), or days (#d), up to10d.#: The number of trailing failed runs to alert above, as a non-negative integer.duration: The duration to alert above, such as2h,30m, or a number of seconds.options.thresholds.critical: Must equal the query threshold, in seconds for job duration. Anomaly job duration monitors omitoptions.thresholds.
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 404 405 406 407 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 357 def create_monitor_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.create_monitor ...' 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 MonitorsAPI.create_monitor" end # resource path local_var_path = '/api/v1/monitor' # 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] || 'Monitor' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :create_monitor, :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 => "V1" ) 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: MonitorsAPI#create_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_monitor(monitor_id, opts = {}) ⇒ Object
Delete a monitor.
412 413 414 415 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 412 def delete_monitor(monitor_id, opts = {}) data, _status_code, _headers = delete_monitor_with_http_info(monitor_id, opts) data end |
#delete_monitor_with_http_info(monitor_id, opts = {}) ⇒ Array<(DeletedMonitor, Integer, Hash)>
Delete a monitor.
Delete the specified monitor
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 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 425 def delete_monitor_with_http_info(monitor_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.delete_monitor ...' end # verify the required parameter 'monitor_id' is set if @api_client.config.client_side_validation && monitor_id.nil? fail ArgumentError, "Missing the required parameter 'monitor_id' when calling MonitorsAPI.delete_monitor" end # resource path local_var_path = '/api/v1/monitor/{monitor_id}'.sub('{monitor_id}', CGI.escape(monitor_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'force'] = opts[:'force'] if !opts[:'force'].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] || 'DeletedMonitor' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :delete_monitor, :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 => "V1" ) 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: MonitorsAPI#delete_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_monitor(monitor_id, opts = {}) ⇒ Object
Get a monitor's details.
479 480 481 482 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 479 def get_monitor(monitor_id, opts = {}) data, _status_code, _headers = get_monitor_with_http_info(monitor_id, opts) data end |
#get_monitor_with_http_info(monitor_id, opts = {}) ⇒ Array<(Monitor, Integer, Hash)>
Get a monitor's details.
Get details about the specified monitor from your organization.
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 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 494 def get_monitor_with_http_info(monitor_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.get_monitor ...' end # verify the required parameter 'monitor_id' is set if @api_client.config.client_side_validation && monitor_id.nil? fail ArgumentError, "Missing the required parameter 'monitor_id' when calling MonitorsAPI.get_monitor" end # resource path local_var_path = '/api/v1/monitor/{monitor_id}'.sub('{monitor_id}', CGI.escape(monitor_id.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'group_states'] = opts[:'group_states'] if !opts[:'group_states'].nil? query_params[:'with_downtimes'] = opts[:'with_downtimes'] if !opts[:'with_downtimes'].nil? query_params[:'with_assets'] = opts[:'with_assets'] if !opts[:'with_assets'].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] || 'Monitor' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :get_monitor, :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 => "V1" ) 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: MonitorsAPI#get_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_monitors(opts = {}) ⇒ Object
Get all monitors.
550 551 552 553 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 550 def list_monitors(opts = {}) data, _status_code, _headers = list_monitors_with_http_info(opts) data end |
#list_monitors_with_http_info(opts = {}) ⇒ Array<(Array<Monitor>, Integer, Hash)>
Get all monitors.
Get all monitors from your organization.
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 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 569 def list_monitors_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.list_monitors ...' end if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000 fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling MonitorsAPI.list_monitors, must be smaller than or equal to 1000.' end # resource path local_var_path = '/api/v1/monitor' # query parameters query_params = opts[:query_params] || {} query_params[:'group_states'] = opts[:'group_states'] if !opts[:'group_states'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil? query_params[:'monitor_tags'] = opts[:'monitor_tags'] if !opts[:'monitor_tags'].nil? query_params[:'with_downtimes'] = opts[:'with_downtimes'] if !opts[:'with_downtimes'].nil? query_params[:'id_offset'] = opts[:'id_offset'] if !opts[:'id_offset'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'Array<Monitor>' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :list_monitors, :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 => "V1" ) 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: MonitorsAPI#list_monitors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_monitors_with_pagination(opts = {}) {|Monitor| ... } ⇒ Object
Get all monitors.
Provide a paginated version of #list_monitors, returning all items.
To use it you need to use a block: list_monitors_with_pagination { |item| p item }
633 634 635 636 637 638 639 640 641 642 643 644 645 646 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 633 def list_monitors_with_pagination(opts = {}) api_version = "V1" page_size = @api_client.get_attribute_from_path(opts, "page_size", 100) @api_client.set_attribute_from_path(api_version, opts, "page_size", Integer, page_size) @api_client.set_attribute_from_path(api_version, opts, "page", Integer, 0) while true do response = list_monitors(opts) @api_client.get_attribute_from_path(response, "").each { |item| yield(item) } if @api_client.get_attribute_from_path(response, "").length < page_size break end @api_client.set_attribute_from_path(api_version, opts, "page", Integer, @api_client.get_attribute_from_path(opts, "page", 0) + 1) end end |
#search_monitor_groups(opts = {}) ⇒ Object
Monitors group search.
651 652 653 654 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 651 def search_monitor_groups(opts = {}) data, _status_code, _headers = search_monitor_groups_with_http_info(opts) data end |
#search_monitor_groups_with_http_info(opts = {}) ⇒ Array<(MonitorGroupSearchResponse, Integer, Hash)>
Monitors group search.
Search and filter your monitor groups details.
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 666 def search_monitor_groups_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.search_monitor_groups ...' end # resource path local_var_path = '/api/v1/monitor/groups/search' # query parameters query_params = opts[:query_params] || {} query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'MonitorGroupSearchResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :search_monitor_groups, :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 => "V1" ) 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: MonitorsAPI#search_monitor_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search_monitors(opts = {}) ⇒ Object
Monitors search.
719 720 721 722 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 719 def search_monitors(opts = {}) data, _status_code, _headers = search_monitors_with_http_info(opts) data end |
#search_monitors_with_http_info(opts = {}) ⇒ Array<(MonitorSearchResponse, Integer, Hash)>
Monitors search.
Search and filter your monitors details.
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 734 def search_monitors_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.search_monitors ...' end # resource path local_var_path = '/api/v1/monitor/search' # query parameters query_params = opts[:query_params] || {} query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'MonitorSearchResponse' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :search_monitors, :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 => "V1" ) 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: MonitorsAPI#search_monitors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_monitor(monitor_id, body, opts = {}) ⇒ Object
Edit a monitor.
787 788 789 790 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 787 def update_monitor(monitor_id, body, opts = {}) data, _status_code, _headers = update_monitor_with_http_info(monitor_id, body, opts) data end |
#update_monitor_with_http_info(monitor_id, body, opts = {}) ⇒ Array<(Monitor, Integer, Hash)>
Edit a monitor.
Edit the specified monitor.
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 800 def update_monitor_with_http_info(monitor_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.update_monitor ...' end # verify the required parameter 'monitor_id' is set if @api_client.config.client_side_validation && monitor_id.nil? fail ArgumentError, "Missing the required parameter 'monitor_id' when calling MonitorsAPI.update_monitor" 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 MonitorsAPI.update_monitor" end # resource path local_var_path = '/api/v1/monitor/{monitor_id}'.sub('{monitor_id}', CGI.escape(monitor_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] || 'Monitor' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :update_monitor, :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 => "V1" ) 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: MonitorsAPI#update_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#validate_existing_monitor(monitor_id, body, opts = {}) ⇒ Object
Validate an existing monitor.
859 860 861 862 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 859 def validate_existing_monitor(monitor_id, body, opts = {}) data, _status_code, _headers = validate_existing_monitor_with_http_info(monitor_id, body, opts) data end |
#validate_existing_monitor_with_http_info(monitor_id, body, opts = {}) ⇒ Array<(Object, Integer, Hash)>
Validate an existing monitor.
Validate the monitor provided in the request.
Note: Log monitors require an unscoped App Key and logs_read_data permission.
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 874 def validate_existing_monitor_with_http_info(monitor_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.validate_existing_monitor ...' end # verify the required parameter 'monitor_id' is set if @api_client.config.client_side_validation && monitor_id.nil? fail ArgumentError, "Missing the required parameter 'monitor_id' when calling MonitorsAPI.validate_existing_monitor" 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 MonitorsAPI.validate_existing_monitor" end # resource path local_var_path = '/api/v1/monitor/{monitor_id}/validate'.sub('{monitor_id}', CGI.escape(monitor_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] || 'Object' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :validate_existing_monitor, :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 => "V1" ) 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: MonitorsAPI#validate_existing_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#validate_monitor(body, opts = {}) ⇒ Object
Validate a monitor.
933 934 935 936 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 933 def validate_monitor(body, opts = {}) data, _status_code, _headers = validate_monitor_with_http_info(body, opts) data end |
#validate_monitor_with_http_info(body, opts = {}) ⇒ Array<(Object, Integer, Hash)>
Validate a monitor.
Validate the monitor provided in the request.
Note: Log monitors require an unscoped App Key and logs_read_data permission.
947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 |
# File 'lib/datadog_api_client/v1/api/monitors_api.rb', line 947 def validate_monitor_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: MonitorsAPI.validate_monitor ...' 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 MonitorsAPI.validate_monitor" end # resource path local_var_path = '/api/v1/monitor/validate' # 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] || 'Object' # auth_names auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ] = opts.merge( :operation => :validate_monitor, :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 => "V1" ) 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: MonitorsAPI#validate_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |