Try it free

Custom properties

  • Latest Dynatrace
  • Reference

Custom properties in Dynatrace RUM refer to user events that are not automatically captured but are instead reported through the Dynatrace API. These properties include user identifier events, as well as event and session property events.

Standalone event properties

Semantic conventions for user event properties in Dynatrace RUM.

Query

This query searches for all user event properties events.

fetch user.events
| filter characteristics.has_event_properties == true

User event properties characteristics

AttributeTypeDescriptionExamples

characteristics.classifier

string

experimentalFixed value property.

property

characteristics.has_event_properties

boolean

stableFixed value true.

true

characteristics.is_api_reported

boolean

stableFixed value true.

true

User event properties

Event properties are custom-defined key-value pairs. Dynatrace RUM captures event properties as part of user journeys and uses these to enrich user events.

AttributeTypeDescriptionExamples

event_properties.__property_name__

record

stableContains the value for the event property named __property_name__ defined by the event and session property configuration. The data type of the value depends on the definition; default is data type string.

42; value

Basic user event fields

The basic attributes for all user events are defined in the user event base model.

Standalone session properties

Semantic conventions for user session properties in Dynatrace RUM.

Query

This query searches for all user session properties events.

fetch user.events
| filter characteristics.has_session_properties == true

User session properties characteristics

AttributeTypeDescriptionExamples

characteristics.classifier

string

experimentalFixed value property.

property

characteristics.has_session_properties

boolean

stableFixed value true.

true

characteristics.is_api_reported

boolean

stableAdditional characteristic: If set to true, the user event was sent using the Dynatrace API.

true

User session properties

Session properties are custom-defined key-value pairs. Dynatrace RUM captures session properties as part of user journeys and uses these to enrich user sessions.

AttributeTypeDescriptionExamples

session_properties.__property_name__

record

stableContains the value for the session property named __property_name__ defined by the event and session property configuration. The data type of the value depends on the definition; default is data type string.

session_properties.patientid:DFTR123455; session_properties.customers_cohort: premium

Basic user event fields

The basic attributes for all user events are defined in the user event base model. Be aware that standalone session properties cannot contain event properties that are part of the basic attributes.

Standalone user identifier

Semantic conventions for user identifiers in Dynatrace RUM.

Query

This query searches for all user identifier events.

fetch user.events
| filter characteristics.has_user_identifier

User identifier characteristics fields

AttributeTypeDescriptionExamples

characteristics.classifier

string

experimentalFixed value property.

property

characteristics.has_user_identifier

boolean

stableFixed value true.

true

characteristics.has_user_tag

boolean

**deprecatedReplaced with characteristics.has_user_identifier.**Primary characteristic: If set to true, the user event contains a user identifier.

true

characteristics.is_api_reported

boolean

stableAdditional characteristic: If set to true, the user event was sent using the Dynatrace API.

true

User identifier fields

AttributeTypeDescriptionExamples

user.identifier

string

stableThe user identifier for identifying individual users across different browsers, devices, and user sessions.Tags: sensitive-user-events

john.doe@dynatrace.com

Basic user event fields

The basic attributes for all user events are defined in the user event base model.