{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricQuery where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.DevOpsGuru.Types.PerformanceInsightsMetricDimensionGroup
import qualified Amazonka.Prelude as Prelude

-- | 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
-- @ @<https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html 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
--     <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html Amazon Aurora User Guide>.
--
-- -   To learn more about Performance Insights and Amazon RDS DB
--     instances, go to the
--     <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html Amazon RDS User Guide>.
--
-- /See:/ 'newPerformanceInsightsMetricQuery' smart constructor.
data PerformanceInsightsMetricQuery = PerformanceInsightsMetricQuery'
  { -- | 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 -> Maybe (HashMap Text Text)
filter' :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | 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
-> Maybe PerformanceInsightsMetricDimensionGroup
groupBy :: Prelude.Maybe PerformanceInsightsMetricDimensionGroup,
    -- | 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 -> Maybe Text
metric :: Prelude.Maybe Prelude.Text
  }
  deriving (PerformanceInsightsMetricQuery
-> PerformanceInsightsMetricQuery -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PerformanceInsightsMetricQuery
-> PerformanceInsightsMetricQuery -> Bool
$c/= :: PerformanceInsightsMetricQuery
-> PerformanceInsightsMetricQuery -> Bool
== :: PerformanceInsightsMetricQuery
-> PerformanceInsightsMetricQuery -> Bool
$c== :: PerformanceInsightsMetricQuery
-> PerformanceInsightsMetricQuery -> Bool
Prelude.Eq, ReadPrec [PerformanceInsightsMetricQuery]
ReadPrec PerformanceInsightsMetricQuery
Int -> ReadS PerformanceInsightsMetricQuery
ReadS [PerformanceInsightsMetricQuery]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PerformanceInsightsMetricQuery]
$creadListPrec :: ReadPrec [PerformanceInsightsMetricQuery]
readPrec :: ReadPrec PerformanceInsightsMetricQuery
$creadPrec :: ReadPrec PerformanceInsightsMetricQuery
readList :: ReadS [PerformanceInsightsMetricQuery]
$creadList :: ReadS [PerformanceInsightsMetricQuery]
readsPrec :: Int -> ReadS PerformanceInsightsMetricQuery
$creadsPrec :: Int -> ReadS PerformanceInsightsMetricQuery
Prelude.Read, Int -> PerformanceInsightsMetricQuery -> ShowS
[PerformanceInsightsMetricQuery] -> ShowS
PerformanceInsightsMetricQuery -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PerformanceInsightsMetricQuery] -> ShowS
$cshowList :: [PerformanceInsightsMetricQuery] -> ShowS
show :: PerformanceInsightsMetricQuery -> String
$cshow :: PerformanceInsightsMetricQuery -> String
showsPrec :: Int -> PerformanceInsightsMetricQuery -> ShowS
$cshowsPrec :: Int -> PerformanceInsightsMetricQuery -> ShowS
Prelude.Show, forall x.
Rep PerformanceInsightsMetricQuery x
-> PerformanceInsightsMetricQuery
forall x.
PerformanceInsightsMetricQuery
-> Rep PerformanceInsightsMetricQuery x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep PerformanceInsightsMetricQuery x
-> PerformanceInsightsMetricQuery
$cfrom :: forall x.
PerformanceInsightsMetricQuery
-> Rep PerformanceInsightsMetricQuery x
Prelude.Generic)

-- |
-- Create a value of 'PerformanceInsightsMetricQuery' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'filter'', '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.
--
-- 'groupBy', '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.
--
-- 'metric', '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.
newPerformanceInsightsMetricQuery ::
  PerformanceInsightsMetricQuery
newPerformanceInsightsMetricQuery :: PerformanceInsightsMetricQuery
newPerformanceInsightsMetricQuery =
  PerformanceInsightsMetricQuery'
    { $sel:filter':PerformanceInsightsMetricQuery' :: Maybe (HashMap Text Text)
filter' =
        forall a. Maybe a
Prelude.Nothing,
      $sel:groupBy:PerformanceInsightsMetricQuery' :: Maybe PerformanceInsightsMetricDimensionGroup
groupBy = forall a. Maybe a
Prelude.Nothing,
      $sel:metric:PerformanceInsightsMetricQuery' :: Maybe Text
metric = forall a. Maybe a
Prelude.Nothing
    }

-- | 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_filter :: Lens.Lens' PerformanceInsightsMetricQuery (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
performanceInsightsMetricQuery_filter :: Lens' PerformanceInsightsMetricQuery (Maybe (HashMap Text Text))
performanceInsightsMetricQuery_filter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PerformanceInsightsMetricQuery' {Maybe (HashMap Text Text)
filter' :: Maybe (HashMap Text Text)
$sel:filter':PerformanceInsightsMetricQuery' :: PerformanceInsightsMetricQuery -> Maybe (HashMap Text Text)
filter'} -> Maybe (HashMap Text Text)
filter') (\s :: PerformanceInsightsMetricQuery
s@PerformanceInsightsMetricQuery' {} Maybe (HashMap Text Text)
a -> PerformanceInsightsMetricQuery
s {$sel:filter':PerformanceInsightsMetricQuery' :: Maybe (HashMap Text Text)
filter' = Maybe (HashMap Text Text)
a} :: PerformanceInsightsMetricQuery) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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_groupBy :: Lens.Lens' PerformanceInsightsMetricQuery (Prelude.Maybe PerformanceInsightsMetricDimensionGroup)
performanceInsightsMetricQuery_groupBy :: Lens'
  PerformanceInsightsMetricQuery
  (Maybe PerformanceInsightsMetricDimensionGroup)
performanceInsightsMetricQuery_groupBy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PerformanceInsightsMetricQuery' {Maybe PerformanceInsightsMetricDimensionGroup
groupBy :: Maybe PerformanceInsightsMetricDimensionGroup
$sel:groupBy:PerformanceInsightsMetricQuery' :: PerformanceInsightsMetricQuery
-> Maybe PerformanceInsightsMetricDimensionGroup
groupBy} -> Maybe PerformanceInsightsMetricDimensionGroup
groupBy) (\s :: PerformanceInsightsMetricQuery
s@PerformanceInsightsMetricQuery' {} Maybe PerformanceInsightsMetricDimensionGroup
a -> PerformanceInsightsMetricQuery
s {$sel:groupBy:PerformanceInsightsMetricQuery' :: Maybe PerformanceInsightsMetricDimensionGroup
groupBy = Maybe PerformanceInsightsMetricDimensionGroup
a} :: PerformanceInsightsMetricQuery)

-- | 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_metric :: Lens.Lens' PerformanceInsightsMetricQuery (Prelude.Maybe Prelude.Text)
performanceInsightsMetricQuery_metric :: Lens' PerformanceInsightsMetricQuery (Maybe Text)
performanceInsightsMetricQuery_metric = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PerformanceInsightsMetricQuery' {Maybe Text
metric :: Maybe Text
$sel:metric:PerformanceInsightsMetricQuery' :: PerformanceInsightsMetricQuery -> Maybe Text
metric} -> Maybe Text
metric) (\s :: PerformanceInsightsMetricQuery
s@PerformanceInsightsMetricQuery' {} Maybe Text
a -> PerformanceInsightsMetricQuery
s {$sel:metric:PerformanceInsightsMetricQuery' :: Maybe Text
metric = Maybe Text
a} :: PerformanceInsightsMetricQuery)

instance Data.FromJSON PerformanceInsightsMetricQuery where
  parseJSON :: Value -> Parser PerformanceInsightsMetricQuery
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PerformanceInsightsMetricQuery"
      ( \Object
x ->
          Maybe (HashMap Text Text)
-> Maybe PerformanceInsightsMetricDimensionGroup
-> Maybe Text
-> PerformanceInsightsMetricQuery
PerformanceInsightsMetricQuery'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Filter" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"GroupBy")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Metric")
      )

instance
  Prelude.Hashable
    PerformanceInsightsMetricQuery
  where
  hashWithSalt :: Int -> PerformanceInsightsMetricQuery -> Int
hashWithSalt
    Int
_salt
    PerformanceInsightsMetricQuery' {Maybe Text
Maybe (HashMap Text Text)
Maybe PerformanceInsightsMetricDimensionGroup
metric :: Maybe Text
groupBy :: Maybe PerformanceInsightsMetricDimensionGroup
filter' :: Maybe (HashMap Text Text)
$sel:metric:PerformanceInsightsMetricQuery' :: PerformanceInsightsMetricQuery -> Maybe Text
$sel:groupBy:PerformanceInsightsMetricQuery' :: PerformanceInsightsMetricQuery
-> Maybe PerformanceInsightsMetricDimensionGroup
$sel:filter':PerformanceInsightsMetricQuery' :: PerformanceInsightsMetricQuery -> Maybe (HashMap Text Text)
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
filter'
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PerformanceInsightsMetricDimensionGroup
groupBy
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
metric

instance
  Prelude.NFData
    PerformanceInsightsMetricQuery
  where
  rnf :: PerformanceInsightsMetricQuery -> ()
rnf PerformanceInsightsMetricQuery' {Maybe Text
Maybe (HashMap Text Text)
Maybe PerformanceInsightsMetricDimensionGroup
metric :: Maybe Text
groupBy :: Maybe PerformanceInsightsMetricDimensionGroup
filter' :: Maybe (HashMap Text Text)
$sel:metric:PerformanceInsightsMetricQuery' :: PerformanceInsightsMetricQuery -> Maybe Text
$sel:groupBy:PerformanceInsightsMetricQuery' :: PerformanceInsightsMetricQuery
-> Maybe PerformanceInsightsMetricDimensionGroup
$sel:filter':PerformanceInsightsMetricQuery' :: PerformanceInsightsMetricQuery -> Maybe (HashMap Text Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
filter'
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe PerformanceInsightsMetricDimensionGroup
groupBy
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
metric