Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery

Description

Documentation

data PerformanceInsightsMetricQuery Source #

A single query to be processed. Use these parameters to query the Performance Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For more information, see GetResourceMetrics in the Amazon RDS Performance Insights API Reference.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.

See: newPerformanceInsightsMetricQuery smart constructor.

Constructors

PerformanceInsightsMetricQuery'

Fields

filter' :: Maybe (HashMap Text Text)
One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
- Any number of filters by the same dimension, as specified in the GroupBy parameter.
- A single filter for any other dimension in this dimension group.
groupBy :: Maybe PerformanceInsightsMetricDimensionGroup
The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
metric :: Maybe Text
The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.
Valid values for Metric are:
- db.load.avg - a scaled representation of the number of active sessions for the database engine.
- db.sampledload.avg - the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

Instances

Instances details

FromJSON PerformanceInsightsMetricQuery Source #
Instance details Defined in Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery Methods parseJSON :: Value -> Parser PerformanceInsightsMetricQuery # parseJSONList :: Value -> Parser [PerformanceInsightsMetricQuery] #
Generic PerformanceInsightsMetricQuery Source #
Instance details Defined in Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery Associated Types type Rep PerformanceInsightsMetricQuery :: Type -> Type # Methods from :: PerformanceInsightsMetricQuery -> Rep PerformanceInsightsMetricQuery x # to :: Rep PerformanceInsightsMetricQuery x -> PerformanceInsightsMetricQuery #
Read PerformanceInsightsMetricQuery Source #
Instance details Defined in Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery Methods readsPrec :: Int -> ReadS PerformanceInsightsMetricQuery # readList :: ReadS [PerformanceInsightsMetricQuery] # readPrec :: ReadPrec PerformanceInsightsMetricQuery # readListPrec :: ReadPrec [PerformanceInsightsMetricQuery] #
Show PerformanceInsightsMetricQuery Source #
Instance details Defined in Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery Methods showsPrec :: Int -> PerformanceInsightsMetricQuery -> ShowS # show :: PerformanceInsightsMetricQuery -> String # showList :: [PerformanceInsightsMetricQuery] -> ShowS #
NFData PerformanceInsightsMetricQuery Source #
Instance details Defined in Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery Methods rnf :: PerformanceInsightsMetricQuery -> () #
Eq PerformanceInsightsMetricQuery Source #
Instance details Defined in Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery Methods (==) :: PerformanceInsightsMetricQuery -> PerformanceInsightsMetricQuery -> Bool # (/=) :: PerformanceInsightsMetricQuery -> PerformanceInsightsMetricQuery -> Bool #
Hashable PerformanceInsightsMetricQuery Source #
Instance details Defined in Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery Methods hashWithSalt :: Int -> PerformanceInsightsMetricQuery -> Int # hash :: PerformanceInsightsMetricQuery -> Int #
type Rep PerformanceInsightsMetricQuery Source #
Instance details Defined in Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery type Rep PerformanceInsightsMetricQuery = D1 ('MetaData "PerformanceInsightsMetricQuery" "Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery" "amazonka-devops-guru-2.0-C03FLSgo73f1Pu5ftIREHS" 'False) (C1 ('MetaCons "PerformanceInsightsMetricQuery'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "groupBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PerformanceInsightsMetricDimensionGroup)) :: S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newPerformanceInsightsMetricQuery :: PerformanceInsightsMetricQuery Source #

Create a value of PerformanceInsightsMetricQuery with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:filter':PerformanceInsightsMetricQuery', performanceInsightsMetricQuery_filter - One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

Any number of filters by the same dimension, as specified in the GroupBy parameter.
A single filter for any other dimension in this dimension group.

$sel:groupBy:PerformanceInsightsMetricQuery', performanceInsightsMetricQuery_groupBy - The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

$sel:metric:PerformanceInsightsMetricQuery', performanceInsightsMetricQuery_metric - The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

Valid values for Metric are:

db.load.avg - a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg - the raw number of active sessions for the database engine.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

performanceInsightsMetricQuery_filter :: Lens' PerformanceInsightsMetricQuery (Maybe (HashMap Text Text)) Source #

One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

Any number of filters by the same dimension, as specified in the GroupBy parameter.
A single filter for any other dimension in this dimension group.

performanceInsightsMetricQuery_groupBy :: Lens' PerformanceInsightsMetricQuery (Maybe PerformanceInsightsMetricDimensionGroup) Source #

The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

performanceInsightsMetricQuery_metric :: Lens' PerformanceInsightsMetricQuery (Maybe Text) Source #

The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

Valid values for Metric are:

db.load.avg - a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg - the raw number of active sessions for the database engine.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.