Amazonka.Pi.Types.ResponseResourceMetricKey

Documentation

data ResponseResourceMetricKey

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.
  • The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

  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

FromJSON ResponseResourceMetricKey

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Methods

parseJSON :: Value -> Parser ResponseResourceMetricKey

parseJSONList :: Value -> Parser [ResponseResourceMetricKey]

Generic ResponseResourceMetricKey

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Associated Types

type Rep ResponseResourceMetricKey :: Type -> Type

Methods

from :: ResponseResourceMetricKey -> Rep ResponseResourceMetricKey x

to :: Rep ResponseResourceMetricKey x -> ResponseResourceMetricKey

Read ResponseResourceMetricKey

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Methods

readsPrec :: Int -> ReadS ResponseResourceMetricKey

readList :: ReadS [ResponseResourceMetricKey]

readPrec :: ReadPrec ResponseResourceMetricKey

readListPrec :: ReadPrec [ResponseResourceMetricKey]

Show ResponseResourceMetricKey

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Methods

showsPrec :: Int -> ResponseResourceMetricKey -> ShowS

show :: ResponseResourceMetricKey -> String

showList :: [ResponseResourceMetricKey] -> ShowS

NFData ResponseResourceMetricKey

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Methods

rnf :: ResponseResourceMetricKey -> ()

Eq ResponseResourceMetricKey

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Methods

(==) :: ResponseResourceMetricKey -> ResponseResourceMetricKey -> Bool

(/=) :: ResponseResourceMetricKey -> ResponseResourceMetricKey -> Bool

Hashable ResponseResourceMetricKey

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

Methods

hashWithSalt :: Int -> ResponseResourceMetricKey -> Int

hash :: ResponseResourceMetricKey -> Int

type Rep ResponseResourceMetricKey

Defined in Amazonka.Pi.Types.ResponseResourceMetricKey

type Rep ResponseResourceMetricKey = D1 ('MetaData "ResponseResourceMetricKey" "Amazonka.Pi.Types.ResponseResourceMetricKey" "amazonka-pi-2.0-JFFapck1KySFz4VqF9F326" '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

Arguments

:: Text

$sel:metric:ResponseResourceMetricKey'

-> ResponseResourceMetricKey

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.
• The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

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_dimensions :: Lens' ResponseResourceMetricKey (Maybe (HashMap Text Text))

The valid dimensions for the metric.

responseResourceMetricKey_metric :: Lens' ResponseResourceMetricKey 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.
• The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

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.