Class: MintPress::Aws::Lightsail::InstanceMetricDatum

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb

Properties (Read/Write)

  • #instance_name ⇒ [String]
    'The name of the instance for which you want to get metrics data.'
    Property Attributes
    • get_instance_metric_data_prop ⇒ 'instance_name'
    • read_only ⇒ false
    • source ⇒ "get_instance_metric_data"
    

17
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb', line 17

property :instance_name, get_instance_metric_data_prop: 'instance_name', type: [String], read_only: false, source: "get_instance_metric_data", description: 'The name of the instance for which you want to get metrics data.'
  • #metric_name ⇒ [String]
    'The metric for which you want to return information. Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance"s BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance"s BurstCapacityPercentage metric reaches 100%. Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Seconds. CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count.'
    Property Attributes
    • get_instance_metric_data_prop ⇒ 'metric_name'
    • read_only ⇒ false
    • source ⇒ "get_instance_metric_data"
    

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb', line 18

property :metric_name, get_instance_metric_data_prop: 'metric_name', type: [String], read_only: false, source: "get_instance_metric_data", description: 'The metric for which you want to return information.

Valid instance metric names are listed below, along with the most
useful statistics to include in your request, and the published
unit value.


 BurstCapacityPercentage  - The percentage of
CPU performance available for your instance to burst above its
baseline. Your instance continuously accrues and consumes burst
capacity. Burst capacity stops accruing when your instance"s
BurstCapacityPercentage reaches 100%. For more information, see
Viewing instance burst capacity in Amazon Lightsail.

Statistics: The most useful statistics are Maximum and
Average.

Unit: The published unit is Percent.
 BurstCapacityTime  - The available amount of
time for your instance to burst at 100% CPU utilization. Your
instance continuously accrues and consumes burst capacity. Burst
capacity time stops accruing when your instance"s
BurstCapacityPercentage metric reaches 100%.

Burst capacity time is consumed at the full rate only when your
instance operates at 100% CPU utilization. For example, if your
instance operates at 50% CPU utilization in the burstable zone for a
5-minute period, then it consumes CPU burst capacity minutes at a
50% rate in that period. Your instance consumed 2 minutes and 30
seconds of CPU burst capacity minutes in the 5-minute period. For
more information, see Viewing instance burst capacity in Amazon
Lightsail.

Statistics: The most useful statistics are Maximum and
Average.

Unit: The published unit is Seconds.
 CPUUtilization  - The percentage of allocated
compute units that are currently in use on the instance. This metric
identifies the processing power to run the applications on the
instance. Tools in your operating system can show a lower percentage
than Lightsail when the instance is not allocated a full processor
core.

Statistics: The most useful statistics are Maximum and
Average.

Unit: The published unit is Percent.
 NetworkIn  - The number of bytes received on
all network interfaces by the instance. This metric identifies the
volume of incoming network traffic to the instance. The number
reported is the number of bytes received during the period. Because
this metric is reported in 5-minute intervals, divide the reported
number by 300 to find Bytes/second.

Statistics: The most useful statistic is Sum.

Unit: The published unit is Bytes.
 NetworkOut  - The number of bytes sent out on
all network interfaces by the instance. This metric identifies the
volume of outgoing network traffic from the instance. The number
reported is the number of bytes sent during the period. Because this
metric is reported in 5-minute intervals, divide the reported number
by 300 to find Bytes/second.

Statistics: The most useful statistic is Sum.

Unit: The published unit is Bytes.
 StatusCheckFailed  - Reports whether the
instance passed or failed both the instance status check and the
system status check. This metric can be either 0 (passed) or 1
(failed). This metric data is available in 1-minute (60 seconds)
granularity.

Statistics: The most useful statistic is Sum.

Unit: The published unit is Count.
 StatusCheckFailed_Instance  - Reports whether
the instance passed or failed the instance status check. This metric
can be either 0 (passed) or 1 (failed). This metric data is
available in 1-minute (60 seconds) granularity.

Statistics: The most useful statistic is Sum.

Unit: The published unit is Count.
 StatusCheckFailed_System  - Reports whether the
instance passed or failed the system status check. This metric can
be either 0 (passed) or 1 (failed). This metric data is available in
1-minute (60 seconds) granularity.

Statistics: The most useful statistic is Sum.

Unit: The published unit is Count.'
  • #period ⇒ [Integer]
    'The granularity, in seconds, of the returned data points. The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity.'
    Property Attributes
    • get_instance_metric_data_prop ⇒ 'period'
    • read_only ⇒ false
    • source ⇒ "get_instance_metric_data"
    

111
112
113
114
115
116
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb', line 111

property :period, get_instance_metric_data_prop: 'period', type: [Integer], read_only: false, source: "get_instance_metric_data", description: 'The granularity, in seconds, of the returned data points.

The StatusCheckFailed, StatusCheckFailed_Instance, and
StatusCheckFailed_System instance metric data is available in
1-minute (60 seconds) granularity. All other instance metric data is
available in 5-minute (300 seconds) granularity.'
  • #start_time ⇒ [Time,DateTime,Integer]
    'The start time of the time period.'
    Property Attributes
    • get_instance_metric_data_prop ⇒ 'start_time'
    • read_only ⇒ false
    • source ⇒ "get_instance_metric_data"
    

117
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb', line 117

property :start_time, get_instance_metric_data_prop: 'start_time', type: [Time,DateTime,Integer], read_only: false, source: "get_instance_metric_data", description: 'The start time of the time period.'
  • #end_time ⇒ [Time,DateTime,Integer]
    'The end time of the time period.'
    Property Attributes
    • get_instance_metric_data_prop ⇒ 'end_time'
    • read_only ⇒ false
    • source ⇒ "get_instance_metric_data"
    

118
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb', line 118

property :end_time, get_instance_metric_data_prop: 'end_time', type: [Time,DateTime,Integer], read_only: false, source: "get_instance_metric_data", description: 'The end time of the time period.'
  • #unit ⇒ [String]
    'The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units to specify with each available metric, see the metricName parameter.'
    Property Attributes
    • get_instance_metric_data_prop ⇒ 'unit'
    • read_only ⇒ false
    • source ⇒ "get_instance_metric_data"
    

119
120
121
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb', line 119

property :unit, get_instance_metric_data_prop: 'unit', type: [String], read_only: false, source: "get_instance_metric_data", description: 'The unit for the metric data request. Valid units depend on the metric
data being requested. For the valid units to specify with each
available metric, see the metricName parameter.'
  • #statistics ⇒ Array of ⇒ [String]
    'The statistic for the metric. The following statistics are available: Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount - The count, or number, of data points used for the statistical calculation.'
    Property Attributes
    • get_instance_metric_data_prop ⇒ 'statistics'
    • read_only ⇒ false
    • source ⇒ "get_instance_metric_data"
    

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb', line 122

property :statistics, get_instance_metric_data_prop: 'statistics', type: [String], array: true, read_only: false, source: "get_instance_metric_data", description: 'The statistic for the metric.

The following statistics are available:


Minimum - The lowest value observed during the specified period.
Use this value to determine low volumes of activity for your
application.
Maximum - The highest value observed during the specified period.
Use this value to determine high volumes of activity for your
application.
Sum - All values submitted for the matching metric added together.
You can use this statistic to determine the total volume of a
metric.
Average - The value of Sum / SampleCount during the specified
period. By comparing this statistic with the Minimum and Maximum
values, you can determine the full scope of a metric and how close
the average use is to the Minimum and Maximum values. This
comparison helps you to know when to increase or decrease your
resources.
SampleCount - The count, or number, of data points used for the
statistical calculation.'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

147
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb', line 147

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

150
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/instance_metric_datum.rb', line 150

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ InstanceMetricDatum

Returns a new instance of InstanceMetricDatum.

Instance Method Details

#get ⇒ Object