Merge pull request #2593 from Kielek/splunk-otel-dotnet-1.9.0

aurbiztondo-splunk · web-flow · commit 188db217888d · 2025-02-10T10:39:00.000+01:00
Splunk OTel .NET 1.9.0
diff --git a/_includes/requirements/dotnet.rst b/_includes/requirements/dotnet.rst
@@ -2,19 +2,22 @@ The Splunk Distribution of OpenTelemetry .NET supports the following .NET versio
 
 - Instrumentation for traces and metrics:
 
+   - .NET 9.0 (End of Support: May 12, 2026)
    - .NET 8.0 (End of Support: November 10, 2026)
-   - .NET 6.0 (End of Support: November 12, 2024)
    - .NET Framework 4.7 and higher
    - .NET Framework 4.6.2 (End of Support: January 12, 2027)
 
 - AlwaysOn Profiling:
 
+   - .NET 9.0 (End of Support: May 12, 2026)
    - .NET 8.0 (End of Support: November 10, 2026)
-   - .NET 6.0 (End of Support: November 12, 2024)
 
       .. note:: .NET Framework is not supported for AlwaysOn Profiling.
 
-.. note:: .NET 7 reached End of Life on May 14, 2024. Best effort support is provided for the last version only, 7.0.19, which was tested using Splunk Distribution of OpenTelemetry .NET version 1.5.0.
+.. caution:: 
+
+   The Splunk Distribution of OpenTelemetry .NET version 1.9.0 is not compatible with .NET 6 or .NET 7 since both have reached End of Life. If you want to continue instrumenting .NET 6 or .NET 7 services use the Splunk Distribution of OpenTelemetry .NET version 1.8.0 or lower. 
+   Best effort support for Splunk Distribution of OpenTelemetry .NET is provided up to November 12, 2025 only for the last versions of .NET 6 (version 6.0.36) and .NET 7 (version 7.0.20).
 
 The distribution supports the following architectures:
 
diff --git a/apm/profiling/get-data-in-profiling.rst b/apm/profiling/get-data-in-profiling.rst
@@ -187,7 +187,7 @@ To activate AlwaysOn Profiling, follow the steps for the appropriate programming
 
       :strong:`Requirements`
 
-      AlwaysOn Profiling requires .NET 6.0 or higher.
+      AlwaysOn Profiling requires .NET 8.0 or higher.
 
       .. note:: .NET Framework is not supported.
 
diff --git a/gdi/get-data-in/application/otel-dotnet/configuration/advanced-dotnet-configuration.rst b/gdi/get-data-in/application/otel-dotnet/configuration/advanced-dotnet-configuration.rst
@@ -71,7 +71,7 @@ The following settings control the AlwaysOn Profiling feature for the .NET instr
 
     <div class="instrumentation" section="settings" group="category" filter="profiling" url="https://raw.githubusercontent.com/splunk/o11y-gdi-metadata/main/apm/splunk-otel-dotnet/metadata.yaml" data-renaming='{"keys": "Identifier", "description": "Description", "instrumented_components": "Components", "signals": "Signals", "env": "Environment variable", "default": "Default", "type": "Type"}'></div>
 
-.. note:: AlwaysOn Profiling for .NET is compatible with .NET 6.0 and higher. For more information on AlwaysOn Profiling, see :ref:`profiling-intro`.
+.. note:: AlwaysOn Profiling for .NET is compatible with .NET 8.0 and higher. For more information on AlwaysOn Profiling, see :ref:`profiling-intro`.
 
 .. _dotnet-otel-trace-propagation-settings:
 
diff --git a/gdi/get-data-in/application/otel-dotnet/instrumentation/connect-traces-logs.rst b/gdi/get-data-in/application/otel-dotnet/instrumentation/connect-traces-logs.rst
@@ -50,7 +50,7 @@ Check compatibility and requirements
 
 .. note:: Automatic log to trace correlation only works for .NET applications. For .NET Framework use manual correlation. See :ref:`manual-trace-logs-correlation-otel`.
 
-``Microsoft.Extensions.Logging`` version ``8.0.0`` and higher are supported.
+``Microsoft.Extensions.Logging`` version ``9.0.0`` and higher are supported.
 
 .. _dotnet-otel-enable-log-correlation:
 
diff --git a/gdi/get-data-in/application/otel-dotnet/troubleshooting/common-dotnet-troubleshooting.rst b/gdi/get-data-in/application/otel-dotnet/troubleshooting/common-dotnet-troubleshooting.rst
@@ -79,7 +79,22 @@ To find your runtime identifier, follow these steps:
 Traces don't appear in Splunk Observability Cloud
 ==================================================================
 
-If traces from your instrumented application or service are not available in Splunk Observability Cloud, verify the OpenTelemetry Collector configuration:
+If traces from your instrumented application or service are not available in Splunk Observability Cloud, check the following:
+
+Verify the supported .NET versions
+----------------------------------------------------------------
+
+Make sure that your application targets :ref:`the supported versions of .NET <dotnet-requirements>`.
+
+If the .NET version you're using is not supported, your log entries might be similar to the following:
+
+.. code-block:: bash
+   
+   [Information] Rule Engine: Error in StartupHook initialization: 6.0.36 is not supported 
+   [Error] Rule 'Minimum Supported Framework Version Validator' failed: Verifies that the application is running on a supported version of the .NET runtime. 
+
+Verify the OpenTelemetry Collector configuration
+----------------------------------------------------------------
 
 #. Make sure that ``OTEL_EXPORTER_OTLP_ENDPOINT`` points to the correct OpenTelemetry Collector instance host.
 #. Check that your collector instance is configured and running. See :ref:`otel-splunk-collector-tshoot`.
@@ -152,7 +167,7 @@ If AlwaysOn Profiling is :ref:`not working as intended <profiling-intro>`, check
 Unsupported .NET version
 -----------------------------------------------
 
-To use AlwaysOn Profiling, upgrade your .NET version to .NET 6.0 or higher.
+To use AlwaysOn Profiling, upgrade your .NET version to 8.0 or higher.
 
 None of the .NET Framework versions is supported.
 
diff --git a/gdi/get-data-in/serverless/azure/instrument-azure-functions-dotnet.rst b/gdi/get-data-in/serverless/azure/instrument-azure-functions-dotnet.rst
@@ -65,19 +65,6 @@ Add the following libraries using NuGet in Visual Studio:
          - :new-page:`OpenTelemetry.Instrumentation.Http <https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http>`
          - :new-page:`OpenTelemetry.ResourceDetectors.Azure <https://www.nuget.org/packages/OpenTelemetry.ResourceDetectors.Azure>`
 
-   .. tab:: .NET 6 In-process function
-
-      #. Activate the :strong:`Include prerelease` setting.
-      #. Install the specified version of the following libraries:
-   
-         - :new-page:`OpenTelemetry version 1.3.2 <https://www.nuget.org/packages/OpenTelemetry/1.3.2>`
-         - :new-page:`OpenTelemetry.Exporter.OpenTelemetryProtocol version 1.3.2 <https://www.nuget.org/packages/OpenTelemetry.Exporter.OpenTelemetryProtocol/1.3.2>`
-         - :new-page:`OpenTelemetry.Instrumentation.Http version 1.0.0-rc9.4 <https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http/1.0.0-rc9.4>`
-         - :new-page:`OpenTelemetry.Instrumentation.AspNetCore version 1.0.0-rc9.4 <https://www.nuget.org/packages/OpenTelemetry.Instrumentation.AspNetCore/1.0.0-rc9.4>`
-         - :new-page:`Microsoft.Azure.Functions.Extensions version 1.1.0 <https://www.nuget.org/packages/Microsoft.Azure.Functions.Extensions/1.1.0>`
-
-      .. note:: Due to runtime dependencies, only the indicated versions are guaranteed to work when instrumenting in-process functions.
-
    .. tab:: .NET 8 In-process function
 
       #. Activate the :strong:`Include prerelease` setting.
@@ -161,69 +148,6 @@ After adding the dependencies, initialize OpenTelemetry in your function.
 
       .. note:: When instrumenting isolated worker process functions, you can encapsulate startup initialization and parameters into other functions.
 
-   .. tab:: .NET 6 In-process function
-
-      Define a startup function and decorate the assembly with it. The startup function uses the Azure.Functions.Extensions package to collect useful metadata. 
-
-      .. code-block:: csharp
-
-         using Microsoft.Azure.Functions.Extensions.DependencyInjection;
-         using Microsoft.Extensions.DependencyInjection;
-         using OpenTelemetry;
-         using OpenTelemetry.Exporter;
-         using OpenTelemetry.Resources;
-         using OpenTelemetry.Trace;
-         using System;
-         using System.Collections.Generic;
-         
-         // Decorate assembly with startup function
-         [assembly: FunctionsStartup(typeof(OtelManualExample.Startup))]
-         
-         namespace OtelManualExample
-         {
-            public class Startup : FunctionsStartup
-            {
-               public override void Configure(IFunctionsHostBuilder builder)
-               {
-                  // Get environment variables from function configuration
-                  // You need a valid Splunk Observability Cloud access token and realm
-                  var serviceName = Environment.GetEnvironmentVariable("WEBSITE_SITE_NAME") ?? "Unknown";
-                  var accessToken = Environment.GetEnvironmentVariable("SPLUNK_ACCESS_TOKEN")?.Trim();
-                  var realm = Environment.GetEnvironmentVariable("SPLUNK_REALM")?.Trim();
-
-                  ArgumentNullException.ThrowIfNull(accessToken, "SPLUNK_ACCESS_TOKEN");
-                  ArgumentNullException.ThrowIfNull(realm, "SPLUNK_REALM");
-
-                  var tp = Sdk.CreateTracerProviderBuilder()
-                     // Use Add[instrumentation-name]Instrumentation to instrument missing services
-                     // Use Nuget to find different instrumentation libraries
-                     .AddHttpClientInstrumentation(opts => 
-                        // This filter prevents background (parent-less) http client activity
-                        opts.Filter = req => Activity.Current?.Parent != null)
-                     .AddAspNetCoreInstrumentation()
-                     // Use AddSource to add your custom DiagnosticSource source names
-                     //.AddSource("My.Source.Name")
-                     .SetSampler(new AlwaysOnSampler())
-                     // Add resource attributes to all spans
-                     .SetResourceBuilder(
-                        ResourceBuilder.CreateDefault()
-                        .AddService(serviceName: serviceName, serviceVersion: "1.0.0")
-                        .AddAttributes(new Dictionary<string, object>() {
-                           { "faas.instance", Environment.GetEnvironmentVariable("WEBSITE_INSTANCE_ID") }
-                        }))
-                     .AddOtlpExporter(opts =>
-                     {
-                        opts.Endpoint = new Uri($"https://ingest.{realm}.signalfx.com/v2/trace/otlp");
-                        opts.Protocol = OtlpExportProtocol.HttpProtobuf;
-                        opts.Headers = $"X-SF-TOKEN={accessToken}";
-                     })
-                     .Build();
-
-                  builder.Services.AddSingleton(tp);
-               }
-            }
-         }
-
    .. tab:: .NET 8 In-process function
 
       Define a startup function and decorate the assembly with it. The startup function uses the Azure.Functions.Extensions package to collect useful metadata. 
