Business event capture

powered by Grail

To get started with business events, you first need to define the scope of the data you want to capture. The approach depends on the source of the business events.

There are three sources for business events.

• OneAgent

  Configure using the Dynatrace menu to add capture rules, triggers, data fields, and more.

• Web and mobile RUM

  Obtain RUM business events by leveraging a dedicated method of the RUM JavaScript API, OneAgent for mobile, or OpenKit.

• External sources

  Configure external business or IT systems to send business events in JSON format to the business events API (REST endpoint).

Get business events via OneAgent

OneAgent version 1.253+

To capture business events using OneAgent, you need to first enable the feature.

1. From the Dynatrace menu, go to Settings > Preferences > OneAgent features.

2. Enable the OneAgent business events feature for the technologies appropriate for your environment.

   You need to restart the application process before you can capture business events from that process.

Configuration requires one or more capture rules that consist of triggers, mandatory data fields, and optional event data fields.

The table below contains examples of mandatory (event.type, event.provider) and optional (event.category) data fields.

Supported technologies

Supported technologies are listed in the table below.

Configure business event sources on OneAgent

OneAgent version 1.253+

To configure business event sources on OneAgent

1. From the Dynatrace menu, go to Settings > Business Analytics > Business Event Sources > OneAgent.

2. Select Add new capture rule and name your rule.

3. Select Add trigger to define a condition that will be used to trigger a business event.

   Determine the data source for your trigger, such as Body, Path, or HTTP header, and then select an operator and define a value. This allows you to match content retrieved from the source to the value you define. When OneAgent matches the trigger, a business event is generated.

   • The Summary tab displays the entire trigger rule (for example, Request - Path starts with '/api/trade/BuyAssets).
   • By default, the search for value is not case sensitive. Turn on Case sensitive if you want your trigger to consider the case of the source.
   • Triggers are connected by AND logic; if you set multiple trigger rules, all of them need to be fulfilled to capture a business event.
   • The first matching rule get executed per Agent per request.
   • We recommend that you set specific trigger rules. If a trigger rule is too general and results in multiple identical rule matches, you will get multiple business events.

4. Select the Event provider source and value.

   This describes the source of the event, such as www.easytrade.com. The data source for this field can be a fixed value that you provide or it can be extracted from the event.

5. Select Event type source and value.

   This describes the type of event the event provider is sending, such as Asset purchase.

6. optional Select Event category source and value to add helpful context to the event (for example, add a stock exchange name such as NASDAQ).

   This step concludes the configuration of a business event that will be generated each time the trigger criteria are matched. This might be sufficient if all you need is to count the number of matching events (for example, to answer the question of how many asset purchases were made). In most cases, however, you will want to add event attributes for more granular insight (described in the step below). Attributes are data fields extracted from the event JSON payload.

7. Select Add data field in Event data. Provide a field name, and then provide the data source and value from the JSON payload. This describes the attribute-value pair that will be associated with the event, such as accountId, amount, instrumentId, or price. Adding such pairs can help you answer more complex questions, such as how many accounts purchased a particular asset, which assets are purchased most often, or which accounts make the largest asset purchases.

   Example buy-asset request JSON file

   jsoncopydownload
   {
      "accountId":6,
      "amount":10,
      "instrumentId":1,
      "price":157.025
   }

8. Select Save changes.

Example of data extraction

The following table shows additional examples of how to extract data from incoming JSON payloads.

Get business events from RUM

Business events are available for all Dynatrace RUM technologies (web RUM, mobile RUM, and OpenKit). RUM business events can be obtained by leveraging a dedicated method of the RUM JavaScript, OneAgent for mobile, or OpenKit.

To enable RUM business events, contact a Dynatrace product expert.

To start a conversation with a Dynatrace product expert, use live chat within your Dynatrace environment.

Check the sections below for instructions on how to report business events for different platforms.

RUM JavaScript

Android

iOS

Cordova¹

Xamarin

Flutter

.NET MAUI

React Native

OpenKit

jsoncopydownload
let attributes = {
    "event.name": "Confirmed Booking",
    "page": "booking-confirmation",
    "product": "Danube Anna Hotel",
    "amount": 358.35,
    "currency": "USD",
    "reviewScore": 4.8,
    "arrivalDate": "2022-11-05",
    "departureDate": "2022-11-15",
    "journeyDuration": 10,
    "adultTravelers": 2,
    "childrenTravelers": 0
};

dynatrace.sendBizEvent('com.easytravel.funnel.booking-finished', attributes);