...
Field Name | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
Details | This section contains assorted detailed information about a Universal Event Template. | ||||||||
Name | Name of this Universal Event. | ||||||||
Label | User-friendly display name for this event, to be displayed within the client. The Label must be unique for Global Events and unique within Local Events. | ||||||||
| Description of this event. | ||||||||
Time To Live | Default value for the length of time, in minutes, that the Universal Event data is valid. This value can be unspecified (null). The Time To Live value can be overridden in the published event. If the Time To Live does not exist in the published event, then this value, if defined, will be used. If neither value exists, the Time To Live is 0, which means the event is deleted as soon as it is published. | ||||||||
Unmapped Attributes Policy | Defines how unmapped/unknown attributes that are in the published event are handled.
| ||||||||
Attributes | Name, Label, and Type of each attribute.
| ||||||||
System Event | Indication if this type of event is a System Event. | ||||||||
Metrics | This section contains information about configuring metrics for a Universal Event Template. | ||||||||
| Specifies the type of metric to instrument. Options are:
| ||||||||
| Specifies the metric name. The metric name can be a maximum of 63 characters and should be universally unique, for example:
The universal event Description will be used as the metric description. The following namespaces (prefixes) are reserved and cannot be used for user-defined metric names.
| ||||||||
Metric Value Attribute | Specifies the name of an Integer or Float universal event attribute to use for the metric value when incrementing the counter or recording a histogram value. If left unspecified, a counter will be incremented by 1, and a histogram will record a value of 1, for each published universal event. | ||||||||
| Specifies an optional unit of measure. Maximum length of 63 ASCII characters. Units should follow the Unified Code for Units of Measure. | ||||||||
| Specifies a comma-delimited list of universal event attribute names to use for metric labels. For example, At most 8 label attributes can be specified.
| ||||||||
Optional Metric Labels | Specifies which system-supplied metric labels to include.
|
...
If the OTEL metrics exporter is configured, for each Universal Event Template or Universal Template Event Template with a metrics designation, the following metric will be exported.
Name | <metric
| ||||||
---|---|---|---|---|---|---|---|
Type | Counter, UpDownCounter, or Histogram | ||||||
Description | The metric description is inherited from the Universal Event Template or Universal Template Event Template. | ||||||
Default Labels |
| ||||||
Optional Labels |
| ||||||
Example |
The |
...