shield360 1.0.0

package/dist/instrumentation/huggingface/index.js

@@ -0,0 +1,110 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const constant_1 = require("../../constant");
+const wrapper_1 = __importDefault(require("./wrapper"));
+class Shield360HuggingFaceInstrumentation extends instrumentation_1.InstrumentationBase {
+    constructor(config = {}) {
+        super(`${constant_1.INSTRUMENTATION_PREFIX}/instrumentation-huggingface`, '1.0.0', config);
+        // Originals saved for unpatch (v4+)
+        this._origTaskFns = {};
+    }
+    init() {
+        const module = new instrumentation_1.InstrumentationNodeModuleDefinition('@huggingface/inference', ['>=2.0.0'], (moduleExports) => {
+            this._patch(moduleExports);
+            return moduleExports;
+        }, (moduleExports) => {
+            if (moduleExports !== undefined) {
+                this._unpatch(moduleExports);
+            }
+        });
+        return [module];
+    }
+    manualPatch(hf) {
+        this._patch(hf);
+    }
+    _findLeafModule(namePart) {
+        try {
+            const cache = require.cache;
+            const key = Object.keys(cache).find(k => k.includes('@huggingface') &&
+                k.includes('inference') &&
+                k.endsWith(`${namePart}.js`) &&
+                !k.endsWith('Stream.js'));
+            return key ? cache[key].exports : null;
+        }
+        catch {
+            return null;
+        }
+    }
+    _patch(moduleExports) {
+        try {
+            const tracer = this.tracer;
+            // v4+: InferenceClient sets task methods as non-configurable own properties in
+            // its constructor, capturing them from leaf task modules via a getter chain.
+            // Patching the leaf modules (writable exports) propagates through the getters
+            // so new instances capture the patched functions.
+            const chatMod = this._findLeafModule('chatCompletion');
+            if (chatMod && typeof chatMod.chatCompletion === 'function' && !chatMod.__shield360_hf_patched) {
+                this._origTaskFns.chatCompletion = chatMod.chatCompletion;
+                chatMod.chatCompletion = wrapper_1.default._patchChatCompletion(tracer)(chatMod.chatCompletion);
+                chatMod.__shield360_hf_patched = true;
+            }
+            const textMod = this._findLeafModule('textGeneration');
+            if (textMod && typeof textMod.textGeneration === 'function' && !textMod.__shield360_hf_patched) {
+                this._origTaskFns.textGeneration = textMod.textGeneration;
+                textMod.textGeneration = wrapper_1.default._patchTextGeneration(tracer)(textMod.textGeneration);
+                textMod.__shield360_hf_patched = true;
+            }
+            // v2/v3: Methods on the prototype
+            for (const ClassName of ['HfInference', 'InferenceClient']) {
+                const proto = moduleExports[ClassName]?.prototype;
+                if (!proto)
+                    continue;
+                if (typeof proto.chatCompletion === 'function') {
+                    if ((0, instrumentation_1.isWrapped)(proto.chatCompletion))
+                        this._unwrap(proto, 'chatCompletion');
+                    this._wrap(proto, 'chatCompletion', wrapper_1.default._patchChatCompletion(tracer));
+                }
+                if (typeof proto.textGeneration === 'function') {
+                    if ((0, instrumentation_1.isWrapped)(proto.textGeneration))
+                        this._unwrap(proto, 'textGeneration');
+                    this._wrap(proto, 'textGeneration', wrapper_1.default._patchTextGeneration(tracer));
+                }
+            }
+        }
+        catch (e) {
+            console.error('Error in HuggingFace _patch method:', e);
+        }
+    }
+    _unpatch(moduleExports) {
+        try {
+            // Restore leaf module originals (v4+)
+            const chatMod = this._findLeafModule('chatCompletion');
+            if (chatMod && this._origTaskFns.chatCompletion) {
+                chatMod.chatCompletion = this._origTaskFns.chatCompletion;
+                delete chatMod.__shield360_hf_patched;
+            }
+            const textMod = this._findLeafModule('textGeneration');
+            if (textMod && this._origTaskFns.textGeneration) {
+                textMod.textGeneration = this._origTaskFns.textGeneration;
+                delete textMod.__shield360_hf_patched;
+            }
+            // Restore prototype methods (v2/v3)
+            for (const ClassName of ['HfInference', 'InferenceClient']) {
+                const proto = moduleExports[ClassName]?.prototype;
+                if (!proto)
+                    continue;
+                if ((0, instrumentation_1.isWrapped)(proto.chatCompletion))
+                    this._unwrap(proto, 'chatCompletion');
+                if ((0, instrumentation_1.isWrapped)(proto.textGeneration))
+                    this._unwrap(proto, 'textGeneration');
+            }
+        }
+        catch { /* ignore */ }
+    }
+}
+exports.default = Shield360HuggingFaceInstrumentation;
+//# sourceMappingURL=index.js.map

package/dist/instrumentation/huggingface/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/instrumentation/huggingface/index.ts"],"names":[],"mappings":";;;;;AAAA,oEAKwC;AAExC,6CAAwD;AACxD,wDAA2C;AAI3C,MAAqB,mCAAoC,SAAQ,qCAAmB;IAClF,YAAY,SAA2C,EAAE;QACvD,KAAK,CAAC,GAAG,iCAAsB,8BAA8B,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QAwBlF,oCAAoC;QAC5B,iBAAY,GAAwB,EAAE,CAAC;IAxB/C,CAAC;IAES,IAAI;QACZ,MAAM,MAAM,GAAG,IAAI,qDAAmC,CACpD,wBAAwB,EACxB,CAAC,SAAS,CAAC,EACX,CAAC,aAAa,EAAE,EAAE;YAChB,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAC3B,OAAO,aAAa,CAAC;QACvB,CAAC,EACD,CAAC,aAAa,EAAE,EAAE;YAChB,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC,CACF,CAAC;QACF,OAAO,CAAC,MAAM,CAAC,CAAC;IAClB,CAAC;IAEM,WAAW,CAAC,EAAO;QACxB,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC;IAKO,eAAe,CAAC,QAAgB;QACtC,IAAI,CAAC;YACH,MAAM,KAAK,GAAI,OAAe,CAAC,KAA4B,CAAC;YAC5D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CACtC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC;gBAC1B,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;gBACvB,CAAC,CAAC,QAAQ,CAAC,GAAG,QAAQ,KAAK,CAAC;gBAC5B,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CACzB,CAAC;YACF,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;QACzC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAES,MAAM,CAAC,aAAkB;QACjC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;YAE3B,+EAA+E;YAC/E,6EAA6E;YAC7E,8EAA8E;YAC9E,kDAAkD;YAClD,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACvD,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,cAAc,KAAK,UAAU,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;gBAC/F,IAAI,CAAC,YAAY,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;gBAC1D,OAAO,CAAC,cAAc,GAAG,iBAAkB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBACjG,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC;YACxC,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACvD,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,cAAc,KAAK,UAAU,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;gBAC/F,IAAI,CAAC,YAAY,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;gBAC1D,OAAO,CAAC,cAAc,GAAG,iBAAkB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBACjG,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC;YACxC,CAAC;YAED,kCAAkC;YAClC,KAAK,MAAM,SAAS,IAAI,CAAC,aAAa,EAAE,iBAAiB,CAAC,EAAE,CAAC;gBAC3D,MAAM,KAAK,GAAG,aAAa,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;gBAClD,IAAI,CAAC,KAAK;oBAAE,SAAS;gBACrB,IAAI,OAAO,KAAK,CAAC,cAAc,KAAK,UAAU,EAAE,CAAC;oBAC/C,IAAI,IAAA,2BAAS,EAAC,KAAK,CAAC,cAAc,CAAC;wBAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;oBAC3E,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,gBAAgB,EAAE,iBAAkB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvF,CAAC;gBACD,IAAI,OAAO,KAAK,CAAC,cAAc,KAAK,UAAU,EAAE,CAAC;oBAC/C,IAAI,IAAA,2BAAS,EAAC,KAAK,CAAC,cAAc,CAAC;wBAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;oBAC3E,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,gBAAgB,EAAE,iBAAkB,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;gBACvF,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,qCAAqC,EAAE,CAAC,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAES,QAAQ,CAAC,aAAkB;QACnC,IAAI,CAAC;YACH,sCAAsC;YACtC,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACvD,IAAI,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,CAAC;gBAChD,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC;gBAC1D,OAAO,OAAO,CAAC,sBAAsB,CAAC;YACxC,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACvD,IAAI,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,CAAC;gBAChD,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC;gBAC1D,OAAO,OAAO,CAAC,sBAAsB,CAAC;YACxC,CAAC;YACD,oCAAoC;YACpC,KAAK,MAAM,SAAS,IAAI,CAAC,aAAa,EAAE,iBAAiB,CAAC,EAAE,CAAC;gBAC3D,MAAM,KAAK,GAAG,aAAa,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;gBAClD,IAAI,CAAC,KAAK;oBAAE,SAAS;gBACrB,IAAI,IAAA,2BAAS,EAAC,KAAK,CAAC,cAAc,CAAC;oBAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;gBAC3E,IAAI,IAAA,2BAAS,EAAC,KAAK,CAAC,cAAc,CAAC;oBAAE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;YAC7E,CAAC;QACH,CAAC;QAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC;IAC1B,CAAC;CACF;AAzGD,sDAyGC"}

package/dist/instrumentation/huggingface/wrapper.d.ts

@@ -0,0 +1,54 @@
+import { Span, Tracer } from '@opentelemetry/api';
+import BaseWrapper from '../base-wrapper';
+declare class HuggingFaceWrapper extends BaseWrapper {
+    static aiSystem: string;
+    static serverAddress: string;
+    static serverPort: number;
+    /**
+     * Stamp `shield360.agent.version_hash` (auto) and `gen_ai.agent.version`
+     * (user override, if set) on the span and return the same attributes so
+     * the caller can merge them into the inference event extras.
+     */
+    static _stampAgentVersion(span: Span, args: {
+        systemInstructionsJson?: string;
+        toolDefinitionsJson?: string;
+        primaryModel?: string;
+        temperature?: number | null;
+        top_p?: number | null;
+        max_tokens?: number | null;
+    }): Record<string, string>;
+    static _patchChatCompletion(tracer: Tracer): any;
+    static _chatCompletion({ args, genAIEndpoint, response, span, }: {
+        args: any[];
+        genAIEndpoint: string;
+        response: any;
+        span: Span;
+    }): Promise<any>;
+    static _chatCompletionGenerator({ args, genAIEndpoint, response, span, }: {
+        args: any[];
+        genAIEndpoint: string;
+        response: any;
+        span: Span;
+    }): AsyncGenerator<unknown, any, unknown>;
+    static _chatCompletionCommonSetter({ args, genAIEndpoint, result, span, ttft, tbt, }: {
+        args: any[];
+        genAIEndpoint: string;
+        result: any;
+        span: Span;
+        ttft?: number;
+        tbt?: number;
+    }): Promise<{
+        genAIEndpoint: string;
+        model: any;
+        cost: number;
+        aiSystem: string;
+    }>;
+    static _patchTextGeneration(tracer: Tracer): any;
+    static _textGeneration({ args, genAIEndpoint, response, span, }: {
+        args: any[];
+        genAIEndpoint: string;
+        response: any;
+        span: Span;
+    }): Promise<any>;
+}
+export default HuggingFaceWrapper;