monitor-your-unreal-engine-application.mdx

title	tags	metaDescription	isTutorial	freshnessValidatedDate
Monitor your Unreal Engine mobile app	Unreal Engine Mobile monitoring New Relic Mobile Unreal Engine Get started	New Relic's Unreal Engine for Android and iOS: Features, compatibility, requirements, installation, and upgrade procedures.	true	2024-04-05

import mobileHybridSummary from 'images/mobile_screenshot-full_hybrid-summary.webp'

import unrealGuidedInstall from 'images/newrelic_unreal_sdk_installation.webp'

import unrealAgentAppTokenSetup from 'images/newrelic_unreal_sdk_configuration.webp'

import mobileHandledExceptionsSummary from 'images/mobile_screenshot-full_handled-exceptions-summary.webp'

Our New Relic Unreal Engine Plugin monitors your Unreal Engine mobile app and provides deep insights into your app's performance, errors, and user experience. Once you install and configure the Unreal Engine Plugin, you'll be able to:

• Capture C++ errors: Quickly identify and fix problems.
• Create custom events and metrics: Understand how your users interact with your app.

<img title="Unreal Engine summary view in the UI" alt="Summary view of a Unreal Engine app in New Relic" src={mobileHybridSummary} style={{ maxWidth: '70%' }} />

**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Mobile > (select an app) > Summary**: View Unreal Engine data, and errors, and monitor how your app is performing over time.

Manual installation [#manual-install]

If you need to install the plugin manually, follow the steps below.

### Review the requirements [#requirements] Before you install the Unreal Engine Plugin, make sure your Unreal Engine app meets these version requirements: * For Android-native apps: * Android API 24 or higher * See [Android-native requirements](/docs/mobile-monitoring/new-relic-mobile-android/get-started/new-relic-android-compatibility-requirements) * For iOS-native apps: * See [iOS-native requirements](/docs/mobile-monitoring/new-relic-mobile-ios/get-started/new-relic-ios-compatibility-requirements) ### Add the agent to your project [#add-agent]

1. In your project's root directory, create a folder named Plugins.
2. Copy the NewRelic folder on Github. You should have something like

  MyProject
  ├── Plugins
          └── NewRelic
              └── NewRelic.uplugin

Click **Restart Now** to continue with additional configuration. To allow interfacing between the agent and your C++ code, add `NewRelic` to the list of dependencies in your game module’s `.Build.cs` file: ### Add application token(s) [#app-token]

To authenticate your Unreal Engine app's data with New Relic, add your application token(s) using one of these options:

• In your project settings under Plugins → NewRelic, paste your app tokens(s) in the New Relic App Token field(s). If you want to have separate New Relic mobile apps (one of Android and one for iOS), then you'll need to add both app tokens.

  <img title="App token fields in Unreal editor" alt="Screenshot of app token fields in project settings" src={unrealAgentAppTokenSetup} style={{ maxWidth: '70%' }} />

• In your Config/DefaultEngine.ini file, add the following to /Script/NewRelic.NewRelicSDKSettings, making sure add your own app token(s):

  newrelicAppToken=application-token
  newrelicAppTokenIOS=ios-application-token
  

Customize the agent instrumentation [#mobile-sdk]

Need to customize your agent instrumentation? Our public mobile SDK API methods let you collect custom data, configure default settings, and more.

The following customizations are available for the Unreal Engine Plugin.

  <th>
    Use this method
  </th>
</tr>

  <td>
    [Record breadcrumbs](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-breadcrumb/#unreal)
  </td>
</tr>

<tr>
  <td id="creating">
    Track a method as an interaction.
  </td>

  <td>
    [Start interactions](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/start-interaction/#unreal)

    [Stop interactions](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/stop-interaction/#unreal)
  </td>
</tr>

<tr>
  <td id="create-custom">
    Record custom metrics.
  </td>

  <td>
    [Record custom metrics](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-custom-metrics//#unreal)
  </td>
</tr>

<tr>
  <td id="create-custom">
    Record an exception.
  </td>

  <td>
    [Record errors](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-handled-exceptions/#unreal)
  </td>

</tr>
<tr>
  <td id="attributes-events-insights">
    Record custom attributes and events.
  </td>

  <td>
    There are several ways to report custom attributes and events:

      * [Record custom attributes](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/create-attribute/#unreal)
      * [Increment session attribute count](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/increment-session-attribute-count/#unreal)
      * [Remove an attribute](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/remove-attribute/#unreal)
      * [Remove all attributes](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/remove-all-attributes/#unreal)
      * [Record custom events](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/record-custom-events/#unreal)
      * [Set the maximum size of an event pool](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/set-max-event-pool-size/#unreal)
      * [Set maximum time the agent stores events in memory](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/set-max-event-buffer-time/#unreal)
      * [Get a current session's ID](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/current-session-id/#unreal)
      * [Set a custom user ID to associate with events and attributes](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/set-custom-user-id/#unreal)

To determine which method to use, see Report mobile monitoring custom events and attributes.

<tr>
  <td>
    Shut down the agent.
  </td>

  <td>
    [Shut down the agent](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/shut-down-agent/#unreal)
  </td>
</tr>
<tr>
  <td>
    Run a test crash report.
  </td>

  <td>
    [Test crash reporting](/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/test-crash-reporting/#unreal)
  </td>
</tr>

If you want to...
Record breadcrumbs to track app activity that may be helpful for troubleshooting crashes.

Monitor C++ errors [#monitor-errors]

In the New Relic UI, you can view your fatal and non-fatal C++ errors and handled exceptions, including details like event trails, attributes, and stack traces for each recorded error.

To view your errors:

1. Go to one.newrelic.com > All capabilities > Mobile.
2. Select your Unreal Engine app.
3. Click Exceptions > Handled exceptions.

You can also build a dashboard for these errors using this query:

SELECT * FROM MobileHandledException SINCE 24 hours ago

For more information on NRQL queries, see Introduction to NRQL.