Business event enrichment
Dynatrace SaaS version 1.253+
Dynatrace automatically enriches business events with additional context to enhance analysis and facilitate drill-down navigation. Specifically, Dynatrace adds certain properties to your business events, for example, information on geolocation, operating system, application, and more. You can then use Dynatrace Query Language (DQL) to analyze your business events.
OneAgent and external business event enrichment
Fields defined in the table below can be used to enrich business events. Some fields are automatically added depending on their source (OneAgent or API).
Key
Added via
Description
Example
Data type
timestamp1
OneAgent
Time when the event originated, typically when it was created by the source2
11/21/2022 8:53:58 AM
timestamp
time1
API
Time when the event originated, typically when it was created by the source2
11/21/2022 8:53:58 AM
timestamp
dt.entity.host
OneAgent
Host where OneAgent captured the event
HOST-2F700D78236C40D6
string
dt.entity.process_group_instance
OneAgent
Process group instance where OneAgent captured the event
PROCESS_GROUP_INSTANCE-6E5F1839CADBEC98
string
event.id3
OneAgent
API
Unique identifier of the event autogenerated by Dynatrace (for OneAgent)
iejRl3Li8kN_7uIekdUvQ
string
event.kind
OneAgent
API
High-level kind of the event; the field is always set to BIZ_EVENT regardless of the ingested value.
BIZ_EVENT
string
event.provider1
OneAgent
API
Source of the event, for example, the name of the component or system that generated the event; the default value is Unknown.
www.easytrade.com
string
event.type1
OneAgent
API
Event type identifier; the default value is Unknown.
com.easytrade.get-instruments
string
event.category
OneAgent
API
Event category; the default value is Other.
Other
string
span_id
OneAgent
ID of the request as known by the caller; autogenerated by Dynatrace
c1a6d280f407fba9
string
trace_id
OneAgent
ID of the whole trace forest that is used to uniquely identify a distributed trace through a system; autogenerated by Dynatrace
c21f35f1c5a639eef472961f0513ead8
string
trace_sampled
OneAgent
Indicates if the caller has recorded the trace data; autogenerated by Dynatrace
TRUE
bool
traceparent
OneAgent
Field that identifies the incoming request in a tracing system; autogenerated by Dynatrace
00-c21f35f1c5a639eef472961f0513ead8-c1a6d280f407fba9-01
string
Not an enriched field per se, but required by the Dynatrace internal schema
If no original timestamp is available, it's populated at ingest time.
Set by OneAgent and required by CloudEvents specification, but not enforced by the Dynatrace internal schema
RUM business event enrichment
Business events reported via RUM are enriched with fields relevant to the device and user, such as geolocation, device, browser, and application. The following fields are added automatically, depending on the application type—web or mobile.
Top-level fields
The top-level fields contain generally relevant information for all events and data points.
If no original timestamp is available, it's populated at ingest time.
Unix timestamp in nanoseconds
Event fields
The event namespace contains common identification, categorization, and context on events in Dynatrace.
Key
Description
Example
Data type
Override possible
Required or optional
Available for
event.id
Unique identifier of the event
5547782627070661074_1647601320000
string
req
event.kind
High-level kind of the event
BIZ_EVENT
string
opt
event.provider
Source of the event, for example, the name of the component or system that generated the event2
www.easytravel.com
string
opt
Not enriched automatically; you set it via API when you report a business event.
Full domain name for web, app bundle for mobile, and application ID for OpenKit
Dynatrace RUM fields
The dt.rum namespace contains Dynatrace RUM-specific fields.
Key
Description
Example
Data type
Override possible
Required or optional
Available for
Also known as the internal user ID or visitor ID
If available
Device fields
The device namespace contains information on the device running an application.
Key
Description
Example
Data type
Override possible
Required or optional
Available for
device.manufacturer
Name of the device manufacturer
Apple
string
opt
device.model.identifier
Model identifier of the device
iPhone3,4
string
opt
device.is_rooted
Indicates if a rooted device was detected.
true
bool
opt
OS fields
The os namespace contains information on the operating system running an application.
Key
Description
Example
Data type
Override possible
Required or optional
Available for
os.name
Operating system name
iOS
string
opt
os.version
Operating system version
15.3.1
string
opt
Browser fields
The browser namespace contains information on the browser running an application.
Key
Description
Example
Data type
Override possible
Required or optional
Available for
browser.name
Browser name
Mozilla
string
opt
browser.version
Detected browser version
5.0
string
opt
browser.user_agent
Full user agent string as provided by the browser
Mozilla/5.0 (Windows NT 10.0; Win64; x64)
string
opt
Possible values: desktop, mobile, tablet, robot, other
Client fields
The client namespace contains information on the initiator of a network connection.
Key
Description
Example
Data type
Override possible
Required or optional
Available for
client.ip
IP address of the client (IPv4 or IPv6)
126.32.196.104
string
opt
Application fields
The app namespace contains information on the application sending the business event.
Key
Description
Example
Data type
Override possible
Required or optional
Available for
app.version
Full machine-readable version of the application
5.23.15789
string
opt
app.short_version
Short human-readable version of the application
5.23
string
opt
app.bundle
Name of the bundle or package
com.example.easytravel
string
opt
Geolocation fields
The geo namespace contains geolocation information.
Key
Description
Example
Data type
Override possible
Required or optional
Available for
geo.continent.name
Full continent name
North America
string
opt
geo.country.name
Full country name
Canada
string
opt
geo.region.name
Full region name
Quebec
string
opt
geo.city.name
Full city name
Montreal
string
opt