This document contains detailed descriptions of resources and procedures that are referenced in the New Relic .NET agent install procedures.
This document is not meant to be read as a standalone document. For install instructions, see Introduction to .NET agent install.
New Relic’s .NET agent relies on the Microsoft profiling API to report data from your .NET application.
.NET monitoring solutions other than New Relic can use this profiling API. But only one service can use the profiler at a time. This means that if you have used a .NET monitoring service in the past and haven’t completely disabled/removed it, the profiler may still be in use, which will cause profiler conflicts when you try to enable the .NET agent.
To manually install the agent using a ZIP file, choose the correct file for the application you wish to monitor:
Go to the .NET agent download site and get the file matching your application's runtime and architecture:
- .NET Framework (32-bit):
- .NET Framework (64-bit):
- .NET Core (32-bit):
- .NET Core (64-bit):
- .NET Framework (32-bit):
Unzip the agent folder in the desired location.
Set environment variables for the process you wish to monitor.
We do not recommend setting these environment variables globally. Setting these environment variables globally can cause all .NET processes running on the system to get instrumented and report to New Relic. If you are installing the agent manually, we expect that you have the means to set these environment variables only for the processes you wish to monitor.
Restart your application. If using IIS, restart IIS.
If your application is receiving traffic, data should appear within a few minutes. If it doesn't, see No data appears.
If your .NET application uses an application framework that is not automatically instrumented, or if the app has no framework (like a console app), after the install you will need to manually set up instrumentation of your app. Here are the steps to do that:
- Follow the relevant install instructions for your application and framework.
- Custom instrument your application to define what activity is reported to New Relic.
A .NET agent install requires setting environment variables. For some install procedures (like for IIS-hosted .NET applications), these environment variables are set automatically. For other install procedures, you will have to manually set them. To see the required environment variables for both .NET Framework and .NET Core applications, see Environment variables.
For installations requiring you to manually set environment variables, you can also set other configuration options via environment variables. Here's a look at two that are commonly set:
License key. The environment variable for setting the New Relic license key is:
NEW_RELIC_LICENSE_KEY = YOUR_LICENSE_KEY
App name. Setting a meaningful application name is recommended, but you can also set this after install. The environment variable is:
NEW_RELIC_APP_NAME = YOUR_APP_NAME
The scriptable installers are ZIP archives containing a PowerShell script for installing the .NET agent. There is a separate zip archive for .NET Framework versus .NET Core.
We recommend using the MSI installer over the scriptable installer. If you want to automate your install, consider running the MSI installer from the command line.
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's data security and licenses documentation.