Getting Started
  • 23 Jul 2020
  • 2 Minutes To Read
  • Contributors
  • Print
  • Share
  • Dark

Getting Started

  • Print
  • Share
  • Dark

Retrace offers many basic and advanced features. In this article we will try to outline all of the amazing things that Retrace can do for your .NET applications.

Step 1. Install Retrace

The first thing you need to do is install the Retrace monitoring agent on your server.

Standard Installs

Supported Linux Distributions
See Supported Technologies for distribution support details. Other distros may be successfully used, but have not been validated. Red Hat Enterprise Linux 6 is known not to work in the current release.
The Windows Profiler is currently in Beta

After following the steps in this guide, see additional information in the V2 .Net Profiler - BETA guide to get properly setup in a Windows environment .

Container Installs
Retrace supports multiple container based deployment scenarios.

Alpine Linux Support
Before using the new profiler on Alpine Linux, the libuuid package needs to be installed via apk add libuuid.

Step 2. Configure Your App

Retrace supports multiple application types. Based on your type of application, there may be some additional steps that are needed.

  • ASP.NET Core - Note: In the previous version of the Retrace .NET profiler for Windows, a Stackify middleware had to be added to your application. This is not required in this version of the profiler.
  • Background services - You must manually instrument your code to define transactions.

Set the Environment Variables Required by the Profiler


Setting the environment variables should only be required on Linux systems. In Windows these values are set by the agent automatically.

The .NET CLR requires environment variables to be set in order to load a profiler into a process. There are several ways to set these environment variables. Here is an example that only needs to be set once and will be available to each new process that loads without any additional steps.

  1. Open environment from the command-line
    sudo nano /etc/environment
  2. Add the environment variables
Configuring for systemd

If you are running your .NET Core application within systemd, you will need to modify conf file for your job.


Step 3. Name Your Application

Create a file named Stackify.json and save it in the deployment folder of your application.

    "AppName": "MyApp",
    "Environment": "Production"

Step 4. Send Your Logs to Retrace

You can send your applications logs to Retrace with multiple .NET logging frameworks. Be sure to send your logs to take full advantage of Retrace's error tracking and centralized logging features. Errors are also used as part of Retrace's "App Scoring" feature.

Step 5. Deployment Tracking

Notify Retrace when you do a new deployment to get advanced reporting features. This makes it easy to see how performance changes after a new deployment. Popular tools like Team City, Visual Studio Team Services, Octopus Deploy and others are supported. View our docs to learn more.

Disabling Tracing

If you want to temporarily disable collection of APM data, you can add a property to the Stackify.json file to cause the profiler to be disabled. This does not impact collection of logs that are sent to Retrace.

    "AppName": "MyApp",
    "Environment": "Production",
    "DisableTracing": true

Additional Topics

Was This Article Helpful?