OpenTelemetry support in worker #1049

andystaples · 2024-04-03T18:14:05Z

Initial commit of changes needed to support OpenTelemetry in the worker

Includes the ability to check for the presence of the AzureFunctions.PowerShell.OpenTelemetry.SDK module and run commands from that module
- Initializes an internal activity before each function invocation to link worker traces to host
- Takes a reference to a method from the module and forwards all logs back through this method to be passed on to the OTel endpoint
Report the relevant OTel worker capabilities at init based on the presence of a newly specified environment variable
Update protobuf spec to latest in order to
- Support updating worker capabilities at EnvironmentReloadRequest
- Provide this capability for apps which were started in placeholder mode

resolves #1048

Pull request checklist

My changes do not require documentation changes
- Otherwise: Documentation issue linked to PR
My changes should not be added to the release notes for the next release
- Otherwise: I've added my notes to release_notes.md
My changes do not need to be backported to a previous version
- Otherwise: Backport tracked by issue/PR #issue_or_pr
I have added all required tests (Unit tests, E2E tests)

Additional information

Additional PR information

- Report opentelemetry capability at environemnt reload

andystaples · 2024-04-03T18:17:59Z

This is a draft PR for a number of reasons. We need to discuss:

Any concerns with the additional checks for the presence of the OTel module
Cold start impact
Additional testing that may be required (?)

Also, there is a comment in there (RequestProcessor#400) that suggests some uncertainty about whether all worker capabilities need to be reported in EnvironmentReloadRequest. Reading through the protobuf spec, the host defaults to "merge" mode where new capabilities are added but old ones are retained, so that is no longer a concern. I'll pull that comment out with the next commit to this branch

src/OpenTelemetrySDK/OpenTelemetryController.cs

src/Logging/RpcLogger.cs

src/Logging/LoggingEventHandler.cs

src/OpenTelemetrySDK/OpenTelemetryController.cs

src/PowerShell/PowerShellManager.cs

- Outline of unit testing, more is needed

src/OpenTelemetry/OpenTelemetryController.cs

src/OpenTelemetry/OpenTelemetryInvocationContext.cs

src/PowerShell/PowerShellModuleDetector.cs

src/OpenTelemetry/OpenTelemetryController.cs

src/OpenTelemetry/OpenTelemetryServices.cs

test/Unit/OpenTelemetry/OpenTelemetryControllerTests.cs

src/OpenTelemetry/IOpenTelemetryServices.cs

AnatoliB · 2024-04-12T18:50:41Z

src/PowerShell/PowerShellModuleDetector.cs

+
+    internal class PowerShellModuleDetector
+    {
+        public static bool IsPowerShellModuleLoaded(System.Management.Automation.PowerShell _pwsh, ILogger _logger, string moduleName)


Naming convention: we use names starting with underscore for class fields only. Parameter names should be in camelCase without underscore characters

I will not block the PR on this, but please clean it up, now or later

AnatoliB

LGTM

* Detect if OpenTelemetry module is present and environment variable is set * Pre-instrument invocations with a span using Invocation ID + parent span ID * Forward all user logs to the module to be sent to OTel endpoint (cherry picked from commit f0c7eec)

* OpenTelemetry support in worker (#1049) * Detect if OpenTelemetry module is present and environment variable is set * Pre-instrument invocations with a span using Invocation ID + parent span ID * Forward all user logs to the module to be sent to OTel endpoint (cherry picked from commit f0c7eec)

andystaples added 2 commits April 3, 2024 11:56

Initial code changes before proto update

b7fd7ee

Update to latest protobuf (1.10.0-ptotofile)

261d74e

- Report opentelemetry capability at environemnt reload

andystaples requested review from davidmrdavid, AnatoliB, Francisco-Gamino and RohitRanjanMS April 3, 2024 18:14