libZSservicesZSamazonka-piZSamazonka-pi
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Pi.Types.ResponseResourceMetricKey

Description

 
Synopsis

Documentation

data ResponseResourceMetricKey Source #

An object describing a Performance Insights metric and one or more dimensions for that metric.

See: newResponseResourceMetricKey smart constructor.

Constructors

ResponseResourceMetricKey' 

Fields

  • dimensions :: Maybe (HashMap Text Text)

    The valid dimensions for the metric.

  • 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 ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Read ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Show ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Generic ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Associated Types

type Rep ResponseResourceMetricKey :: Type -> Type #

NFData ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Hashable ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

FromJSON ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

type Rep ResponseResourceMetricKey Source # 
Instance details

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

type Rep ResponseResourceMetricKey = D1 ('MetaData "ResponseResourceMetricKey" "Amazonka.Pi.Types.ResponseResourceMetricKey" "libZSservicesZSamazonka-piZSamazonka-pi" 'False) (C1 ('MetaCons "ResponseResourceMetricKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newResponseResourceMetricKey Source #

Create a value of ResponseResourceMetricKey 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:dimensions:ResponseResourceMetricKey', responseResourceMetricKey_dimensions - The valid dimensions for the metric.

$sel:metric:ResponseResourceMetricKey', responseResourceMetricKey_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.

responseResourceMetricKey_metric :: Lens' ResponseResourceMetricKey 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.