Documentation

This structure defines a metric that is being used to evaluate the variations during a launch or experiment.

See: newMetricDefinition smart constructor.

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:entityIdKey:MetricDefinition', metricDefinition_entityIdKey - The entity, such as a user or session, that does an action that causes a metric value to be recorded.

$sel:eventPattern:MetricDefinition', metricDefinition_eventPattern - The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

$sel:name:MetricDefinition', metricDefinition_name - The name of the metric.

$sel:unitLabel:MetricDefinition', metricDefinition_unitLabel - The label for the units that the metric is measuring.

$sel:valueKey:MetricDefinition', metricDefinition_valueKey - The value that is tracked to produce the metric.

The entity, such as a user or session, that does an action that causes a metric value to be recorded.

The EventBridge event pattern that defines how the metric is recorded.

For more information about EventBridge event patterns, see Amazon EventBridge event patterns.

The name of the metric.

The label for the units that the metric is measuring.

The value that is tracked to produce the metric.