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.Rum.Types.MetricDefinition

Description

Documentation

data MetricDefinition Source #

A structure that displays the definition of one extended metric that RUM sends to CloudWatch or CloudWatch Evidently. For more information, see Additional metrics that you can send to CloudWatch and CloudWatch Evidently.

See: newMetricDefinition smart constructor.

Constructors

MetricDefinition'

Fields

dimensionKeys :: Maybe (HashMap Text Text)
This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.
eventPattern :: Maybe Text
The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
unitLabel :: Maybe Text
Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.
valueKey :: Maybe Text
The field within the event object that the metric value is sourced from.
metricDefinitionId :: Text
The ID of this metric definition.
name :: Text
The name of the metric that is defined in this structure.

Instances

Instances details

FromJSON MetricDefinition Source #
Instance details Defined in Amazonka.Rum.Types.MetricDefinition Methods parseJSON :: Value -> Parser MetricDefinition # parseJSONList :: Value -> Parser [MetricDefinition] #
Generic MetricDefinition Source #
Instance details Defined in Amazonka.Rum.Types.MetricDefinition Associated Types type Rep MetricDefinition :: Type -> Type # Methods from :: MetricDefinition -> Rep MetricDefinition x # to :: Rep MetricDefinition x -> MetricDefinition #
Read MetricDefinition Source #
Instance details Defined in Amazonka.Rum.Types.MetricDefinition Methods readsPrec :: Int -> ReadS MetricDefinition # readList :: ReadS [MetricDefinition] # readPrec :: ReadPrec MetricDefinition # readListPrec :: ReadPrec [MetricDefinition] #
Show MetricDefinition Source #
Instance details Defined in Amazonka.Rum.Types.MetricDefinition Methods showsPrec :: Int -> MetricDefinition -> ShowS # show :: MetricDefinition -> String # showList :: [MetricDefinition] -> ShowS #
NFData MetricDefinition Source #
Instance details Defined in Amazonka.Rum.Types.MetricDefinition Methods rnf :: MetricDefinition -> () #
Eq MetricDefinition Source #
Instance details Defined in Amazonka.Rum.Types.MetricDefinition Methods (==) :: MetricDefinition -> MetricDefinition -> Bool # (/=) :: MetricDefinition -> MetricDefinition -> Bool #
Hashable MetricDefinition Source #
Instance details Defined in Amazonka.Rum.Types.MetricDefinition Methods hashWithSalt :: Int -> MetricDefinition -> Int # hash :: MetricDefinition -> Int #
type Rep MetricDefinition Source #
Instance details Defined in Amazonka.Rum.Types.MetricDefinition type Rep MetricDefinition = D1 ('MetaData "MetricDefinition" "Amazonka.Rum.Types.MetricDefinition" "amazonka-rum-2.0-2UnkV4TSIBwJW5RXOw3bOY" 'False) (C1 ('MetaCons "MetricDefinition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dimensionKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "eventPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "unitLabel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "valueKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "metricDefinitionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newMetricDefinition Source #

Arguments

:: Text	`$sel:metricDefinitionId:MetricDefinition'`
-> Text	`$sel:name:MetricDefinition'`
-> MetricDefinition

Create a value of MetricDefinition 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:dimensionKeys:MetricDefinition', metricDefinition_dimensionKeys - This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

$sel:eventPattern:MetricDefinition', metricDefinition_eventPattern - The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

$sel:unitLabel:MetricDefinition', metricDefinition_unitLabel - Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

$sel:valueKey:MetricDefinition', metricDefinition_valueKey - The field within the event object that the metric value is sourced from.

$sel:metricDefinitionId:MetricDefinition', metricDefinition_metricDefinitionId - The ID of this metric definition.

$sel:name:MetricDefinition', metricDefinition_name - The name of the metric that is defined in this structure.

metricDefinition_dimensionKeys :: Lens' MetricDefinition (Maybe (HashMap Text Text)) Source #

This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.

metricDefinition_eventPattern :: Lens' MetricDefinition (Maybe Text) Source #

The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.

If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.

metricDefinition_unitLabel :: Lens' MetricDefinition (Maybe Text) Source #

Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.

metricDefinition_valueKey :: Lens' MetricDefinition (Maybe Text) Source #

The field within the event object that the metric value is sourced from.

metricDefinition_metricDefinitionId :: Lens' MetricDefinition Text Source #

The ID of this metric definition.

metricDefinition_name :: Lens' MetricDefinition Text Source #

The name of the metric that is defined in this structure.