Class: OCI::Monitoring::MonitoringClient
- Inherits:
-
Object
- Object
- OCI::Monitoring::MonitoringClient
- Defined in:
- lib/oci/monitoring/monitoring_client.rb
Overview
Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources. Endpoints vary by operation. For PostMetric, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints. For more information, see the Monitoring documentation.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#change_alarm_compartment(alarm_id, change_alarm_compartment_details, opts = {}) ⇒ Response
Moves an alarm into a different compartment within the same tenancy.
-
#create_alarm(create_alarm_details, opts = {}) ⇒ Response
Creates a new alarm in the specified compartment.
-
#delete_alarm(alarm_id, opts = {}) ⇒ Response
Deletes the specified alarm.
-
#get_alarm(alarm_id, opts = {}) ⇒ Response
Gets the specified alarm.
-
#get_alarm_history(alarm_id, opts = {}) ⇒ Response
Get the history of the specified alarm.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ MonitoringClient
constructor
Creates a new MonitoringClient.
-
#list_alarms(compartment_id, opts = {}) ⇒ Response
Lists the alarms for the specified compartment.
-
#list_alarms_status(compartment_id, opts = {}) ⇒ Response
List the status of each alarm in the specified compartment.
-
#list_metrics(compartment_id, list_metrics_details, opts = {}) ⇒ Response
Returns metric definitions that match the criteria specified in the request.
-
#logger ⇒ Logger
The logger for this client.
-
#post_metric_data(post_metric_data_details, opts = {}) ⇒ Response
Publishes raw metric data points to the Monitoring service.
-
#remove_alarm_suppression(alarm_id, opts = {}) ⇒ Response
Removes any existing suppression for the specified alarm.
-
#retrieve_dimension_states(alarm_id, opts = {}) ⇒ Response
Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition.
-
#summarize_metrics_data(compartment_id, summarize_metrics_data_details, opts = {}) ⇒ Response
Returns aggregated data that match the criteria specified in the request.
-
#update_alarm(alarm_id, update_alarm_details, opts = {}) ⇒ Response
Updates the specified alarm.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ MonitoringClient
Creates a new MonitoringClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 58 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20180401' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "MonitoringClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
18 19 20 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 18 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
22 23 24 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 22 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
32 33 34 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 32 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
28 29 30 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 28 def retry_config @retry_config end |
Instance Method Details
#change_alarm_compartment(alarm_id, change_alarm_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_alarm_compartment API.
Moves an alarm into a different compartment within the same tenancy. For more information, see Moving an Alarm.
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 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 131 def change_alarm_compartment(alarm_id, change_alarm_compartment_details, opts = {}) logger.debug 'Calling operation MonitoringClient#change_alarm_compartment.' if logger raise "Missing the required parameter 'alarm_id' when calling change_alarm_compartment." if alarm_id.nil? raise "Missing the required parameter 'change_alarm_compartment_details' when calling change_alarm_compartment." if change_alarm_compartment_details.nil? raise "Parameter value for 'alarm_id' must not be blank" if OCI::Internal::Util.blank_string?(alarm_id) path = '/alarms/{alarmId}/actions/changeCompartment'.sub('{alarmId}', alarm_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_alarm_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#change_alarm_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_alarm(create_alarm_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_alarm API.
Creates a new alarm in the specified compartment. For more information, see Creating an Alarm. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
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 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 205 def create_alarm(create_alarm_details, opts = {}) logger.debug 'Calling operation MonitoringClient#create_alarm.' if logger raise "Missing the required parameter 'create_alarm_details' when calling create_alarm." if create_alarm_details.nil? path = '/alarms' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_alarm_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#create_alarm') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Monitoring::Models::Alarm' ) end # rubocop:enable Metrics/BlockLength end |
#delete_alarm(alarm_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_alarm API.
Deletes the specified alarm. For more information, see Deleting an Alarm. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
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 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 276 def delete_alarm(alarm_id, opts = {}) logger.debug 'Calling operation MonitoringClient#delete_alarm.' if logger raise "Missing the required parameter 'alarm_id' when calling delete_alarm." if alarm_id.nil? raise "Parameter value for 'alarm_id' must not be blank" if OCI::Internal::Util.blank_string?(alarm_id) path = '/alarms/{alarmId}'.sub('{alarmId}', alarm_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#delete_alarm') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_alarm(alarm_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_alarm API.
Gets the specified alarm. For more information, see Getting an Alarm. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
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 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 342 def get_alarm(alarm_id, opts = {}) logger.debug 'Calling operation MonitoringClient#get_alarm.' if logger raise "Missing the required parameter 'alarm_id' when calling get_alarm." if alarm_id.nil? raise "Parameter value for 'alarm_id' must not be blank" if OCI::Internal::Util.blank_string?(alarm_id) path = '/alarms/{alarmId}'.sub('{alarmId}', alarm_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#get_alarm') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Monitoring::Models::Alarm' ) end # rubocop:enable Metrics/BlockLength end |
#get_alarm_history(alarm_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_alarm_history API.
Get the history of the specified alarm. For more information, see Getting History of an Alarm. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
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 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 434 def get_alarm_history(alarm_id, opts = {}) logger.debug 'Calling operation MonitoringClient#get_alarm_history.' if logger raise "Missing the required parameter 'alarm_id' when calling get_alarm_history." if alarm_id.nil? if opts[:alarm_historytype] && !%w[STATE_HISTORY STATE_TRANSITION_HISTORY].include?(opts[:alarm_historytype]) raise 'Invalid value for "alarm_historytype", must be one of STATE_HISTORY, STATE_TRANSITION_HISTORY.' end raise "Parameter value for 'alarm_id' must not be blank" if OCI::Internal::Util.blank_string?(alarm_id) path = '/alarms/{alarmId}/history'.sub('{alarmId}', alarm_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:alarmHistorytype] = opts[:alarm_historytype] if opts[:alarm_historytype] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:timestampGreaterThanOrEqualTo] = opts[:timestamp_greater_than_or_equal_to] if opts[:timestamp_greater_than_or_equal_to] query_params[:timestampLessThan] = opts[:timestamp_less_than] if opts[:timestamp_less_than] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#get_alarm_history') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Monitoring::Models::AlarmHistoryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_alarms(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_alarms API.
Lists the alarms for the specified compartment. For more information, see Listing Alarms. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 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 595 596 597 598 599 600 601 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 546 def list_alarms(compartment_id, opts = {}) logger.debug 'Calling operation MonitoringClient#list_alarms.' if logger raise "Missing the required parameter 'compartment_id' when calling list_alarms." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Monitoring::Models::Alarm::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Monitoring::Models::Alarm::LIFECYCLE_STATE_ENUM.' end if opts[:sort_by] && !%w[displayName severity].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of displayName, severity.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/alarms' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#list_alarms') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Monitoring::Models::AlarmSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_alarms_status(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_alarms_status API.
List the status of each alarm in the specified compartment. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use #retrieve_dimension_states retrieve_dimension_states}. For more information, see {Listing Alarm Statuses. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
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 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 690 def list_alarms_status(compartment_id, opts = {}) logger.debug 'Calling operation MonitoringClient#list_alarms_status.' if logger raise "Missing the required parameter 'compartment_id' when calling list_alarms_status." if compartment_id.nil? if opts[:sort_by] && !%w[displayName severity].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of displayName, severity.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:status] && !%w[FIRING OK].include?(opts[:status]) raise 'Invalid value for "status", must be one of FIRING, OK.' end path = '/alarms/status' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:resourceId] = opts[:resource_id] if opts[:resource_id] query_params[:serviceName] = opts[:service_name] if opts[:service_name] query_params[:entityId] = opts[:entity_id] if opts[:entity_id] query_params[:status] = opts[:status] if opts[:status] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#list_alarms_status') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Monitoring::Models::AlarmStatusSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_metrics(compartment_id, list_metrics_details, opts = {}) ⇒ Response
Click here to see an example of how to use list_metrics API.
Returns metric definitions that match the criteria specified in the request. Compartment OCID required. For more information, see Listing Metric Definitions. For information about metrics, see Metrics Overview. For important limits information, see Limits on Monitoring.
Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
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 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 801 def list_metrics(compartment_id, list_metrics_details, opts = {}) logger.debug 'Calling operation MonitoringClient#list_metrics.' if logger raise "Missing the required parameter 'compartment_id' when calling list_metrics." if compartment_id.nil? raise "Missing the required parameter 'list_metrics_details' when calling list_metrics." if list_metrics_details.nil? path = '/metrics/actions/listMetrics' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(list_metrics_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#list_metrics') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Monitoring::Models::Metric>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
97 98 99 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 97 def logger @api_client.config.logger end |
#post_metric_data(post_metric_data_details, opts = {}) ⇒ Response
Click here to see an example of how to use post_metric_data API.
Publishes raw metric data points to the Monitoring service. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future).
For more information about publishing metrics, see Publishing Custom Metrics and Custom Metrics Walkthrough. For information about developing a metric-posting client, see Developer Guide. For an example client, see MonitoringMetricPostExample.java. For important limits information, see Limits on Monitoring.
Per-call limits information follows.
-
Dimensions per metric group*. Maximum: 20. Minimum: 1.
-
Unique metric streams*. Maximum: 50.
-
Transactions Per Second (TPS) per-tenancy limit for this operation: 50.
*A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. A dimension is a qualifier provided in a metric definition. A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. For more information about metric-related concepts, see Monitoring Concepts.
Note: The endpoints for this operation differ from other Monitoring operations. Replace the string telemetry
with telemetry-ingestion
in the endpoint, as in the following example:
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 929 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 893 def post_metric_data(post_metric_data_details, opts = {}) logger.debug 'Calling operation MonitoringClient#post_metric_data.' if logger raise "Missing the required parameter 'post_metric_data_details' when calling post_metric_data." if post_metric_data_details.nil? path = '/metrics' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'content-encoding'] = opts[:content_encoding] if opts[:content_encoding] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(post_metric_data_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#post_metric_data') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Monitoring::Models::PostMetricDataResponseDetails' ) end # rubocop:enable Metrics/BlockLength end |
#remove_alarm_suppression(alarm_id, opts = {}) ⇒ Response
Click here to see an example of how to use remove_alarm_suppression API.
Removes any existing suppression for the specified alarm. For more information, see Removing Suppression from an Alarm. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
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 998 999 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 963 def remove_alarm_suppression(alarm_id, opts = {}) logger.debug 'Calling operation MonitoringClient#remove_alarm_suppression.' if logger raise "Missing the required parameter 'alarm_id' when calling remove_alarm_suppression." if alarm_id.nil? raise "Parameter value for 'alarm_id' must not be blank" if OCI::Internal::Util.blank_string?(alarm_id) path = '/alarms/{alarmId}/actions/removeSuppression'.sub('{alarmId}', alarm_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#remove_alarm_suppression') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#retrieve_dimension_states(alarm_id, opts = {}) ⇒ Response
Click here to see an example of how to use retrieve_dimension_states API.
Lists the current alarm status of each metric stream, where status is derived from the metric stream's last associated transition. Optionally filter by status value and one or more dimension key-value pairs. For more information, see Listing Metric Stream Status in an Alarm.
For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 1045 def retrieve_dimension_states(alarm_id, opts = {}) logger.debug 'Calling operation MonitoringClient#retrieve_dimension_states.' if logger raise "Missing the required parameter 'alarm_id' when calling retrieve_dimension_states." if alarm_id.nil? raise "Parameter value for 'alarm_id' must not be blank" if OCI::Internal::Util.blank_string?(alarm_id) path = '/alarms/{alarmId}/actions/retrieveDimensionStates'.sub('{alarmId}', alarm_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(opts[:retrieve_dimension_states_details]) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#retrieve_dimension_states') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Monitoring::Models::AlarmDimensionStatesCollection' ) end # rubocop:enable Metrics/BlockLength end |
#summarize_metrics_data(compartment_id, summarize_metrics_data_details, opts = {}) ⇒ Response
Click here to see an example of how to use summarize_metrics_data API.
Returns aggregated data that match the criteria specified in the request. Compartment OCID required. For more information, see Querying Metric Data and Creating a Query. For important limits information, see Limits on Monitoring.
Transactions Per Second (TPS) per-tenancy limit for this operation: 10.
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 1124 def summarize_metrics_data(compartment_id, summarize_metrics_data_details, opts = {}) logger.debug 'Calling operation MonitoringClient#summarize_metrics_data.' if logger raise "Missing the required parameter 'compartment_id' when calling summarize_metrics_data." if compartment_id.nil? raise "Missing the required parameter 'summarize_metrics_data_details' when calling summarize_metrics_data." if summarize_metrics_data_details.nil? path = '/metrics/actions/summarizeMetricsData' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(summarize_metrics_data_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#summarize_metrics_data') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Monitoring::Models::MetricData>' ) end # rubocop:enable Metrics/BlockLength end |
#update_alarm(alarm_id, update_alarm_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_alarm API.
Updates the specified alarm. For more information, see Updating an Alarm. For important limits information, see Limits on Monitoring.
This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'lib/oci/monitoring/monitoring_client.rb', line 1197 def update_alarm(alarm_id, update_alarm_details, opts = {}) logger.debug 'Calling operation MonitoringClient#update_alarm.' if logger raise "Missing the required parameter 'alarm_id' when calling update_alarm." if alarm_id.nil? raise "Missing the required parameter 'update_alarm_details' when calling update_alarm." if update_alarm_details.nil? raise "Parameter value for 'alarm_id' must not be blank" if OCI::Internal::Util.blank_string?(alarm_id) path = '/alarms/{alarmId}'.sub('{alarmId}', alarm_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_alarm_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'MonitoringClient#update_alarm') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Monitoring::Models::Alarm' ) end # rubocop:enable Metrics/BlockLength end |