Merge branch 'main' into feature/nlog-instrumentation

Author: Kielek

CHANGELOG.md

@@ -9,19 +9,28 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 
 ### Added
 
+- Add `-NoReset` switch parameter to skip service restart in PowerShell
+  registration functions.
 - Support for [`NLog`](https://www.nuget.org/packages/NLog/)
   logs instrumentation for versions `5.*` and `6.*` on .NET using duck typing
   for zero-config auto-injection.
 
 ### Changed
 
+- `-NoReset` parameter in `Unregister-OpenTelemetryForIIS` changed from
+  `[bool]` to `[switch]`. Use `-NoReset` instead of `-NoReset $true`.
+  Note: `-NoReset $true` still works, but `-NoReset $false` will not do what you expect.
+  You should omit the parameter for the expected behavior.
+
 #### Dependency updates
 
 - .NET Framework only, following packages updated
   - `OpenTelemetry.Instrumentation.AspNet` from `1.14.0-rc.1` to `1.14.0`.
 
 ### Deprecated
 
+- Deprecate support for `OpenTracing`.
+
 ### Removed
 
 ### Fixed

docs/config.md

@@ -421,7 +421,7 @@ Important environment variables include:
 | Environment variable                                | Description                                                                                                                                                                                                                                                                                                                                                                                        | Default value | Status                                                                                                                            |
 |-----------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------|
 | `OTEL_DOTNET_AUTO_TRACES_ENABLED`                   | Enables traces.                                                                                                                                                                                                                                                                                                                                                                                    | `true`        | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
-| `OTEL_DOTNET_AUTO_OPENTRACING_ENABLED`              | Enables OpenTracing tracer.                                                                                                                                                                                                                                                                                                                                                                        | `false`       | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
+| `OTEL_DOTNET_AUTO_OPENTRACING_ENABLED`              | Enables OpenTracing tracer.                                                                                                                                                                                                                                                                                                                                                                        | `false`       | [Deprecated](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md)   |
 | `OTEL_DOTNET_AUTO_LOGS_ENABLED`                     | Enables logs.                                                                                                                                                                                                                                                                                                                                                                                      | `true`        | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
 | `OTEL_DOTNET_AUTO_METRICS_ENABLED`                  | Enables metrics.                                                                                                                                                                                                                                                                                                                                                                                   | `true`        | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
 | `OTEL_DOTNET_AUTO_NETFX_REDIRECT_ENABLED`           | Enables automatic redirection of the assemblies used by the automatic instrumentation on the .NET Framework.                                                                                                                                                                                                                                                                                       | `true`        | [Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |

docs/iis-instrumentation.md

@@ -24,7 +24,8 @@ occurred. See this [issue](https://github.com/open-telemetry/opentelemetry-dotne
 for further details.
 
 > [!WARNING]
-> `Register-OpenTelemetryForIIS` performs IIS restart.
+> `Register-OpenTelemetryForIIS` performs IIS restart by default.
+> Use `-NoReset` to skip the restart.
 
 ## Configuration
 

docs/windows-service-instrumentation.md

@@ -17,7 +17,8 @@ Register-OpenTelemetryForWindowsService -WindowsServiceName "WindowsServiceName"
 ```
 
 > [!WARNING]
-> `Register-OpenTelemetryForWindowsService` performs a service restart.
+> `Register-OpenTelemetryForWindowsService` performs a service restart by default.
+> Use `-NoReset` to skip the restart.
 
 ## Configuration
 

script-templates/OpenTelemetry.DotNet.Auto.psm1.template

@@ -473,7 +473,7 @@ function Update-OpenTelemetryCore() {
 
     Uninstall-OpenTelemetryCore
     if ($RegisterIIS) {
-        Unregister-OpenTelemetryForIIS -NoReset $true
+        Unregister-OpenTelemetryForIIS -NoReset
     }
 
     $tempDir = Get-Temp-Directory
@@ -522,9 +522,15 @@ function Register-OpenTelemetryForCurrentSession() {
 <#
     .SYNOPSIS
     Setups IIS environment variables to enable automatic instrumentation.
-    Performs IIS reset after registration.
+    Performs IIS reset after registration by default.
+    .PARAMETER NoReset
+    Does not perform IIS reset.
 #>
 function Register-OpenTelemetryForIIS() {
+    param(
+        [switch]$NoReset
+    )
+
     $installDir = Get-Current-InstallDir
 
     if (-not $installDir) {
@@ -538,7 +544,9 @@ function Register-OpenTelemetryForIIS() {
     Setup-Windows-Service -InstallDir $installDir -WindowsServiceName "W3SVC"
     Setup-Windows-Service -InstallDir $installDir -WindowsServiceName "WAS"
 
-    Reset-IIS
+    if (-not $NoReset) {
+        Reset-IIS
+    }
 }
 
 <#
@@ -549,13 +557,16 @@ function Register-OpenTelemetryForIIS() {
     Actual Windows service name in registry.
     .PARAMETER OTelServiceName
     Specifies OpenTelemetry service name to identify your service.
+    .PARAMETER NoReset
+    Does not perform service restart.
 #>
 function Register-OpenTelemetryForWindowsService() {
     param(
         [Parameter(Mandatory = $true)]
         [string]$WindowsServiceName,
         [Parameter(Mandatory = $true)]
-        [string]$OTelServiceName
+        [string]$OTelServiceName,
+        [switch]$NoReset
     )
 
     $installDir = Get-Current-InstallDir
@@ -565,7 +576,10 @@ function Register-OpenTelemetryForWindowsService() {
     }
 
     Setup-Windows-Service -InstallDir $installDir -WindowsServiceName $WindowsServiceName -OTelServiceName $OTelServiceName
-    Restart-Service -Name $WindowsServiceName -Force
+    
+    if (-not $NoReset) {
+        Restart-Service -Name $WindowsServiceName -Force
+    }
 }
 
 <#
@@ -606,8 +620,7 @@ function Unregister-OpenTelemetryForCurrentSession() {
 #>
 function Unregister-OpenTelemetryForIIS() {
     param(
-        [Parameter(Mandatory = $false)]
-        [bool]$NoReset = $false
+        [switch]$NoReset
     )
 
     Cleanup-Environment-Variables -WindowsServiceName "W3SVC"
@@ -624,15 +637,21 @@ function Unregister-OpenTelemetryForIIS() {
     Performs service restart after removal.
     .PARAMETER WindowsServiceName
     Actual Windows service Name in registry.
+    .PARAMETER NoReset
+    Does not perform service restart.
 #>
 function Unregister-OpenTelemetryForWindowsService() {
     param(
         [Parameter(Mandatory = $true)]
-        [string]$WindowsServiceName
+        [string]$WindowsServiceName,
+        [switch]$NoReset
     )  
 
     Cleanup-Environment-Variables -WindowsServiceName $WindowsServiceName
-    Restart-Service -Name $WindowsServiceName -Force
+    
+    if (-not $NoReset) {
+        Restart-Service -Name $WindowsServiceName -Force
+    }
 }
 
 <#

src/OpenTelemetry.AutoInstrumentation/Configurations/EnvironmentConfigurationTracerHelper.cs

@@ -59,6 +59,7 @@ public static TracerProviderBuilder UseEnvironmentVariables(
 
         if (settings.OpenTracingEnabled)
         {
+            Logger.Warning("OpenTracing is deprecated and it is enabled by the configuration. It will be removed in future versions. Consider migrating to OpenTelemetry API.");
             builder.AddOpenTracingShimSource();
         }