pub struct GetInstanceMetricDataRequest {
pub end_time: f64,
pub instance_name: String,
pub metric_name: String,
pub period: i64,
pub start_time: f64,
pub statistics: Vec<String>,
pub unit: String,
}
Fields
end_time: f64
The end time of the time period.
instance_name: String
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'sBurstCapacityPercentage
reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics
: The most useful statistics areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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'sBurstCapacityPercentage
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 areMaximum
andAverage
.Unit
: The published unit isSeconds
. -
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 areMaximum
andAverage
.Unit
: The published unit isPercent
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isBytes
. -
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 isSum
.Unit
: The published unit isCount
. -
StatusCheckFailedInstance
- 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 isSum
.Unit
: The published unit isCount
. -
StatusCheckFailedSystem
- 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 isSum
.Unit
: The published unit isCount
.
period: i64
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: f64
The start time of the time period.
statistics: Vec<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.
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.
Trait Implementations
sourceimpl Clone for GetInstanceMetricDataRequest
impl Clone for GetInstanceMetricDataRequest
sourcefn clone(&self) -> GetInstanceMetricDataRequest
fn clone(&self) -> GetInstanceMetricDataRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for GetInstanceMetricDataRequest
impl Debug for GetInstanceMetricDataRequest
sourceimpl Default for GetInstanceMetricDataRequest
impl Default for GetInstanceMetricDataRequest
sourcefn default() -> GetInstanceMetricDataRequest
fn default() -> GetInstanceMetricDataRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<GetInstanceMetricDataRequest> for GetInstanceMetricDataRequest
impl PartialEq<GetInstanceMetricDataRequest> for GetInstanceMetricDataRequest
sourcefn eq(&self, other: &GetInstanceMetricDataRequest) -> bool
fn eq(&self, other: &GetInstanceMetricDataRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &GetInstanceMetricDataRequest) -> bool
fn ne(&self, other: &GetInstanceMetricDataRequest) -> bool
This method tests for !=
.
impl StructuralPartialEq for GetInstanceMetricDataRequest
Auto Trait Implementations
impl RefUnwindSafe for GetInstanceMetricDataRequest
impl Send for GetInstanceMetricDataRequest
impl Sync for GetInstanceMetricDataRequest
impl Unpin for GetInstanceMetricDataRequest
impl UnwindSafe for GetInstanceMetricDataRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more