Update module to 1.0.0, final preview changes (#17)

* Update module to 1.0.0, final preview changes
- Bump module version to 1.0.0
- Update OpenTelemetry dependencies to 1.8.1
- Add ResourceDetector to logs as well as traces
- Increase specificity and reduce volume of warnings emitted by module

Author: andystaples

.vscode/launch.json

@@ -27,8 +27,7 @@
             "console": "integratedTerminal",
             "env": {
                 "OTEL_EXPORTER_OTLP_ENDPOINT": "<VALUE>",
-                "OTEL_EXPORTER_OTLP_HEADERS": "<VALUE>", 
-                "APPLICATIONINSIGHTS_CONNECTION_STRING": "<VALUE>"
+                "OTEL_EXPORTER_OTLP_HEADERS": "<VALUE>"
             }
         }
     ]

src/AzureFunctions.PowerShell.OpenTelemetry.SDK.psd1

@@ -1,6 +1,6 @@
 @{
     # Version number of this module.
-    ModuleVersion = '0.0.2'
+    ModuleVersion = '1.0.0'
 
     # Supported PSEditions
     CompatiblePSEditions = @('Core')

src/AzureFunctions.PowerShell.OpenTelemetry.SDK/Constants/SDKConstants.cs

@@ -10,6 +10,7 @@ namespace AzureFunctions.PowerShell.OpenTelemetry.SDK
 {
     public class SDKConstants 
     {
+        internal const string FunctionsOpenTelemetryModuleName = "AzureFunctions.PowerShell.OpenTelemetry.SDK";
         internal const string FunctionsOpenTelemetryEnvironmentVariableName = "OTEL_FUNCTIONS_WORKER_ENABLED";
         internal const string EnvironmentVariableMissingErrorCategory = "OpenTelemetryEnvironmentVariableNotSet";
 

src/AzureFunctions.PowerShell.OpenTelemetry.SDK/FunctionsEnvironmentWarningChecker.cs

@@ -0,0 +1,48 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using System.Security.Policy;
+
+namespace AzureFunctions.PowerShell.OpenTelemetry.SDK
+{
+    public class FunctionsEnvironmentWarningChecker
+    {
+        private static bool _environmentVariableWarned = false;
+
+        private static string _warningMessage = String.Format("{0}: Environment variable {1} not set, this module may not have the intended behavior. " + 
+                                                             "Logs emitted from your function app's default pipeline will not be sent to OpenTelemetry, " +
+                                                             "and traces and spans will not be correlated with telemetry emitted from the functions host.",
+            SDKConstants.FunctionsOpenTelemetryModuleName, SDKConstants.FunctionsOpenTelemetryEnvironmentVariableName);
+
+        private static bool IsFunctionsEnvironmentVariableEnabled()
+        {
+            string? value = System.Environment.GetEnvironmentVariable(SDKConstants.FunctionsOpenTelemetryEnvironmentVariableName);
+
+            if (!string.IsNullOrEmpty(value) && bool.TryParse(value, out bool isEnabled) && isEnabled) 
+            {
+                return true;
+            }
+
+            return false;
+        }
+
+        internal static bool ShouldWarnEnvironmentVariableMissing(out string? warningMessage) 
+        {
+            warningMessage = null;
+
+            if (!_environmentVariableWarned && !IsFunctionsEnvironmentVariableEnabled())
+            {
+                warningMessage = _warningMessage;
+
+                _environmentVariableWarned = true;
+                return true;
+            }
+
+            // Even if we didn't warn, we still set this to true to prevent expensive env checks for future calls
+            _environmentVariableWarned = true;
+            return false;
+        }
+    }
+}

src/AzureFunctions.PowerShell.OpenTelemetry.SDK/Logging/NewFunctionsOpenTelemetryLogger.cs

@@ -20,9 +20,9 @@ public class NewFunctionsOpenTelemetryLogger : PSCmdlet
     {
         protected override void ProcessRecord()
         {
-            if (string.IsNullOrEmpty(Environment.GetEnvironmentVariable(SDKConstants.FunctionsOpenTelemetryEnvironmentVariableName))) 
+            if (FunctionsEnvironmentWarningChecker.ShouldWarnEnvironmentVariableMissing(out var warningMessage)) 
             {
-                WriteWarning("OpenTelemetry environment variable not set, logs from your function app's default logging pipeline will not be sent via this module to OpenTelemetry");
+                WriteWarning(warningMessage);
             }
 
             var response = FunctionsLoggerBuilder.GetLogger().BuildResponse();

src/AzureFunctions.PowerShell.OpenTelemetry.SDK/Logging/WriteFunctionsOpenTelemetryLog.cs

@@ -24,9 +24,9 @@ public class WriteFunctionsOpenTelemetryLog : PSCmdlet
 
         protected override void ProcessRecord()
         {
-            if (string.IsNullOrEmpty(Environment.GetEnvironmentVariable(SDKConstants.FunctionsOpenTelemetryEnvironmentVariableName))) 
+            if (FunctionsEnvironmentWarningChecker.ShouldWarnEnvironmentVariableMissing(out var warningMessage)) 
             {
-                WriteWarning("OpenTelemetry environment variable not set, logs emitted from this worker instance will not be correlated with the invocation");
+                WriteWarning(warningMessage);
             }
 
             FunctionsLoggerBuilder.GetLogger().Log(LogItem, Level?.ToString());

src/AzureFunctions.PowerShell.OpenTelemetry.SDK/Traces/NewFunctionsOpenTelemetryTracerBuilder.cs

@@ -28,9 +28,9 @@ public class NewFunctionsOpenTelemetryTracerBuilder : PSCmdlet
         // This method will be called for each input received from the pipeline to this cmdlet; if no input is received, this method is not called
         protected override void ProcessRecord()
         {
-            if (string.IsNullOrEmpty(Environment.GetEnvironmentVariable(SDKConstants.FunctionsOpenTelemetryEnvironmentVariableName))) 
+            if (FunctionsEnvironmentWarningChecker.ShouldWarnEnvironmentVariableMissing(out var warningMessage)) 
             {
-                WriteWarning("OpenTelemetry environment variable not set, user generated traces will not be linked to parent trace from functions host");
+                WriteWarning(warningMessage);
             }
 
             var response = FunctionsTracerBuilder.BuildTracer(AdditionalSources);

src/AzureFunctions.PowerShell.OpenTelemetry.SDK/Traces/StartFunctionsOpenTelemetrySpan.cs

@@ -25,9 +25,9 @@ public class StartFunctionsOpenTelemetrySpan : PSCmdlet
         // This method will be called for each input received from the pipeline to this cmdlet; if no input is received, this method is not called
         protected override void ProcessRecord()
         {
-            if (string.IsNullOrEmpty(Environment.GetEnvironmentVariable(SDKConstants.FunctionsOpenTelemetryEnvironmentVariableName))) 
+            if (FunctionsEnvironmentWarningChecker.ShouldWarnEnvironmentVariableMissing(out var warningMessage)) 
             {
-                WriteWarning("OpenTelemetry environment variable not set, the span will not be correlated with the invocation span coming from functions host");
+                WriteWarning(warningMessage);
             }
 
             var response = FunctionsActivityBuilder.StartActivity(ActivityName);

src/OpenTelemetryEngine/Constants/WorkerConstants.cs

@@ -0,0 +1,12 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+namespace OpenTelemetryEngine.Constants
+{
+    internal class WorkerConstants
+    {
+        internal const string SystemLogPrefix = "LanguageWorkerConsoleLog";
+    }
+}

src/OpenTelemetryEngine/Logging/FunctionsLoggerBuilder.cs

@@ -5,7 +5,9 @@
 
 using Microsoft.Extensions.Logging;
 using OpenTelemetry.Logs;
+using OpenTelemetry.Resources;
 using OpenTelemetryEngine.Types;
+using OpenTelemetryEngine.Resources;
 
 
 namespace OpenTelemetryEngine.Logging
@@ -22,7 +24,8 @@ public static void InitializeLogger()
                 {
                     builder.AddOpenTelemetry(options =>
                     {
-                        options.AddOtlpExporter();
+                        options.SetResourceBuilder(ResourceBuilder.CreateDefault().AddDetector(new FunctionsResourceDetector()))
+                            .AddOtlpExporter();
                     });
                 });