Azure App Services
Azure Service Plan Requirements
We recommend Standard (S), Premium (P), or Isolated (I) App Service Plan, with 2 or more CPU Cores, and AlwaysOn feature.
It may be possible to use Basic (B) Service Plan or plans with 1 CPU Core; however, we cannot guarantee support for these scenarios. The Free (F) and Shared (D) Service Plans cannot be used, as AlwaysOn is not a supported feature.
note: Currently, our Azure App Services APM extension supports .NET Framework / .NET 6+
note: During the installation of the Azure App Service Extension, a port between 2700 and 2790 is selected for the Agent Management Service, while a port between 3000 and 3090 is chosen for communication between the Agent and the Profiler. This arrangement is due to Azure App Services' port allocation policy, which dictates that no two apps or deployment slots can share the same port. Should you have any concerns regarding these ports, please do not hesitate to contact us.
Important
- Application Insights extension must be disabled.
- AlwaysOn option must be enabled.
- The MySQL In App feature is off.
- Installing / Updating the extension requires your Application to be Stopped/Started or Restarted.
Installation and Configuration Steps
Step 1 - Initial Setup and API Key Configuration
-
Open your web browser and visit the Azure Portal at https://portal.azure.com.
-
In the portal, search for your App Service and access the Application Settings option, which can be found under the
Settings > Configuration section
-
To register the agent, you will require an API key. If you haven't already, create a new application in Raygun and proceed to the APM setup screen > Application settings to obtain your API key.
-
In the Azure Application Settings, add a new setting named Raygun_ApiKey, and set its value to the API key you obtained in Step 3.
-
Save the changes made to the application settings to complete the configuration process.
Step 2 - Enabling the 'Always On' Feature
To ensure continuous operation, you must enable the Always On
Azure feature. To make this change, follow these steps:
-
In the Azure Portal, navigate to your App Service's Configuration page.
-
Locate the
Always On
option found in General Settings and set its value toOn
. -
Save your changes after modifying the setting.
Step 3 - Installing the Raygun APM Agent
To install the Raygun APM agent, follow these steps:
-
In the Azure Portal, access your App Service and find the Extensions menu option, located under the Development Tools section.
-
Click the
Add
button to view the available extensions. -
From the list of extensions, select the
.NET Raygun APM
option. -
Proceed by clicking
OK
to accept the legal terms, and clickOK
once more to initiate the installation of the extension.
Step 4 - Restarting the App Service
With the Raygun Agent successfully installed, you must restart your Azure App Service. Restarting the service allows the applicationHost transformation to occur, which in turn enables the Profiler to attach and begin monitoring your application.
To ensure optimal performance and accurate profiling, do not skip this essential step of restarting your Azure App Service.
note: To minimize potential disruption to your service, consider implementing this process in a deployment slot. Once the changes are applied and tested, you can swap the deployment slot into production, thus reducing the risk of affecting your live application.
Next Step
After following the steps above (including restarting your application), the profiling of .NET Framework / .NET 6+ sites will begin straight away!
If profiling does not start, please review the Azure App Services Troubleshooting guide.