---
title: "Setting Up RUM with PHP"
slug: "enabling-rum-in-the-php-profiler"
updated: 2021-11-10T20:37:38Z
published: 2021-11-10T20:37:38Z
canonical: "docs.stackify.com/enabling-rum-in-the-php-profiler"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackify.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Setting Up RUM with PHP
This document details how to enable **RUM** for the APM Profiler in your **PHP** application running on **Linux**.
## Prerequisites
### 1. Install the Latest Version of the Agent
Required Agent Version
- Linux Agent v2.31+
- PHP Profiler 1.13.0+
- **Linux** - Follow the [Retrace Linux Install](/docs/linux-installation) Guide.
PHP on Windows is currently not supported
### 2. Enable RUM
Follow the [RUM Getting Started guide](https://docs.stackify.com/v1/docs/real-user-monitoring) to **Enable RUM on your account**
### 3. Setup APM for your Application
Follow the [PHP Getting Started Guide](https://docs.stackify.com/docs/php-getting-started) to configure the profiler for your specific setup. The profiler will need to be properly configured for RUM to function.
### 4. Configure the RUM Key
In order to identify the data coming from your application pages is tied to your account, you need to make your RUM Key available to your application. This setting is passed to your application via an environment variable, `RETRACE_RUM_KEY`.
**Linux** Set the RETRACE_RUM_KEY environment variable so that it is available to the application when it launches.
**PHP Configuration** Set the `stackify.rum_key` in your php.ini or on your CGI/FPM settings getting passed on nginx or apache so that it is available to the application.
### 5. Inject Script into Page
The PHP profiler supports two methods to inject the script into your HTML pages.
**Automatic Injection** Automatic Injection is enabled by setting `stackify.rum_enabled` in your `php.ini file` or CGI/FPM settings or directives with your webserver.
**Manual Injection via APM** The manual injection method requires that an API call to the Profiler is inserted into the HTML files without any quoting of the injectected string. You can call the `Stackify\Profiler::insertRumScript()` method and require your profiler to be active.
```
Title
…
```
This API method is available in `stackify-php-apm` versions **1.13.0 and greater**.
**Manual Injection via API** The manual injection method requires that an API call to the Profiler is inserted into the HTML files without any quoting of the injected string. You can call the \Stackify\Utils\Rum::getInstance()->insertRumScript() method and require your profiler to be active at the moment.
**Setup:**
```
setupConfiguration(
$applicationName,
$environment,
$rumKey
);
```
```
insertRumScript(); ?>
Title
…
```
This API method is available in stackify/logger versions **1.15.0 and greater**.
### 6. Redeploy your App
Once the previous steps to enable RUM for your account and add the code snippet to your app(s) have been completed, the last step is to deploy the changes to your application.
## Viewing RUM Data
Once the following steps have been taken to set up RUM for your apps, data will be reported in the corresponding [App Dashboard](https://docs.stackify.com/v1/docs/account-application-dashboard-overview). To see more information related to what RUM data is presented in the App Dashboard, see the [Viewing RUM Data in Retrace](https://docs.stackify.com/v1/docs/viewing-rum-data-in-retrace) help doc.