Class CfnAppMonitor.MetricDefinitionProperty
Specifies one custom metric or extended metric that you want the CloudWatch RUM app monitor to send to a destination.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.RUM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class MetricDefinitionProperty : Object, CfnAppMonitor.IMetricDefinitionProperty
Syntax (vb)
Public Class MetricDefinitionProperty
Inherits Object
Implements CfnAppMonitor.IMetricDefinitionProperty
Remarks
Valid destinations include CloudWatch and Evidently.
By default, RUM app monitors send some metrics to CloudWatch . These default metrics are listed in CloudWatch metrics that you can collect.
In addition to these default metrics, you can choose to send extended metrics or custom metrics or both.
You can't send custom metrics to the AWS/RUM
namespace. You must send custom metrics to a custom namespace that you define. The namespace that you use can't start with AWS/
. CloudWatch RUM prepends RUM/CustomMetrics/
to the custom namespace that you define, so the final namespace for your metrics in CloudWatch is RUM/CustomMetrics/ your-custom-namespace
.
For information about syntax rules for specifying custom metrics and extended metrics, see MetridDefinitionRequest in the CloudWatch RUM API Reference .
The maximum number of metric definitions that one destination can contain is 2000.
Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension value counts as a custom metric.
If some metric definitions that you specify are not valid, then the operation will not modify any metric definitions even if other metric definitions specified are valid.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RUM;
var metricDefinitionProperty = new MetricDefinitionProperty {
Name = "name",
// the properties below are optional
DimensionKeys = new Dictionary<string, string> {
{ "dimensionKeysKey", "dimensionKeys" }
},
EventPattern = "eventPattern",
Namespace = "namespace",
UnitLabel = "unitLabel",
ValueKey = "valueKey"
};
Synopsis
Constructors
MetricDefinitionProperty() |
Properties
DimensionKeys | This field is a map of field paths to dimension names. |
EventPattern | The pattern that defines the metric. |
Name | The name of the metric that is defined in this structure. |
Namespace | If you are creating a custom metric instead of an extended metrics, use this parameter to define the metric namespace for that custom metric. |
UnitLabel | Use this field only if you are sending this metric to CloudWatch . |
ValueKey | The field within the event object that the metric value is sourced from. |
Constructors
MetricDefinitionProperty()
public MetricDefinitionProperty()
Properties
DimensionKeys
This field is a map of field paths to dimension names.
public object DimensionKeys { get; set; }
Property Value
System.Object
Remarks
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
The pattern that defines the metric.
public string EventPattern { get; set; }
Property Value
System.String
Remarks
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.
Name
The name of the metric that is defined in this structure.
public string Name { get; set; }
Property Value
System.String
Remarks
Namespace
If you are creating a custom metric instead of an extended metrics, use this parameter to define the metric namespace for that custom metric.
public string Namespace { get; set; }
Property Value
System.String
Remarks
Do not specify this parameter if you are creating an extended metric.
You can't use any string that starts with AWS/
for your namespace.
UnitLabel
Use this field only if you are sending this metric to CloudWatch .
public string UnitLabel { get; set; }
Property Value
System.String
Remarks
It defines the CloudWatch metric unit that this metric is measured in.
ValueKey
The field within the event object that the metric value is sourced from.
public string ValueKey { get; set; }
Property Value
System.String