-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Azure Monitor OpenTelemetry] Add Azure Functions Correlation Hook (#…
…26313) Functionality for @azure/monitor-opentelemetry package Adding Azure Fn code to handle auto correlation when running in that environment
- Loading branch information
1 parent
dd2e2a6
commit afd1486
Showing
9 changed files
with
223 additions
and
15 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 70 additions & 0 deletions
70
sdk/monitor/monitor-opentelemetry/src/traces/azureFnHook.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| import { Context as AzureFnContext } from "@azure/functions"; | ||
| import { | ||
| context, | ||
| propagation, | ||
| ROOT_CONTEXT, | ||
| Context as OpenTelemetryContext, | ||
| } from "@opentelemetry/api"; | ||
| import { Logger } from "../shared/logging"; | ||
|
|
||
| export class AzureFunctionsHook { | ||
| private _functionsCoreModule: any; | ||
| private _preInvocationHook: any; | ||
|
|
||
| constructor() { | ||
| try { | ||
| // TODO: Add types files when publicly available | ||
| this._functionsCoreModule = require("@azure/functions-core"); | ||
| // Only v3 of Azure Functions library is supported right now. See matrix of versions here: | ||
| // https://github.com/Azure/azure-functions-nodejs-library | ||
| const funcProgModel = this._functionsCoreModule.getProgrammingModel(); | ||
| if (funcProgModel.name === "@azure/functions" && funcProgModel.version.startsWith("3.")) { | ||
| this._addPreInvocationHook(); | ||
| } else { | ||
| Logger.getInstance().debug( | ||
| `AzureFunctionsHook does not support model "${funcProgModel.name}" version "${funcProgModel.version}"` | ||
| ); | ||
| } | ||
| } catch (error) { | ||
| Logger.getInstance().debug( | ||
| "@azure/functions-core failed to load, not running in Azure Functions" | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| public shutdown() { | ||
| if (this._preInvocationHook) { | ||
| this._preInvocationHook.dispose(); | ||
| this._preInvocationHook = undefined; | ||
| } | ||
| this._functionsCoreModule = undefined; | ||
| } | ||
|
|
||
| private _addPreInvocationHook() { | ||
| if (!this._preInvocationHook) { | ||
| this._preInvocationHook = this._functionsCoreModule.registerHook( | ||
| "preInvocation", | ||
| async (preInvocationContext: any) => { | ||
| const ctx: AzureFnContext = <AzureFnContext>preInvocationContext.invocationContext; | ||
| // Update context to use Azure Functions one | ||
| let extractedContext: OpenTelemetryContext | any = null; | ||
| try { | ||
| if (ctx.traceContext) { | ||
| extractedContext = propagation.extract(ROOT_CONTEXT, ctx.traceContext); | ||
| } | ||
| const currentContext = extractedContext || context.active(); | ||
| preInvocationContext.functionCallback = context.bind( | ||
| currentContext, | ||
| preInvocationContext.functionCallback | ||
| ); | ||
| } catch (err) { | ||
| Logger.getInstance().error("Failed to propagate context in Azure Functions", err); | ||
| } | ||
| } | ||
| ); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
132 changes: 132 additions & 0 deletions
132
sdk/monitor/monitor-opentelemetry/test/internal/unit/traces/azureFnHook..test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT license. | ||
|
|
||
| import * as assert from "assert"; | ||
| import * as sinon from "sinon"; | ||
| import { AzureFunctionsHook } from "../../../../src/traces/azureFnHook"; | ||
| import { TraceHandler } from "../../../../src/traces"; | ||
| import { Logger } from "../../../../src/shared/logging"; | ||
| import { AzureMonitorOpenTelemetryConfig } from "../../../../src/shared"; | ||
|
|
||
| describe("Library/AzureFunctionsHook", () => { | ||
| let sandbox: sinon.SinonSandbox; | ||
|
|
||
| before(() => { | ||
| sandbox = sinon.createSandbox(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| sandbox.restore(); | ||
| }); | ||
|
|
||
| it("Hook not added if not running in Azure Functions", () => { | ||
| const spy = sandbox.spy(Logger.getInstance(), "debug"); | ||
| let hook = new AzureFunctionsHook(); | ||
| assert.equal(hook["_functionsCoreModule"], undefined); | ||
| assert.ok(spy.called); | ||
| assert.equal( | ||
| spy.args[0][0], | ||
| "@azure/functions-core failed to load, not running in Azure Functions" | ||
| ); | ||
| }); | ||
|
|
||
| describe("AutoCollection/AzureFunctionsHook load fake Azure Functions Core", () => { | ||
| let originalRequire: any; | ||
|
|
||
| before(() => { | ||
| var Module = require("module"); | ||
| originalRequire = Module.prototype.require; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| var Module = require("module"); | ||
| Module.prototype.require = originalRequire; | ||
| }); | ||
|
|
||
| it("Hook not added if using not supported programming model", () => { | ||
| var Module = require("module"); | ||
| var preInvocationCalled = false; | ||
| Module.prototype.require = function () { | ||
| if (arguments[0] === "@azure/functions-core") { | ||
| return { | ||
| registerHook(name: string) { | ||
| if (name === "preInvocation") { | ||
| preInvocationCalled = true; | ||
| } | ||
| }, | ||
| getProgrammingModel() { | ||
| return { | ||
| name: "@azure/functions", | ||
| version: "2.x", | ||
| }; | ||
| }, | ||
| }; | ||
| } | ||
| return originalRequire.apply(this, arguments); | ||
| }; | ||
| let azureFnHook = new AzureFunctionsHook(); | ||
| assert.ok(azureFnHook, "azureFnHook"); | ||
| assert.ok(!preInvocationCalled, "preInvocationCalled"); | ||
| }); | ||
|
|
||
| it("Pre Invokation Hook added if running in Azure Functions and context is propagated", () => { | ||
| let Module = require("module"); | ||
| let preInvocationCalled = false; | ||
| let config = new AzureMonitorOpenTelemetryConfig(); | ||
| config.azureMonitorExporterConfig.connectionString = | ||
| "InstrumentationKey=1aa11111-bbbb-1ccc-8ddd-eeeeffff3333;"; | ||
| let traceHandler = new TraceHandler(config); | ||
|
|
||
| Module.prototype.require = function () { | ||
| if (arguments[0] === "@azure/functions-core") { | ||
| return { | ||
| registerHook(name: string, callback: any) { | ||
| if (name === "preInvocation") { | ||
| preInvocationCalled = true; | ||
| let ctx = { | ||
| res: { status: 400 }, | ||
| invocationId: "testinvocationId", | ||
| traceContext: { | ||
| traceparent: "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01", | ||
| tracestate: "", | ||
| attributes: {}, | ||
| }, | ||
| }; | ||
| let preInvocationContext: any = { | ||
| inputs: [], | ||
| functionCallback: () => { | ||
| let span = traceHandler.getTracer().startSpan("test"); | ||
| // Context should be propagated here | ||
| assert.equal( | ||
| (span as any)["_spanContext"]["traceId"], | ||
| "0af7651916cd43dd8448eb211c80319c" | ||
| ); | ||
| assert.ok((span as any)["_spanContext"]["spanId"]); | ||
| }, | ||
| hookData: {}, | ||
| appHookData: {}, | ||
| invocationContext: ctx, | ||
| }; | ||
| // Azure Functions should call preinvocation callback | ||
| callback(preInvocationContext); | ||
| // Azure Functions should call customer function callback | ||
| preInvocationContext.functionCallback(null, null); | ||
| } | ||
| }, | ||
|
|
||
| getProgrammingModel() { | ||
| return { | ||
| name: "@azure/functions", | ||
| version: "3.x", | ||
| }; | ||
| }, | ||
| }; | ||
| } | ||
| return originalRequire.apply(this, arguments); | ||
| }; | ||
| let azureFnHook = new AzureFunctionsHook(); | ||
| assert.ok(azureFnHook, "azureFnHook"); | ||
| assert.ok(preInvocationCalled, "preInvocationCalled"); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters