Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pi.Types.MetricQuery

Description

Synopsis

data MetricQuery = MetricQuery' {
- groupBy :: Maybe DimensionGroup
- filter' :: Maybe (HashMap Text Text)
- metric :: Text
}
newMetricQuery :: Text -> MetricQuery
metricQuery_groupBy :: Lens' MetricQuery (Maybe DimensionGroup)
metricQuery_filter :: Lens' MetricQuery (Maybe (HashMap Text Text))
metricQuery_metric :: Lens' MetricQuery Text

Documentation

data MetricQuery Source #

A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all of the data points for that metric. You can optionally request that the data points be aggregated by dimension group ( GroupBy), and return only those data points that match your criteria (Filter).

See: newMetricQuery smart constructor.

Constructors

MetricQuery'

Fields

groupBy :: Maybe DimensionGroup
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return 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.
filter' :: Maybe (HashMap Text Text)
One or more filters to apply in the request. 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.
metric :: Text
The name of a Performance Insights metric to be measured.
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

Eq MetricQuery Source #
Instance details Defined in Amazonka.Pi.Types.MetricQuery Methods (==) :: MetricQuery -> MetricQuery -> Bool # (/=) :: MetricQuery -> MetricQuery -> Bool #
Read MetricQuery Source #
Instance details Defined in Amazonka.Pi.Types.MetricQuery Methods readsPrec :: Int -> ReadS MetricQuery # readList :: ReadS [MetricQuery] # readPrec :: ReadPrec MetricQuery # readListPrec :: ReadPrec [MetricQuery] #
Show MetricQuery Source #
Instance details Defined in Amazonka.Pi.Types.MetricQuery Methods showsPrec :: Int -> MetricQuery -> ShowS # show :: MetricQuery -> String # showList :: [MetricQuery] -> ShowS #
Generic MetricQuery Source #
Instance details Defined in Amazonka.Pi.Types.MetricQuery Associated Types type Rep MetricQuery :: Type -> Type # Methods from :: MetricQuery -> Rep MetricQuery x # to :: Rep MetricQuery x -> MetricQuery #
NFData MetricQuery Source #
Instance details Defined in Amazonka.Pi.Types.MetricQuery Methods rnf :: MetricQuery -> () #
Hashable MetricQuery Source #
Instance details Defined in Amazonka.Pi.Types.MetricQuery Methods hashWithSalt :: Int -> MetricQuery -> Int # hash :: MetricQuery -> Int #
ToJSON MetricQuery Source #
Instance details Defined in Amazonka.Pi.Types.MetricQuery Methods toJSON :: MetricQuery -> Value # toEncoding :: MetricQuery -> Encoding # toJSONList :: [MetricQuery] -> Value # toEncodingList :: [MetricQuery] -> Encoding #
type Rep MetricQuery Source #
Instance details Defined in Amazonka.Pi.Types.MetricQuery type Rep MetricQuery = D1 ('MetaData "MetricQuery" "Amazonka.Pi.Types.MetricQuery" "libZSservicesZSamazonka-piZSamazonka-pi" 'False) (C1 ('MetaCons "MetricQuery'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DimensionGroup)) :: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newMetricQuery Source #

Arguments

:: Text	`$sel:metric:MetricQuery'`
-> MetricQuery

Create a value of MetricQuery 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:groupBy:MetricQuery', metricQuery_groupBy - A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return 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:filter':MetricQuery', metricQuery_filter - One or more filters to apply in the request. 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:metric:MetricQuery', metricQuery_metric - The name of a Performance Insights metric to be measured.

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.

metricQuery_groupBy :: Lens' MetricQuery (Maybe DimensionGroup) Source #

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return 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.

metricQuery_filter :: Lens' MetricQuery (Maybe (HashMap Text Text)) Source #

One or more filters to apply in the request. 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.

metricQuery_metric :: Lens' MetricQuery Text Source #

The name of a Performance Insights metric to be measured.

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.