MetricDefinition

import type { MetricDefinition } from "https://aws-api.deno.dev/v0.4/services/rum.ts?docs=full";

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.

interface MetricDefinition {

DimensionKeys?: {

[key: string]: string | null | undefined;

} | null;

EventPattern?: string | null;

MetricDefinitionId: string;

Name: string;

Namespace?: string | null;

UnitLabel?: string | null;

ValueKey?: string | null;

}

§Properties

DimensionKeys?: {

[key: string]: string | null | undefined;

} | null

[src]

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?: string | null

[src]

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.

MetricDefinitionId: string

[src]

The ID of this metric definition.

Name: string

[src]

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

Namespace?: string | null

[src]

If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.

UnitLabel?: string | null

[src]

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?: string | null

[src]

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