.NET

This guide walks you through setting up Application Performance Monitoring (APM) on a .NET application. These instructions can also be found on the Installation page in your Middleware Account. View example code here.

Prerequisites

dotnet --version

Install

Step 1: Setup Middleware .NET Project

Download the latest Middleware.dll and add the following code in the .csproj file.

XML

<ItemGroup>
  <Reference Include="Middleware">
    <HintPath>path\to\Middleware.dll</HintPath>
  </Reference>
</ItemGroup>

Step 2: Install .NET APM Package

curl -sSfL https://install.middleware.io/apm/dotnet/v1.0.0-rc.1/scripts/mw-dotnet-auto-install.sh -O

sh ./mw-dotnet-auto-install.sh
rm -f mw-dotnet-auto-install.sh

chmod +x $HOME/.mw-dotnet-auto/instrument.sh

MW_API_KEY="<MW_API_KEY>" \
  . $HOME/.mw-dotnet-auto/instrument.sh && \
  OTEL_SERVICE_NAME="{APM-SERVICE-NAME}" \
  dotnet path/to/YourApplication.dll

$install = Join-Path $env:temp "mw-dotnet-auto-install-setup.ps1"
Invoke-WebRequest -Uri "https://install.middleware.io/apm/dotnet/v1.0.0-rc.1/scripts/mw-dotnet-auto-install-setup.ps1" -OutFile $install -UseBasicParsing

. $install

Register-OpenTelemetryForCurrentSession -OTelServiceName "{APM-SERVICE-NAME}"

.\YourNetApp.exe

RUN apt-get update && apt-get install -y curl unzip
RUN curl -sSfL https://install.middleware.io/apm/dotnet/v1.0.0-rc.1/scripts/mw-dotnet-auto-install.sh -O 
RUN bash mw-dotnet-auto-install.sh 
RUN rm -rf mw-dotnet-auto-install.sh
RUN chmod +x $HOME/.mw-dotnet-auto/instrument.sh
...........
CMD . $HOME/.mw-dotnet-auto/instrument.sh && dotnet Mw-WebApplication.dll

MW_AGENT_SERVICE=172.17.0.1
MW_API_KEY="<MW_API_KEY>"

ASPNETCORE_HTTP_PORTS=5000
ASPNETCORE_URLS=http://0.0.0.0:5000

RUN apt-get update && apt-get install -y curl unzip
RUN curl -sSfL https://install.middleware.io/apm/dotnet/v1.0.0-rc.1/scripts/mw-dotnet-auto-install.sh -O 
RUN bash mw-dotnet-auto-install.sh 
RUN rm -rf mw-dotnet-auto-install.sh
RUN chmod +x $HOME/.mw-dotnet-auto/instrument.sh
...........
CMD . $HOME/.mw-dotnet-auto/instrument.sh && dotnet Mw-WebApplication.dll

MW_AGENT_SERVICE=mw-service.mw-agent-ns.svc.cluster.local
MW_API_KEY="<MW_API_KEY>"

Sending Custom Data [Optional]

Enable Custom Logs

Add the following functions:

C#

using Middleware.Logger;
...
Logger.Info("This is info log");
Logger.Warning("This is info log");
Logger.Debug("This is info log");
Logger.Error(<Object of Exception>);

Add packages to YourApp.csproj file

XML

<Project Sdk="Microsoft.NET.Sdk.Web">    
    ...
    <ItemGroup>
      <PackageReference Include="OpenTelemetry" Version="1.5.1" />
      <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.5.1" />
    </ItemGroup>
    ...
</Project>

Enable Logs in your project.cs file

index.cs

C#

using OpenTelemetry.Logs;
using OpenTelemetry.Resources;
...

var builder = WebApplication.CreateBuilder(args);
 
builder.Logging.AddOpenTelemetry(options => 
{
    options.AddConsoleExporter();
});

View more

Continuous Profiling

Continuous profiling captures real-time performance insights from your application to enable rapid identification of resource allocation, bottlenecks, and more. Navigate to the Continuous Profiling section to learn more about using Continuous Profiling with the .NET APM.

.NET Nuget Packge APM Configuration

Step 1: Install the Required Package

Add the Middleware package to your .NET project by running the following command using CLI:

dotnet add package MW.APM --version 1.1.1

OR

If you are using Visual Studio IDE in Windows, then you can install it by going to below given path.

PATH - Tools > Nuget Package Manager > Manage Nuget Packages for Solutions > Browse

Now, search for MW.APM and Install the nuget package.

Step 2: Add Code Configuration

Add the following code to your Program.cs file:

Program.cs

C#

var configuration = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
    .AddEnvironmentVariables()
    .Build();

builder.Services.ConfigureMWInstrumentation(configuration);

builder.Logging.AddConfiguration(configuration.GetSection("Logging"));
builder.Logging.AddConsole();

View more

Step 3: Configure Your Middleware Account Information

Add the following to your appsettings.json file:

"MW": {
  "ApiKey": "<MW_API_KEY>",
  "TargetURL": "https://<MW_UID>.middleware.io:443",
  "ServiceName": "<service-name>",
  "ProjectName": "<project-name>",
  "ConsoleExporter": "true",
  "ExcludeLinks": "[\"https://localhost:3000/health\"]",
  "ApmCollectMetrics": "true",
  "ApmCollectTraces": "true",
  "ApmCollectLogs": "true"