Versions Compared

Old Version 18

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 19

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field Name

Description

DetailsThis 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.

Anchor
description
description
Description

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.

  • Prohibit Universal Event
    If the published event has any attributes that have not been defined in the template, the publish is rejected and not allowed.

  • Include Attributes
    Any extra attributes will be allowed and passed through as variables.

  • Exclude Attributes
    Any extra attributes are excluded and ignored. They will not be passed along as variables.

Attributes

Name, Label, and Type of each attribute.

  • Name
    Unique name for this attribute.

  • Label
    User-friendly display name for this attribute, to be displayed within the client.

  • Type
    Type of attribute:

    • Text

    • Integer

    • Float

    • Boolean

System EventIndication if this type of event is a System Event.
Metrics
Anchor
metrics
metrics

This section contains information about configuring metrics for a Universal Event Template.


Info

To enable OpenTelemetry metrics, you must configure an Open Telemetry metrics exporter in uc.properties , otherwise, a noop meter provider is used.


Anchor
metric type
metric type
Metric Type

Specifies the type of metric to instrument. Options are:

  • None

  • Counter

  • UpDownCounter

  • Histogram

Anchor
metric name
metric name
Metric Name

Specifies the metric name.

The metric name can be a maximum of 63 characters and should be universally unique, for example:

<event_name>[.<value_attribute>]

<extension>.<event_name>[.<value_attribute>]

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.

  • uc. and uc_

  • ua. and ua_

  • uac. and uac_

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.

Anchor
metric unit
metric unit
Metric Unit

Specifies an optional unit of measure.

Maximum length of 63 ASCII characters. Units should follow the Unified Code for Units of Measure.

Anchor
metric label attributes
metric label attributes
Metric Label Attributes

Specifies a comma-delimited list of universal event attribute names to use for metric labels.

For example, attribute1,attribute2,attribute3

At most 8 label attributes can be specified.

Warning

Do not specify attributes with high cardinality (many different attribute values) or attributes that may contain sensitive information.


Optional Metric Labels

Specifies which system-supplied metric labels to include.

  • Agent Id

    • Label: agent.id

  • Business Services

    • Label: security.business_services

  • Task Name

    • Label: task.name

Note

The Task Name value will be represented by the unresolved task name at launch time to avoid the high cardinality of resolved task instance names.

If multiple business services are assigned to the universal event, the Business Services value will be represented as a comma-delimited list of business services in alphabetical order.Be mindful that the Business Services metric label could have high cardinality depending on how you assign business service membership.


...