Project description

This project is to illustrate how to do autoinstrumentation on a dotnet deployed on IIS.

Run the project in console

# In Powershell
dotnet run

test call

# In Powershell
curl http://localhost:5100/api/books

Build to deploy on IIS

# In Powershell
dotnet publish --configuration Release

Copy bin/Release/net6.0/publish to physical path in IIS Manager.

Folder can be found here when clicking on explore in IIS Manager.

Install dotnet auto instrumentation

Download the following assets :

Online method

# in Powershell as administrator

$module_url = "https://raw.githubusercontent.com/open-telemetry/opentelemetry-dotnet-instrumentation/v1.0.2/OpenTelemetry.DotNet.Auto.psm1"
$download_path = Join-Path $env:temp "OpenTelemetry.DotNet.Auto.psm1"

# Download assets
Invoke-WebRequest -Uri $module_url -OutFile $download_path -UseBasicParsing

# importing &modules
Import-Module $download_path

# Install Otel core
Install-OpenTelemetryCore

# Register for IIS (this will cause IIS to restart)
Register-OpenTelemetryForIIS

Offline method

Import-Module OpenTelemetry.DotNet.Auto.psm1

Install-OpenTelemetryCore -LocalPath "C:\Path\To\opentelemetry-dotnet-instrumentation-windows.zip""

FYI : Full list with latest version

https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases

Run project with instrumentation

List of options accessible via Environment Variables

https://opentelemetry.io/docs/instrumentation/net/automatic/config/

Console mode


Register-OpenTelemetryForCurrentSession -OTelServiceName "MyServiceDisplayName"

$Env:OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317"
$Env:OTEL_EXPORTER_OTLP_PROTOCOL="grpc"

bin\Release\net6.0\MyBookstoreApi.exe

IIS mode

edit bin\Release\net6.0\publish\web.config before copying publish folder onto IIS

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <location path="." inheritInChildApplications="false">
    <system.webServer>
      <handlers>
        <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModuleV2" resourceType="Unspecified" />
      </handlers>
      <aspNetCore processPath="dotnet" arguments=".\MyBookstoreApi.dll" stdoutLogEnabled="false" stdoutLogFile=".\logs\stdout" hostingModel="inprocess" >
		  <environmentVariables>
			<environmentVariable name="OTEL_SERVICE_NAME" value="mybookstore" />
			<environmentVariable name="OTEL_EXPORTER_OTLP_ENDPOINT" value="http://localhost:4318" />
			<environmentVariable name="OTEL_RESOURCE_ATTRIBUTES" value="service.namespace=name,deployment.environment=production,service.instance.id=server-name,service.version=1.0.0" />
		  </environmentVariables>
	  </aspNetCore>
    </system.webServer>
  </location>
</configuration>

to see auto logs add these env vars with value true

$Env:OTEL_DOTNET_AUTO_LOGS_CONSOLE_EXPORTER_ENABLED="true"
$Env:OTEL_DOTNET_AUTO_METRICS_CONSOLE_EXPORTER_ENABLED="false"
$Env:OTEL_DOTNET_AUTO_TRACES_CONSOLE_EXPORTER_ENABLED="true"

add otel prometheus metrics

dotnet add package OpenTelemetry.Extensions.Hosting --version 1.5.1
dotnet add package OpenTelemetry.Instrumentation.AspNetCore --version 1.5.0-beta.1
dotnet add package OpenTelemetry.Instrumentation.Runtime --version 1.5.1
dotnet add package OpenTelemetry.Exporter.Console --version 1.5.1
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol --version 1.5.1

in Program.cs

using OpenTelemetry.Logs;
using OpenTelemetry.Metrics;
using OpenTelemetry.Resources;
using OpenTelemetry.Trace;


...

builder.Services.AddOpenTelemetry()
    .WithMetrics(meterBuilder => meterBuilder
        .AddRuntimeInstrumentation()
        .AddAspNetCoreInstrumentation()
        .AddOtlpExporter());

alainpham/dotnet-otel-example

TOC