weflayr 0.20.6 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/package.json +2 -2
  2. package/src/auto-instrument.js +64 -31
  3. package/src/instrumentation/anthropic/get_cache_and_reasoning_telemetry.js +107 -0
  4. package/src/instrumentation/anthropic/set_telemetry_attributes.js +27 -0
  5. package/src/instrumentation/bedrock/get_cache_telemetry.js +104 -0
  6. package/src/instrumentation/bedrock/set_telemetry_attributes.js +27 -0
  7. package/src/instrumentation/cohere/get_chat_telemetry.js +88 -0
  8. package/src/instrumentation/cohere/get_embeddings_telemetry.js +97 -0
  9. package/src/instrumentation/cohere/set_telemetry_attributes.js +32 -0
  10. package/src/instrumentation/google/get_audio_telemetry.js +31 -0
  11. package/src/instrumentation/google/get_cache_telemetry.js +27 -0
  12. package/src/instrumentation/google/get_embeddings_telemetry.js +78 -0
  13. package/src/instrumentation/google/get_provider_name.js +25 -0
  14. package/src/instrumentation/google/get_reasoning_telemetry.js +21 -0
  15. package/src/instrumentation/google/set_telemetry_attributes.js +98 -0
  16. package/src/instrumentation/openai/get_audio_telemetry.js +149 -0
  17. package/src/instrumentation/openai/get_cache_and_reasoning_telemetry.js +71 -0
  18. package/src/instrumentation/openai/get_embeddings_telemetry.js +95 -0
  19. package/src/instrumentation/openai/get_streaming_usage.js +81 -0
  20. package/src/instrumentation/openai/set_telemetry_attributes.js +39 -0
  21. package/src/otel/propagation.js +5 -0
  22. package/src/otel/span-filter.js +0 -5
  23. package/tests/index.test.js +42 -44
  24. package/tests/instrumentation/anthropic/get_cache_and_reasoning_telemetry.test.js +125 -0
  25. package/tests/instrumentation/bedrock/get_cache_telemetry.test.js +102 -0
  26. package/tests/instrumentation/cohere/get_chat_telemetry.test.js +148 -0
  27. package/tests/instrumentation/cohere/get_embeddings_telemetry.test.js +129 -0
  28. package/tests/instrumentation/{elevenlabs.test.js → elevenlabs/full_instrumentation.test.js} +3 -1
  29. package/tests/instrumentation/google/get_embeddings_telemetry.test.js +125 -0
  30. package/tests/instrumentation/google/get_reasoning_telemetry.test.js +41 -0
  31. package/tests/instrumentation/google/set_telemetry_attributes.test.js +187 -0
  32. package/tests/instrumentation/openai/get_audio_telemetry.test.js +170 -0
  33. package/tests/instrumentation/openai/get_cache_and_reasoning_telemetry.test.js +83 -0
  34. package/tests/instrumentation/openai/get_embeddings_telemetry.test.js +126 -0
  35. package/tests/instrumentation/openai/get_streaming_usage.test.js +76 -0
  36. package/src/otel/openai-streaming-usage.js +0 -60
  37. /package/src/instrumentation/{elevenlabs.js → elevenlabs/full_instrumentation.js} +0 -0
@@ -0,0 +1,27 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * Context-caching token enrichment for the Google GenAI (Gemini) chat span.
5
+ *
6
+ * Neither instrumentor records cached-content tokens, so we read
7
+ * `usageMetadata.cachedContentTokenCount` (explicit or implicit caching) and
8
+ * split it by modality: audio cached tokens go to
9
+ * `gen_ai.usage.input_tokens_details.cached_audio_tokens` (normalized to
10
+ * token_audio_cached) and the remainder to `gen_ai.usage.cache_read_input_tokens`
11
+ * (normalized to token_text_cached).
12
+ */
13
+
14
+ const { _audioTokens } = require('./get_audio_telemetry');
15
+
16
+ function setCacheTelemetry(span, response) {
17
+ const usage = response && response.usageMetadata;
18
+ const cachedTokens = (usage && usage.cachedContentTokenCount) || 0;
19
+ if (!cachedTokens) return;
20
+ const cachedAudio = _audioTokens(usage.cacheTokensDetails);
21
+ if (cachedAudio)
22
+ span.setAttribute('gen_ai.usage.input_tokens_details.cached_audio_tokens', cachedAudio);
23
+ const cacheRead = Math.max(0, cachedTokens - cachedAudio);
24
+ if (cacheRead) span.setAttribute('gen_ai.usage.cache_read_input_tokens', cacheRead);
25
+ }
26
+
27
+ module.exports = { setCacheTelemetry };
@@ -0,0 +1,78 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * Embeddings-endpoint telemetry for Google GenAI (Gemini).
5
+ *
6
+ * `@traceloop/instrumentation-google-generativeai` wraps generate_content but not
7
+ * embeddings, so this covers it by starting its own span on the private
8
+ * `Models.prototype.embedContentInternal` (which the public `embedContent`
9
+ * delegates to). The Gemini Developer API returns NO token usage on embedContent
10
+ * (only Vertex does), so the span records the billable unit weflayr can price:
11
+ * the input character count under `gen_ai.usage.input_characters` (normalized to
12
+ * count_char).
13
+ */
14
+
15
+ const { trace, SpanStatusCode } = require('@opentelemetry/api');
16
+
17
+ const { getProviderName } = require('./get_provider_name');
18
+
19
+ const TRACER_NAME = 'weflayr.instrumentation.google.embeddings';
20
+ const EMBEDDINGS_OPERATION = 'embeddings';
21
+
22
+ // `contents` is a string, a Content/Part object, or an array of those; the
23
+ // billable unit is the total number of characters of text across them.
24
+ function _contentCharacters(contents) {
25
+ if (contents == null) return 0;
26
+ if (typeof contents === 'string') return contents.length;
27
+ if (Array.isArray(contents)) {
28
+ return contents.reduce((total, item) => total + _contentCharacters(item), 0);
29
+ }
30
+ if (typeof contents === 'object') {
31
+ if (typeof contents.text === 'string') return contents.text.length;
32
+ if (Array.isArray(contents.parts)) return _contentCharacters(contents.parts);
33
+ }
34
+ return 0;
35
+ }
36
+
37
+ function _recordError(span, error) {
38
+ span.setStatus({ code: SpanStatusCode.ERROR, message: error?.message ?? String(error) });
39
+ span.recordException(error);
40
+ }
41
+
42
+ // Wrap `Models.prototype.embedContentInternal`, pushing the restore tuple onto
43
+ // the shared `patched` array the orchestrator owns for uninstrument().
44
+ function instrumentEmbeddings(Models, patched) {
45
+ const owner = Models.prototype;
46
+ const original = owner.embedContentInternal;
47
+ if (typeof original !== 'function') return;
48
+
49
+ function wrapper(params, ...rest) {
50
+ const span = trace.getTracer(TRACER_NAME).startSpan(EMBEDDINGS_OPERATION);
51
+ span.setAttribute('gen_ai.system', getProviderName(this));
52
+ span.setAttribute('gen_ai.operation.name', EMBEDDINGS_OPERATION);
53
+ if (params && params.model) {
54
+ // The chat path strips the leading "models/" prefix; mirror it.
55
+ span.setAttribute('gen_ai.request.model', params.model.replace(/^models\//, ''));
56
+ }
57
+ span.setAttribute(
58
+ 'gen_ai.usage.input_characters',
59
+ _contentCharacters(params && params.contents)
60
+ );
61
+ return Promise.resolve(original.call(this, params, ...rest)).then(
62
+ (response) => {
63
+ span.end();
64
+ return response;
65
+ },
66
+ (error) => {
67
+ _recordError(span, error);
68
+ span.end();
69
+ throw error;
70
+ }
71
+ );
72
+ }
73
+
74
+ owner.embedContentInternal = wrapper;
75
+ patched.push([owner, 'embedContentInternal', original]);
76
+ }
77
+
78
+ module.exports = { instrumentEmbeddings };
@@ -0,0 +1,25 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * Provider-name enrichment for the Google GenAI (Gemini) chat span.
5
+ *
6
+ * `@traceloop/instrumentation-google-generativeai` hardcodes
7
+ * `gen_ai.provider.name = "gcp.gen_ai"` and can't tell Vertex from the Gemini
8
+ * Developer API. We read the client's Vertex flag and return the value to set as
9
+ * `gen_ai.system` (which the normalizer prefers): `vertex_ai` / `gemini`,
10
+ * matching what the Python google-genai instrumentor reports natively. Node-only.
11
+ */
12
+
13
+ // Read the Vertex-vs-Dev backend off the Models instance's api client.
14
+ function getProviderName(instance) {
15
+ try {
16
+ if (instance && instance.apiClient && typeof instance.apiClient.isVertexAI === 'function') {
17
+ return instance.apiClient.isVertexAI() ? 'vertex_ai' : 'gemini';
18
+ }
19
+ } catch {
20
+ // fall through to default
21
+ }
22
+ return 'gemini';
23
+ }
24
+
25
+ module.exports = { getProviderName };
@@ -0,0 +1,21 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * Reasoning (thinking) token enrichment for the Google GenAI (Gemini) chat span.
5
+ *
6
+ * Neither instrumentor surfaces the thinking budget. Gemini reports thinking
7
+ * under `usageMetadata.thoughtsTokenCount`, which is SEPARATE from
8
+ * `candidatesTokenCount` (the visible output) and excluded from the totals, so
9
+ * without this the thinking tokens are lost. Stamp them as
10
+ * `gen_ai.usage.thoughts_token_count` so the normalizer can fold them into the
11
+ * completion count.
12
+ */
13
+
14
+ function setReasoningTelemetry(span, response) {
15
+ const usage = response && response.usageMetadata;
16
+ if (!usage) return;
17
+ const thoughts = usage.thoughtsTokenCount || 0;
18
+ if (thoughts) span.setAttribute('gen_ai.usage.thoughts_token_count', thoughts);
19
+ }
20
+
21
+ module.exports = { setReasoningTelemetry };
@@ -0,0 +1,98 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * Google GenAI (Gemini) telemetry complement — the registered orchestrator.
5
+ *
6
+ * Wires every weflayr-supplied patch the traceloop Google instrumentor misses:
7
+ * - chat span enrichment (one wrap of generateContent{,Stream}Internal that
8
+ * stamps provider name + audio tokens + cache tokens — see the get_*_telemetry
9
+ * files), and
10
+ * - the embeddings endpoint it doesn't cover at all.
11
+ *
12
+ * The public arrows delegate to these private prototype methods while the
13
+ * traceloop span is the active span, so enrichment lands on that span.
14
+ */
15
+
16
+ const { trace } = require('@opentelemetry/api');
17
+
18
+ const { getProviderName } = require('./get_provider_name');
19
+ const { setAudioTelemetry } = require('./get_audio_telemetry');
20
+ const { setCacheTelemetry } = require('./get_cache_telemetry');
21
+ const { setReasoningTelemetry } = require('./get_reasoning_telemetry');
22
+ const { instrumentEmbeddings } = require('./get_embeddings_telemetry');
23
+
24
+ class GoogleTelemetryInstrumentor {
25
+ constructor() {
26
+ // [ownerPrototype, methodName, originalFunction] for uninstrument().
27
+ this._patched = [];
28
+ }
29
+
30
+ instrument() {
31
+ let Models;
32
+ try {
33
+ ({ Models } = require('@google/genai'));
34
+ } catch (err) {
35
+ throw new Error(
36
+ 'weflayr.autoInstrument(GOOGLE_GENAI): the @google/genai client is not installed. ' +
37
+ 'Install it with: npm install @google/genai\n' +
38
+ `Underlying error: ${err.message}`
39
+ );
40
+ }
41
+
42
+ // Non-streaming: stamp provider up front, audio + cache tokens off the response.
43
+ this._wrapChat(Models.prototype, 'generateContentInternal', { stream: false });
44
+ // Streaming: stamp provider, then cache tokens off the final chunk's usageMetadata.
45
+ this._wrapChat(Models.prototype, 'generateContentStreamInternal', { stream: true });
46
+ // Embeddings: an endpoint the traceloop instrumentor doesn't cover at all.
47
+ instrumentEmbeddings(Models, this._patched);
48
+ }
49
+
50
+ _wrapChat(owner, methodName, { stream }) {
51
+ const original = owner[methodName];
52
+
53
+ function wrapper(...args) {
54
+ const span = trace.getActiveSpan();
55
+ if (!span || !span.isRecording || !span.isRecording()) {
56
+ return original.apply(this, args);
57
+ }
58
+ span.setAttribute('gen_ai.system', getProviderName(this));
59
+ if (!stream) {
60
+ return Promise.resolve(original.apply(this, args)).then((response) => {
61
+ setAudioTelemetry(span, response);
62
+ setCacheTelemetry(span, response);
63
+ setReasoningTelemetry(span, response);
64
+ return response;
65
+ });
66
+ }
67
+ // Streamed: usage (incl. cachedContentTokenCount) lands on the final chunk;
68
+ // observe the chunks as they pass through. The instrumentor keeps the span
69
+ // open until the stream is exhausted.
70
+ return Promise.resolve(original.apply(this, args)).then((stream_) => {
71
+ if (!stream_ || typeof stream_[Symbol.asyncIterator] !== 'function') return stream_;
72
+ return (async function* observeCache() {
73
+ for await (const chunk of stream_) {
74
+ try {
75
+ setCacheTelemetry(span, chunk);
76
+ setReasoningTelemetry(span, chunk);
77
+ } catch {
78
+ // Never break the caller's stream over an enrichment failure.
79
+ }
80
+ yield chunk;
81
+ }
82
+ })();
83
+ });
84
+ }
85
+
86
+ owner[methodName] = wrapper;
87
+ this._patched.push([owner, methodName, original]);
88
+ }
89
+
90
+ uninstrument() {
91
+ for (const [owner, methodName, original] of this._patched) {
92
+ owner[methodName] = original;
93
+ }
94
+ this._patched = [];
95
+ }
96
+ }
97
+
98
+ module.exports = { GoogleTelemetryInstrumentor };
@@ -0,0 +1,149 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * Hand-written OTel instrumentor for the OpenAI audio endpoints.
5
+ *
6
+ * The `@traceloop/instrumentation-openai` package wraps OpenAI's chat,
7
+ * completions, responses and image endpoints, but not the audio ones, so this
8
+ * ships inside weflayr to cover them. It wraps the Text-to-Speech and
9
+ * Speech-to-Text entrypoints to emit one `gen_ai.*` span per call, which flows
10
+ * through the standard span processor -> exporter with no new transport code. It
11
+ * is registered alongside the traceloop instrumentor whenever
12
+ * `autoInstrument({ aiSdks: 'openai' })` runs.
13
+ *
14
+ * The billable unit differs by API, so each span records the one OpenAI bills:
15
+ * - Text-to-Speech is billed per input character -> `gen_ai.usage.input_characters`.
16
+ * - Speech-to-Text is billed per second of audio -> `gen_ai.usage.input_seconds`.
17
+ *
18
+ * Both endpoints are request/response (unary): `audio.speech.create` resolves to
19
+ * the full audio and `audio.transcriptions.create` to the transcription. The STT
20
+ * audio length is only present when the call requests `response_format: 'verbose_json'`.
21
+ */
22
+
23
+ const { trace, SpanStatusCode } = require('@opentelemetry/api');
24
+
25
+ const TRACER_NAME = 'weflayr.instrumentation.openai_audio';
26
+ const TTS_OPERATION = 'text_to_speech';
27
+ const STT_OPERATION = 'speech_to_text';
28
+
29
+ // Return the gen_ai.system for this call, matching how the OpenAI chat
30
+ // instrumentor attributes the vendor: Azure clients (reached via the same openai
31
+ // SDK) report `azure.ai.openai`, everything else `openai`.
32
+ function _detectSystem(instance) {
33
+ const baseURL = (instance && instance._client && instance._client.baseURL) || '';
34
+ return baseURL.toLowerCase().includes('openai.azure.com') ? 'azure.ai.openai' : 'openai';
35
+ }
36
+
37
+ function _startSpan(operation, body, system) {
38
+ const span = trace.getTracer(TRACER_NAME).startSpan(operation);
39
+ span.setAttribute('gen_ai.system', system);
40
+ span.setAttribute('gen_ai.operation.name', operation);
41
+ // `model` lives on the request body passed to both audio entrypoints.
42
+ const model = body && body.model;
43
+ if (model) {
44
+ span.setAttribute('gen_ai.request.model', model);
45
+ }
46
+ return span;
47
+ }
48
+
49
+ function _setInputCharacters(span, body) {
50
+ // `input` is the text passed to text_to_speech; the billable unit is its length.
51
+ span.setAttribute('gen_ai.usage.input_characters', ((body && body.input) || '').length);
52
+ }
53
+
54
+ function _setAudioDuration(span, response) {
55
+ // `duration` (seconds) is only present on a verbose transcription response;
56
+ // it is the billable unit for speech-to-text.
57
+ const durationSecs = response && response.duration;
58
+ if (durationSecs != null) {
59
+ span.setAttribute('gen_ai.usage.input_seconds', durationSecs);
60
+ }
61
+ }
62
+
63
+ function _recordError(span, error) {
64
+ span.setStatus({ code: SpanStatusCode.ERROR, message: error?.message ?? String(error) });
65
+ span.recordException(error);
66
+ }
67
+
68
+ // Wrap a request/response entrypoint: the span spans the single call, and any
69
+ // response-derived billable unit is read off the result.
70
+ function _consumeUnary(span, responsePromise, setResponseAttributes) {
71
+ return responsePromise.then(
72
+ (response) => {
73
+ if (setResponseAttributes) {
74
+ setResponseAttributes(span, response);
75
+ }
76
+ span.end();
77
+ return response;
78
+ },
79
+ (error) => {
80
+ _recordError(span, error);
81
+ span.end();
82
+ throw error;
83
+ }
84
+ );
85
+ }
86
+
87
+ class OpenAIAudioInstrumentor {
88
+ constructor() {
89
+ // [ownerPrototype, methodName, originalFunction] for uninstrument().
90
+ this._patched = [];
91
+ }
92
+
93
+ instrument() {
94
+ let Speech;
95
+ let Transcriptions;
96
+ try {
97
+ ({ Speech } = require('openai/resources/audio/speech'));
98
+ ({ Transcriptions } = require('openai/resources/audio/transcriptions'));
99
+ } catch (err) {
100
+ throw new Error(
101
+ 'weflayr.autoInstrument(OPENAI): the openai client is not installed. ' +
102
+ 'Install it with: npm install openai\n' +
103
+ `Underlying error: ${err.message}`
104
+ );
105
+ }
106
+
107
+ // TTS — request body is the 1st arg; billed per character.
108
+ this._wrap(Speech.prototype, {
109
+ operation: TTS_OPERATION,
110
+ setRequestAttributes: _setInputCharacters,
111
+ setResponseAttributes: null,
112
+ });
113
+
114
+ // STT — request body is the 1st arg; billed per second of audio.
115
+ this._wrap(Transcriptions.prototype, {
116
+ operation: STT_OPERATION,
117
+ setRequestAttributes: null,
118
+ setResponseAttributes: _setAudioDuration,
119
+ });
120
+ }
121
+
122
+ uninstrument() {
123
+ for (const [owner, methodName, original] of this._patched) {
124
+ owner[methodName] = original;
125
+ }
126
+ this._patched = [];
127
+ }
128
+
129
+ _wrap(owner, { operation, setRequestAttributes, setResponseAttributes }) {
130
+ const original = owner.create;
131
+
132
+ function wrapper(body, ...rest) {
133
+ const span = _startSpan(operation, body, _detectSystem(this));
134
+ if (setRequestAttributes) {
135
+ setRequestAttributes(span, body);
136
+ }
137
+ return _consumeUnary(
138
+ span,
139
+ Promise.resolve(original.call(this, body, ...rest)),
140
+ setResponseAttributes
141
+ );
142
+ }
143
+
144
+ owner.create = wrapper;
145
+ this._patched.push([owner, 'create', original]);
146
+ }
147
+ }
148
+
149
+ module.exports = { OpenAIAudioInstrumentor };
@@ -0,0 +1,71 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * Cached-prompt token enrichment complement for the non-streamed OpenAI chat path.
5
+ *
6
+ * `@traceloop/instrumentation-openai` records `gen_ai.usage.{input,output}_tokens`
7
+ * for non-streamed calls but never reads `usage.prompt_tokens_details.cached_tokens`,
8
+ * so spans for prompt-cache hits carry no cached-token count. The Python
9
+ * OpenLLMetry instrumentor sets `gen_ai.usage.cache_read_input_tokens` from that
10
+ * field, so this brings the Node SDK to parity.
11
+ *
12
+ * It wraps the instrumentor instance's `_endSpan({ span, type, result })`, which
13
+ * finalizes the span after the response resolves, letting us stamp the
14
+ * cached-token count off `result.usage` while the span is still open. OpenAI has
15
+ * no separate cache-write count, so only `cache_read_input_tokens` is set.
16
+ *
17
+ * The same hook surfaces the reasoning-token count: reasoning models report it as
18
+ * `usage.completion_tokens_details.reasoning_tokens` (a subset of output_tokens)
19
+ * which the Node instrumentor drops, so this stamps the flat `reasoning_tokens`
20
+ * attribute (the form the Python instrumentor emits and the normalizer reads).
21
+ */
22
+
23
+ const CACHE_READ_INPUT_TOKENS_ATTR = 'gen_ai.usage.cache_read_input_tokens';
24
+ const REASONING_TOKENS_ATTR = 'gen_ai.usage.reasoning_tokens';
25
+
26
+ class OpenAIPromptCachingInstrumentor {
27
+ constructor() {
28
+ // [instrumentation, methodName, originalFunction] for uninstrument().
29
+ this._patched = [];
30
+ }
31
+
32
+ // No-op (and never throws) if the instrumentor's internals have changed shape —
33
+ // the worst case is a missing cached-token count, never a crash.
34
+ instrument(instrumentation) {
35
+ const original = instrumentation && instrumentation._endSpan;
36
+ if (typeof original !== 'function') return;
37
+
38
+ instrumentation._endSpan = function endSpanWithCache(args) {
39
+ try {
40
+ const span = args && args.span;
41
+ const usage = args && args.result && args.result.usage;
42
+ const recording = span && span.isRecording && span.isRecording();
43
+ const cachedTokens =
44
+ usage && usage.prompt_tokens_details && usage.prompt_tokens_details.cached_tokens;
45
+ if (cachedTokens && recording) {
46
+ span.setAttribute(CACHE_READ_INPUT_TOKENS_ATTR, cachedTokens);
47
+ }
48
+ const reasoningTokens =
49
+ usage &&
50
+ usage.completion_tokens_details &&
51
+ usage.completion_tokens_details.reasoning_tokens;
52
+ if (reasoningTokens && recording) {
53
+ span.setAttribute(REASONING_TOKENS_ATTR, reasoningTokens);
54
+ }
55
+ } catch {
56
+ // Never break span finalization over an enrichment failure.
57
+ }
58
+ return original.call(this, args);
59
+ };
60
+ this._patched.push([instrumentation, '_endSpan', original]);
61
+ }
62
+
63
+ uninstrument() {
64
+ for (const [owner, methodName, original] of this._patched) {
65
+ owner[methodName] = original;
66
+ }
67
+ this._patched = [];
68
+ }
69
+ }
70
+
71
+ module.exports = { OpenAIPromptCachingInstrumentor };
@@ -0,0 +1,95 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * Hand-written OTel instrumentor for the OpenAI embeddings endpoint.
5
+ *
6
+ * `@traceloop/instrumentation-openai` (the package weflayr uses for OpenAI on
7
+ * Node) does not wrap the embeddings endpoint, so this ships inside weflayr to
8
+ * cover it. The Python SDK gets embeddings for free from OpenLLMetry's
9
+ * instrumentor, so there is no Python counterpart to this file — but the span it
10
+ * emits is shaped to normalize identically. It is registered alongside the
11
+ * traceloop instrumentor whenever `autoInstrument({ aiSdks: 'openai' })` runs.
12
+ *
13
+ * Embeddings are billed per input token, so the span records the prompt tokens
14
+ * read off the response under `gen_ai.usage.input_tokens`; there is no completion.
15
+ */
16
+
17
+ const { trace, SpanStatusCode } = require('@opentelemetry/api');
18
+
19
+ const TRACER_NAME = 'weflayr.instrumentation.openai_embeddings';
20
+ const EMBEDDINGS_OPERATION = 'embeddings';
21
+
22
+ // Return the gen_ai.system for this call, matching how the OpenAI chat
23
+ // instrumentor attributes the vendor: Azure clients (reached via the same openai
24
+ // SDK) report `azure.ai.openai`, everything else `openai`.
25
+ function _detectSystem(instance) {
26
+ const baseURL = (instance && instance._client && instance._client.baseURL) || '';
27
+ return baseURL.toLowerCase().includes('openai.azure.com') ? 'azure.ai.openai' : 'openai';
28
+ }
29
+
30
+ function _recordError(span, error) {
31
+ span.setStatus({ code: SpanStatusCode.ERROR, message: error?.message ?? String(error) });
32
+ span.recordException(error);
33
+ }
34
+
35
+ class OpenAIEmbeddingsInstrumentor {
36
+ constructor() {
37
+ // [ownerPrototype, methodName, originalFunction] for uninstrument().
38
+ this._patched = [];
39
+ }
40
+
41
+ instrument() {
42
+ let Embeddings;
43
+ try {
44
+ ({ Embeddings } = require('openai/resources/embeddings'));
45
+ } catch (err) {
46
+ throw new Error(
47
+ 'weflayr.autoInstrument(OPENAI): the openai client is not installed. ' +
48
+ 'Install it with: npm install openai\n' +
49
+ `Underlying error: ${err.message}`
50
+ );
51
+ }
52
+
53
+ const owner = Embeddings.prototype;
54
+ const original = owner.create;
55
+
56
+ function wrapper(body, ...rest) {
57
+ const span = trace.getTracer(TRACER_NAME).startSpan(EMBEDDINGS_OPERATION);
58
+ span.setAttribute('gen_ai.system', _detectSystem(this));
59
+ span.setAttribute('gen_ai.operation.name', EMBEDDINGS_OPERATION);
60
+ if (body && body.model) {
61
+ span.setAttribute('gen_ai.request.model', body.model);
62
+ }
63
+ return Promise.resolve(original.call(this, body, ...rest)).then(
64
+ (response) => {
65
+ if (response && response.model) {
66
+ span.setAttribute('gen_ai.response.model', response.model);
67
+ }
68
+ const promptTokens = response && response.usage && response.usage.prompt_tokens;
69
+ if (promptTokens != null) {
70
+ span.setAttribute('gen_ai.usage.input_tokens', promptTokens);
71
+ }
72
+ span.end();
73
+ return response;
74
+ },
75
+ (error) => {
76
+ _recordError(span, error);
77
+ span.end();
78
+ throw error;
79
+ }
80
+ );
81
+ }
82
+
83
+ owner.create = wrapper;
84
+ this._patched.push([owner, 'create', original]);
85
+ }
86
+
87
+ uninstrument() {
88
+ for (const [owner, methodName, original] of this._patched) {
89
+ owner[methodName] = original;
90
+ }
91
+ this._patched = [];
92
+ }
93
+ }
94
+
95
+ module.exports = { OpenAIEmbeddingsInstrumentor };
@@ -0,0 +1,81 @@
1
+ 'use strict';
2
+
3
+ /**
4
+ * Streamed token-usage enrichment complement for the OpenAI chat path.
5
+ *
6
+ * `@traceloop/instrumentation-openai` does not record token usage for streamed
7
+ * calls: its stream handler accumulates `choices[].delta` but never reads the
8
+ * final usage chunk OpenAI sends when the request sets
9
+ * `stream_options: { include_usage: true }`. Non-streaming calls work because
10
+ * OpenAI returns `usage` in the response body, which the instrumentor reads
11
+ * directly. The Python OpenLLMetry instrumentor reads the streamed usage, so
12
+ * this gap is Node-only.
13
+ *
14
+ * It wraps the instrumentor instance's `_streamingWrapPromise`: that handler
15
+ * hands us the span and ends it only after its chunk loop, so when the usage
16
+ * chunk arrives the span is still open and we set the same `gen_ai.usage.*`
17
+ * attributes the instrumentor sets for non-streaming calls.
18
+ */
19
+
20
+ const USAGE_INPUT_TOKENS_ATTR = 'gen_ai.usage.input_tokens';
21
+ const USAGE_OUTPUT_TOKENS_ATTR = 'gen_ai.usage.output_tokens';
22
+ const USAGE_TOTAL_TOKENS_ATTR = 'gen_ai.usage.total_tokens';
23
+ const CACHE_READ_INPUT_TOKENS_ATTR = 'gen_ai.usage.cache_read_input_tokens';
24
+
25
+ function _setUsageAttributes(span, usage) {
26
+ if (typeof usage.prompt_tokens === 'number') {
27
+ span.setAttribute(USAGE_INPUT_TOKENS_ATTR, usage.prompt_tokens);
28
+ }
29
+ if (typeof usage.completion_tokens === 'number') {
30
+ span.setAttribute(USAGE_OUTPUT_TOKENS_ATTR, usage.completion_tokens);
31
+ }
32
+ if (typeof usage.total_tokens === 'number') {
33
+ span.setAttribute(USAGE_TOTAL_TOKENS_ATTR, usage.total_tokens);
34
+ }
35
+ // Cached-prompt tokens ride in the same streamed usage chunk; mirror the
36
+ // non-streamed cache backfill in get_cache_and_reasoning_telemetry.js.
37
+ const cachedTokens = usage.prompt_tokens_details && usage.prompt_tokens_details.cached_tokens;
38
+ if (cachedTokens) {
39
+ span.setAttribute(CACHE_READ_INPUT_TOKENS_ATTR, cachedTokens);
40
+ }
41
+ }
42
+
43
+ class OpenAIStreamingUsageInstrumentor {
44
+ constructor() {
45
+ // [instrumentation, methodName, originalFunction] for uninstrument().
46
+ this._patched = [];
47
+ }
48
+
49
+ // No-op if the instrumentor's internals have changed shape — the worst case is
50
+ // streamed spans without token counts, never a crash.
51
+ instrument(instrumentation) {
52
+ const original = instrumentation && instrumentation._streamingWrapPromise;
53
+ if (typeof original !== 'function') return;
54
+
55
+ instrumentation._streamingWrapPromise = function streamingWrapWithUsage(streamArgs) {
56
+ const span = streamArgs && streamArgs.span;
57
+ const wrappedStream = original.call(this, streamArgs);
58
+ if (!span) return wrappedStream;
59
+
60
+ return (async function* backfillUsage() {
61
+ for await (const chunk of wrappedStream) {
62
+ const usage = chunk && chunk.usage;
63
+ if (usage && span.isRecording()) {
64
+ _setUsageAttributes(span, usage);
65
+ }
66
+ yield chunk;
67
+ }
68
+ })();
69
+ };
70
+ this._patched.push([instrumentation, '_streamingWrapPromise', original]);
71
+ }
72
+
73
+ uninstrument() {
74
+ for (const [owner, methodName, original] of this._patched) {
75
+ owner[methodName] = original;
76
+ }
77
+ this._patched = [];
78
+ }
79
+ }
80
+
81
+ module.exports = { OpenAIStreamingUsageInstrumentor };