@microsoft/agents-a365-observability 0.1.0-preview.123 → 0.1.0-preview.125
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.
- package/dist/cjs/ObservabilityBuilder.d.ts +8 -0
- package/dist/cjs/ObservabilityBuilder.d.ts.map +1 -1
- package/dist/cjs/ObservabilityBuilder.js +17 -5
- package/dist/cjs/ObservabilityBuilder.js.map +1 -1
- package/dist/cjs/index.d.ts +2 -2
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +5 -6
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/tracing/constants.d.ts +2 -1
- package/dist/cjs/tracing/constants.d.ts.map +1 -1
- package/dist/cjs/tracing/constants.js +1 -0
- package/dist/cjs/tracing/constants.js.map +1 -1
- package/dist/cjs/tracing/context/trace-context-propagation.d.ts +7 -7
- package/dist/cjs/tracing/context/trace-context-propagation.d.ts.map +1 -1
- package/dist/cjs/tracing/context/trace-context-propagation.js +9 -9
- package/dist/cjs/tracing/context/trace-context-propagation.js.map +1 -1
- package/dist/cjs/tracing/contracts.d.ts +48 -15
- package/dist/cjs/tracing/contracts.d.ts.map +1 -1
- package/dist/cjs/tracing/contracts.js +2 -3
- package/dist/cjs/tracing/contracts.js.map +1 -1
- package/dist/cjs/tracing/middleware/BaggageBuilder.d.ts +7 -0
- package/dist/cjs/tracing/middleware/BaggageBuilder.d.ts.map +1 -1
- package/dist/cjs/tracing/middleware/BaggageBuilder.js +16 -0
- package/dist/cjs/tracing/middleware/BaggageBuilder.js.map +1 -1
- package/dist/cjs/tracing/scopes/ExecuteToolScope.d.ts +8 -18
- package/dist/cjs/tracing/scopes/ExecuteToolScope.d.ts.map +1 -1
- package/dist/cjs/tracing/scopes/ExecuteToolScope.js +20 -22
- package/dist/cjs/tracing/scopes/ExecuteToolScope.js.map +1 -1
- package/dist/cjs/tracing/scopes/InferenceScope.d.ts +8 -14
- package/dist/cjs/tracing/scopes/InferenceScope.d.ts.map +1 -1
- package/dist/cjs/tracing/scopes/InferenceScope.js +20 -19
- package/dist/cjs/tracing/scopes/InferenceScope.js.map +1 -1
- package/dist/cjs/tracing/scopes/InvokeAgentScope.d.ts +11 -14
- package/dist/cjs/tracing/scopes/InvokeAgentScope.d.ts.map +1 -1
- package/dist/cjs/tracing/scopes/InvokeAgentScope.js +42 -41
- package/dist/cjs/tracing/scopes/InvokeAgentScope.js.map +1 -1
- package/dist/cjs/tracing/scopes/OpenTelemetryScope.d.ts +15 -17
- package/dist/cjs/tracing/scopes/OpenTelemetryScope.d.ts.map +1 -1
- package/dist/cjs/tracing/scopes/OpenTelemetryScope.js +37 -30
- package/dist/cjs/tracing/scopes/OpenTelemetryScope.js.map +1 -1
- package/dist/cjs/tracing/scopes/OutputScope.d.ts +7 -13
- package/dist/cjs/tracing/scopes/OutputScope.d.ts.map +1 -1
- package/dist/cjs/tracing/scopes/OutputScope.js +19 -17
- package/dist/cjs/tracing/scopes/OutputScope.js.map +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/ObservabilityBuilder.d.ts +8 -0
- package/dist/esm/ObservabilityBuilder.d.ts.map +1 -1
- package/dist/esm/ObservabilityBuilder.js +18 -6
- package/dist/esm/ObservabilityBuilder.js.map +1 -1
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +3 -4
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/tracing/constants.d.ts +2 -1
- package/dist/esm/tracing/constants.d.ts.map +1 -1
- package/dist/esm/tracing/constants.js +1 -0
- package/dist/esm/tracing/constants.js.map +1 -1
- package/dist/esm/tracing/context/trace-context-propagation.d.ts +7 -7
- package/dist/esm/tracing/context/trace-context-propagation.d.ts.map +1 -1
- package/dist/esm/tracing/context/trace-context-propagation.js +7 -7
- package/dist/esm/tracing/context/trace-context-propagation.js.map +1 -1
- package/dist/esm/tracing/contracts.d.ts +48 -15
- package/dist/esm/tracing/contracts.d.ts.map +1 -1
- package/dist/esm/tracing/contracts.js +2 -3
- package/dist/esm/tracing/contracts.js.map +1 -1
- package/dist/esm/tracing/middleware/BaggageBuilder.d.ts +7 -0
- package/dist/esm/tracing/middleware/BaggageBuilder.d.ts.map +1 -1
- package/dist/esm/tracing/middleware/BaggageBuilder.js +16 -0
- package/dist/esm/tracing/middleware/BaggageBuilder.js.map +1 -1
- package/dist/esm/tracing/scopes/ExecuteToolScope.d.ts +8 -18
- package/dist/esm/tracing/scopes/ExecuteToolScope.d.ts.map +1 -1
- package/dist/esm/tracing/scopes/ExecuteToolScope.js +20 -22
- package/dist/esm/tracing/scopes/ExecuteToolScope.js.map +1 -1
- package/dist/esm/tracing/scopes/InferenceScope.d.ts +8 -14
- package/dist/esm/tracing/scopes/InferenceScope.d.ts.map +1 -1
- package/dist/esm/tracing/scopes/InferenceScope.js +20 -19
- package/dist/esm/tracing/scopes/InferenceScope.js.map +1 -1
- package/dist/esm/tracing/scopes/InvokeAgentScope.d.ts +11 -14
- package/dist/esm/tracing/scopes/InvokeAgentScope.d.ts.map +1 -1
- package/dist/esm/tracing/scopes/InvokeAgentScope.js +42 -41
- package/dist/esm/tracing/scopes/InvokeAgentScope.js.map +1 -1
- package/dist/esm/tracing/scopes/OpenTelemetryScope.d.ts +15 -17
- package/dist/esm/tracing/scopes/OpenTelemetryScope.d.ts.map +1 -1
- package/dist/esm/tracing/scopes/OpenTelemetryScope.js +38 -31
- package/dist/esm/tracing/scopes/OpenTelemetryScope.js.map +1 -1
- package/dist/esm/tracing/scopes/OutputScope.d.ts +7 -13
- package/dist/esm/tracing/scopes/OutputScope.d.ts.map +1 -1
- package/dist/esm/tracing/scopes/OutputScope.js +19 -17
- package/dist/esm/tracing/scopes/OutputScope.js.map +1 -1
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/package.json +2 -2
|
@@ -9,54 +9,55 @@ import { OpenTelemetryConstants } from '../constants';
|
|
|
9
9
|
export class InvokeAgentScope extends OpenTelemetryScope {
|
|
10
10
|
/**
|
|
11
11
|
* Creates and starts a new scope for agent invocation tracing.
|
|
12
|
-
*
|
|
13
|
-
* @param
|
|
14
|
-
* @param
|
|
15
|
-
* @param
|
|
16
|
-
* @param
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* @param
|
|
21
|
-
* Use `SpanKind.SERVER` when the agent is receiving an inbound request.
|
|
12
|
+
*
|
|
13
|
+
* @param request Request payload (channel, conversationId, content, sessionId).
|
|
14
|
+
* @param invokeScopeDetails Scope-level details
|
|
15
|
+
* @param agentDetails The agent identity. Tenant ID is derived from `agentDetails.tenantId` (required).
|
|
16
|
+
* @param callerDetails Optional caller information. Supports three scenarios:
|
|
17
|
+
* - Human caller only: `{ userDetails: { userId, userName, ... } }`
|
|
18
|
+
* - Agent caller only: `{ callerAgentDetails: { agentId, agentName, ... } }`
|
|
19
|
+
* - Both (A2A with human in chain): `{ userDetails: { ... }, callerAgentDetails: { ... } }`
|
|
20
|
+
* @param spanDetails Optional span configuration (parentContext, startTime, endTime, spanKind, spanLinks).
|
|
22
21
|
* @returns A new InvokeAgentScope instance.
|
|
23
22
|
*/
|
|
24
|
-
static start(
|
|
25
|
-
return new InvokeAgentScope(
|
|
23
|
+
static start(request, invokeScopeDetails, agentDetails, callerDetails, spanDetails) {
|
|
24
|
+
return new InvokeAgentScope(request, invokeScopeDetails, agentDetails, callerDetails, spanDetails);
|
|
26
25
|
}
|
|
27
|
-
constructor(
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
26
|
+
constructor(request, invokeScopeDetails, agentDetails, callerDetails, spanDetails) {
|
|
27
|
+
// Validate tenantId is present (required for telemetry)
|
|
28
|
+
if (!agentDetails.tenantId) {
|
|
29
|
+
throw new Error('InvokeAgentScope: tenantId is required on agentDetails');
|
|
30
|
+
}
|
|
31
|
+
const resolvedSpanDetails = { ...spanDetails, spanKind: spanDetails?.spanKind ?? SpanKind.CLIENT };
|
|
32
|
+
super(OpenTelemetryConstants.INVOKE_AGENT_OPERATION_NAME, agentDetails.agentName
|
|
33
|
+
? `${OpenTelemetryConstants.INVOKE_AGENT_OPERATION_NAME} ${agentDetails.agentName}`
|
|
34
|
+
: OpenTelemetryConstants.INVOKE_AGENT_OPERATION_NAME, agentDetails, resolvedSpanDetails, callerDetails?.userDetails);
|
|
35
|
+
// Set provider name from agent details
|
|
36
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_PROVIDER_NAME_KEY, agentDetails.providerName);
|
|
37
|
+
// Set session ID from request
|
|
38
|
+
this.setTagMaybe(OpenTelemetryConstants.SESSION_ID_KEY, request.sessionId);
|
|
39
|
+
if (invokeScopeDetails.endpoint) {
|
|
40
|
+
this.setTagMaybe(OpenTelemetryConstants.SERVER_ADDRESS_KEY, invokeScopeDetails.endpoint.host);
|
|
38
41
|
// Only record port if it is different from 443 (default HTTPS port)
|
|
39
|
-
if (
|
|
40
|
-
this.setTagMaybe(OpenTelemetryConstants.SERVER_PORT_KEY,
|
|
42
|
+
if (invokeScopeDetails.endpoint.port && invokeScopeDetails.endpoint.port !== 443) {
|
|
43
|
+
this.setTagMaybe(OpenTelemetryConstants.SERVER_PORT_KEY, invokeScopeDetails.endpoint.port);
|
|
41
44
|
}
|
|
42
45
|
}
|
|
43
|
-
// Set
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
this.setTagMaybe(OpenTelemetryConstants.CHANNEL_NAME_KEY, requestToUse.channel.name);
|
|
48
|
-
this.setTagMaybe(OpenTelemetryConstants.CHANNEL_LINK_KEY, requestToUse.channel.description);
|
|
49
|
-
}
|
|
46
|
+
// Set channel tags from request
|
|
47
|
+
if (request.channel) {
|
|
48
|
+
this.setTagMaybe(OpenTelemetryConstants.CHANNEL_NAME_KEY, request.channel.name);
|
|
49
|
+
this.setTagMaybe(OpenTelemetryConstants.CHANNEL_LINK_KEY, request.channel.description);
|
|
50
50
|
}
|
|
51
|
-
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CONVERSATION_ID_KEY,
|
|
52
|
-
// Set caller agent details tags
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
this.setTagMaybe(OpenTelemetryConstants.
|
|
56
|
-
this.setTagMaybe(OpenTelemetryConstants.
|
|
57
|
-
this.setTagMaybe(OpenTelemetryConstants.
|
|
58
|
-
this.setTagMaybe(OpenTelemetryConstants.
|
|
59
|
-
this.setTagMaybe(OpenTelemetryConstants.
|
|
51
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CONVERSATION_ID_KEY, request.conversationId);
|
|
52
|
+
// Set caller agent details tags for A2A scenarios
|
|
53
|
+
const callerAgent = callerDetails?.callerAgentDetails;
|
|
54
|
+
if (callerAgent) {
|
|
55
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CALLER_AGENT_NAME_KEY, callerAgent.agentName);
|
|
56
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CALLER_AGENT_ID_KEY, callerAgent.agentId);
|
|
57
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CALLER_AGENT_APPLICATION_ID_KEY, callerAgent.agentBlueprintId);
|
|
58
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CALLER_AGENT_USER_ID_KEY, callerAgent.agentAUID);
|
|
59
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CALLER_AGENT_EMAIL_KEY, callerAgent.agentEmail);
|
|
60
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CALLER_AGENT_PLATFORM_ID_KEY, callerAgent.platformId);
|
|
60
61
|
}
|
|
61
62
|
}
|
|
62
63
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InvokeAgentScope.js","sourceRoot":"","sources":["../../../../src/tracing/scopes/InvokeAgentScope.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,QAAQ,
|
|
1
|
+
{"version":3,"file":"InvokeAgentScope.js","sourceRoot":"","sources":["../../../../src/tracing/scopes/InvokeAgentScope.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAQ1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAEtD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,kBAAkB;IACtD;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,KAAK,CACjB,OAAgB,EAChB,kBAA2C,EAC3C,YAA0B,EAC1B,aAA6B,EAC7B,WAAyB;QAEzB,OAAO,IAAI,gBAAgB,CAAC,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IACrG,CAAC;IAED,YACE,OAAgB,EAChB,kBAA2C,EAC3C,YAA0B,EAC1B,aAA6B,EAC7B,WAAyB;QAEzB,wDAAwD;QACxD,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,MAAM,mBAAmB,GAAgB,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QAEhH,KAAK,CACH,sBAAsB,CAAC,2BAA2B,EAClD,YAAY,CAAC,SAAS;YACpB,CAAC,CAAC,GAAG,sBAAsB,CAAC,2BAA2B,IAAI,YAAY,CAAC,SAAS,EAAE;YACnF,CAAC,CAAC,sBAAsB,CAAC,2BAA2B,EACtD,YAAY,EACZ,mBAAmB,EACnB,aAAa,EAAE,WAAW,CAC3B,CAAC;QAEF,uCAAuC;QACvC,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,wBAAwB,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC;QAE7F,8BAA8B;QAC9B,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,cAAc,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAE3E,IAAI,kBAAkB,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAE9F,oEAAoE;YACpE,IAAI,kBAAkB,CAAC,QAAQ,CAAC,IAAI,IAAI,kBAAkB,CAAC,QAAQ,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;gBACjF,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,eAAe,EAAE,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC7F,CAAC;QACH,CAAC;QAED,gCAAgC;QAChC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAChF,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACzF,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,0BAA0B,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;QAE5F,kDAAkD;QAClD,MAAM,WAAW,GAAG,aAAa,EAAE,kBAAkB,CAAC;QACtD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,4BAA4B,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;YAC7F,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,0BAA0B,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;YACzF,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,sCAAsC,EAAE,WAAW,CAAC,gBAAgB,CAAC,CAAC;YAC9G,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,+BAA+B,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;YAChG,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,6BAA6B,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;YAC/F,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,mCAAmC,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;QACvG,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,QAAgB;QACpC,IAAI,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,mBAAmB,CAAC,QAAkB;QAC3C,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,yBAAyB,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACI,oBAAoB,CAAC,QAAkB;QAC5C,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,0BAA0B,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChG,CAAC;CACF"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { AgentDetails,
|
|
3
|
-
import { ParentContext } from '../context/trace-context-propagation';
|
|
1
|
+
import { Span, AttributeValue, SpanContext, TimeInput } from '@opentelemetry/api';
|
|
2
|
+
import { AgentDetails, UserDetails, SpanDetails } from '../contracts';
|
|
4
3
|
/**
|
|
5
4
|
* Base class for OpenTelemetry tracing scopes
|
|
6
5
|
*/
|
|
@@ -15,22 +14,15 @@ export declare abstract class OpenTelemetryScope implements Disposable {
|
|
|
15
14
|
private hasEnded;
|
|
16
15
|
/**
|
|
17
16
|
* Initializes a new instance of the OpenTelemetryScope class
|
|
18
|
-
* @param kind The kind of span (CLIENT, SERVER, INTERNAL, etc.)
|
|
19
17
|
* @param operationName The name of the operation being traced
|
|
20
18
|
* @param spanName The name of the span for display purposes
|
|
21
|
-
* @param agentDetails Optional agent details
|
|
22
|
-
* @param
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
* @param startTime Optional explicit start time (ms epoch, Date, or HrTime). When provided the span
|
|
27
|
-
* records this timestamp instead of "now", which is useful when recording an operation after it
|
|
28
|
-
* has already completed (e.g. a tool call whose start time was captured earlier).
|
|
29
|
-
* @param endTime Optional explicit end time (ms epoch, Date, or HrTime). When provided the span will
|
|
30
|
-
* use this timestamp when {@link dispose} is called instead of the current wall-clock time.
|
|
31
|
-
* @param callerDetails Optional caller identity details (id, upn, name, client ip).
|
|
19
|
+
* @param agentDetails Optional agent details. Tenant ID is read from `agentDetails.tenantId`.
|
|
20
|
+
* @param spanDetails Optional span configuration including parent context, start/end times,
|
|
21
|
+
* span kind, and span links. Subclasses may override `spanDetails.spanKind` before
|
|
22
|
+
* calling this constructor; defaults to `SpanKind.CLIENT`.
|
|
23
|
+
* @param userDetails Optional human caller identity details (id, upn, name, client ip).
|
|
32
24
|
*/
|
|
33
|
-
protected constructor(
|
|
25
|
+
protected constructor(operationName: string, spanName: string, agentDetails?: AgentDetails, spanDetails?: SpanDetails, userDetails?: UserDetails);
|
|
34
26
|
/**
|
|
35
27
|
* Makes this span active for the duration of the async callback execution
|
|
36
28
|
*/
|
|
@@ -52,7 +44,7 @@ export declare abstract class OpenTelemetryScope implements Disposable {
|
|
|
52
44
|
*/
|
|
53
45
|
recordAttributes(attributes: Iterable<[string, AttributeValue]> | Record<string, AttributeValue> | null | undefined): void;
|
|
54
46
|
/**
|
|
55
|
-
* Sets a tag on the span if
|
|
47
|
+
* Sets a tag on the span if the value is not null or undefined.
|
|
56
48
|
* @param name The tag name
|
|
57
49
|
* @param value The tag value
|
|
58
50
|
*/
|
|
@@ -75,6 +67,12 @@ export declare abstract class OpenTelemetryScope implements Disposable {
|
|
|
75
67
|
* @param endTime The end time as milliseconds since epoch, a Date, or an HrTime tuple.
|
|
76
68
|
*/
|
|
77
69
|
setEndTime(endTime: TimeInput): void;
|
|
70
|
+
/**
|
|
71
|
+
* Records a cancellation event on the span.
|
|
72
|
+
* Sets the span status to ERROR with the cancellation reason and marks the error type as 'TaskCanceledException'.
|
|
73
|
+
* @param reason Optional cancellation reason. Defaults to 'Task was cancelled'.
|
|
74
|
+
*/
|
|
75
|
+
recordCancellation(reason?: string): void;
|
|
78
76
|
/**
|
|
79
77
|
* Finalizes the scope and records metrics
|
|
80
78
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenTelemetryScope.d.ts","sourceRoot":"","sources":["../../../../src/tracing/scopes/OpenTelemetryScope.ts"],"names":[],"mappings":"AAGA,OAAO,
|
|
1
|
+
{"version":3,"file":"OpenTelemetryScope.d.ts","sourceRoot":"","sources":["../../../../src/tracing/scopes/OpenTelemetryScope.ts"],"names":[],"mappings":"AAGA,OAAO,EAAmB,IAAI,EAA2B,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE5H,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAKtE;;GAEG;AACH,8BAAsB,kBAAmB,YAAW,UAAU;IAC5D,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAuD;IAErF,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAC9B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,eAAe,CAAC,CAAY;IACpC,OAAO,CAAC,aAAa,CAAC,CAAY;IAClC,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,SAAS,CAAC,CAAQ;IAC1B,OAAO,CAAC,QAAQ,CAAS;IAEzB;;;;;;;;;OASG;IACH,SAAS,aACP,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,EAChB,YAAY,CAAC,EAAE,YAAY,EAC3B,WAAW,CAAC,EAAE,WAAW,EACzB,WAAW,CAAC,EAAE,WAAW;IAiE3B;;OAEG;IACI,mBAAmB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAKrE;;;;OAIG;IACI,cAAc,IAAI,WAAW;IAIpC;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAkBtC;;;OAGG;IACI,gBAAgB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI;IA2BjI;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI;IAMjI;;;;OAIG;IACH,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAMtD;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAQ5B;;;;;OAKG;IACI,UAAU,CAAC,OAAO,EAAE,SAAS,GAAG,IAAI;IAI3C;;;;OAIG;IACI,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAUhD;;OAEG;IACH,OAAO,CAAC,GAAG;IAuBX;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;IAW/B;;OAEG;IACI,OAAO,IAAI,IAAI;CAIvB"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// Copyright (c) Microsoft Corporation.
|
|
2
2
|
// Licensed under the MIT License.
|
|
3
|
-
import { trace, SpanStatusCode, context } from '@opentelemetry/api';
|
|
3
|
+
import { trace, SpanKind, SpanStatusCode, context } from '@opentelemetry/api';
|
|
4
4
|
import { OpenTelemetryConstants } from '../constants';
|
|
5
5
|
import { createContextWithParentSpanRef } from '../context/parent-span-context';
|
|
6
6
|
import { isParentSpanRef } from '../context/trace-context-propagation';
|
|
@@ -11,23 +11,21 @@ import logger from '../../utils/logging';
|
|
|
11
11
|
export class OpenTelemetryScope {
|
|
12
12
|
/**
|
|
13
13
|
* Initializes a new instance of the OpenTelemetryScope class
|
|
14
|
-
* @param kind The kind of span (CLIENT, SERVER, INTERNAL, etc.)
|
|
15
14
|
* @param operationName The name of the operation being traced
|
|
16
15
|
* @param spanName The name of the span for display purposes
|
|
17
|
-
* @param agentDetails Optional agent details
|
|
18
|
-
* @param
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* @param startTime Optional explicit start time (ms epoch, Date, or HrTime). When provided the span
|
|
23
|
-
* records this timestamp instead of "now", which is useful when recording an operation after it
|
|
24
|
-
* has already completed (e.g. a tool call whose start time was captured earlier).
|
|
25
|
-
* @param endTime Optional explicit end time (ms epoch, Date, or HrTime). When provided the span will
|
|
26
|
-
* use this timestamp when {@link dispose} is called instead of the current wall-clock time.
|
|
27
|
-
* @param callerDetails Optional caller identity details (id, upn, name, client ip).
|
|
16
|
+
* @param agentDetails Optional agent details. Tenant ID is read from `agentDetails.tenantId`.
|
|
17
|
+
* @param spanDetails Optional span configuration including parent context, start/end times,
|
|
18
|
+
* span kind, and span links. Subclasses may override `spanDetails.spanKind` before
|
|
19
|
+
* calling this constructor; defaults to `SpanKind.CLIENT`.
|
|
20
|
+
* @param userDetails Optional human caller identity details (id, upn, name, client ip).
|
|
28
21
|
*/
|
|
29
|
-
constructor(
|
|
22
|
+
constructor(operationName, spanName, agentDetails, spanDetails, userDetails) {
|
|
30
23
|
this.hasEnded = false;
|
|
24
|
+
const parentContext = spanDetails?.parentContext;
|
|
25
|
+
const startTime = spanDetails?.startTime;
|
|
26
|
+
const endTime = spanDetails?.endTime;
|
|
27
|
+
const spanLinks = spanDetails?.spanLinks;
|
|
28
|
+
const kind = spanDetails?.spanKind ?? SpanKind.CLIENT;
|
|
31
29
|
// Determine the context to use for span creation
|
|
32
30
|
let currentContext = context.active();
|
|
33
31
|
if (parentContext) {
|
|
@@ -37,15 +35,16 @@ export class OpenTelemetryScope {
|
|
|
37
35
|
logger.info(`[A365Observability] Using explicit parent span: traceId=${parentContext.traceId}, spanId=${parentContext.spanId}`);
|
|
38
36
|
}
|
|
39
37
|
else {
|
|
40
|
-
// OTel Context path (from
|
|
38
|
+
// OTel Context path (from extractContextFromHeaders or propagation.extract)
|
|
41
39
|
currentContext = parentContext;
|
|
42
40
|
}
|
|
43
41
|
}
|
|
44
|
-
logger.info(`[A365Observability] Starting span: ${spanName}, operation: ${operationName} for tenantId: ${
|
|
42
|
+
logger.info(`[A365Observability] Starting span: ${spanName}, operation: ${operationName} for tenantId: ${agentDetails?.tenantId || 'unknown'}, agentId: ${agentDetails?.agentId || 'unknown'}`);
|
|
45
43
|
// Start span with current context to establish parent-child relationship
|
|
46
44
|
this.span = OpenTelemetryScope.tracer.startSpan(spanName, {
|
|
47
45
|
kind,
|
|
48
46
|
startTime,
|
|
47
|
+
links: spanLinks,
|
|
49
48
|
attributes: {
|
|
50
49
|
[OpenTelemetryConstants.GEN_AI_OPERATION_NAME_KEY]: operationName,
|
|
51
50
|
},
|
|
@@ -62,22 +61,19 @@ export class OpenTelemetryScope {
|
|
|
62
61
|
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_AGENT_NAME_KEY, agentDetails.agentName);
|
|
63
62
|
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_AGENT_DESCRIPTION_KEY, agentDetails.agentDescription);
|
|
64
63
|
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_AGENT_PLATFORM_ID_KEY, agentDetails.platformId);
|
|
65
|
-
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CONVERSATION_ID_KEY, agentDetails.conversationId);
|
|
66
64
|
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_ICON_URI_KEY, agentDetails.iconUri);
|
|
67
65
|
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_AGENT_AUID_KEY, agentDetails.agentAUID);
|
|
68
66
|
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_AGENT_EMAIL_KEY, agentDetails.agentEmail);
|
|
69
67
|
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_AGENT_BLUEPRINT_ID_KEY, agentDetails.agentBlueprintId);
|
|
70
68
|
}
|
|
71
|
-
// Set tenant
|
|
72
|
-
|
|
73
|
-
this.setTagMaybe(OpenTelemetryConstants.TENANT_ID_KEY, tenantDetails.tenantId);
|
|
74
|
-
}
|
|
69
|
+
// Set tenant ID from agent details
|
|
70
|
+
this.setTagMaybe(OpenTelemetryConstants.TENANT_ID_KEY, agentDetails?.tenantId);
|
|
75
71
|
// Set caller details if provided
|
|
76
|
-
if (
|
|
77
|
-
this.setTagMaybe(OpenTelemetryConstants.USER_ID_KEY,
|
|
78
|
-
this.setTagMaybe(OpenTelemetryConstants.USER_EMAIL_KEY,
|
|
79
|
-
this.setTagMaybe(OpenTelemetryConstants.USER_NAME_KEY,
|
|
80
|
-
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CALLER_CLIENT_IP_KEY,
|
|
72
|
+
if (userDetails) {
|
|
73
|
+
this.setTagMaybe(OpenTelemetryConstants.USER_ID_KEY, userDetails.userId);
|
|
74
|
+
this.setTagMaybe(OpenTelemetryConstants.USER_EMAIL_KEY, userDetails.userEmail);
|
|
75
|
+
this.setTagMaybe(OpenTelemetryConstants.USER_NAME_KEY, userDetails.userName);
|
|
76
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CALLER_CLIENT_IP_KEY, userDetails.callerClientIp);
|
|
81
77
|
}
|
|
82
78
|
}
|
|
83
79
|
/**
|
|
@@ -149,7 +145,7 @@ export class OpenTelemetryScope {
|
|
|
149
145
|
}
|
|
150
146
|
}
|
|
151
147
|
/**
|
|
152
|
-
* Sets a tag on the span if
|
|
148
|
+
* Sets a tag on the span if the value is not null or undefined.
|
|
153
149
|
* @param name The tag name
|
|
154
150
|
* @param value The tag value
|
|
155
151
|
*/
|
|
@@ -191,6 +187,20 @@ export class OpenTelemetryScope {
|
|
|
191
187
|
setEndTime(endTime) {
|
|
192
188
|
this.customEndTime = endTime;
|
|
193
189
|
}
|
|
190
|
+
/**
|
|
191
|
+
* Records a cancellation event on the span.
|
|
192
|
+
* Sets the span status to ERROR with the cancellation reason and marks the error type as 'TaskCanceledException'.
|
|
193
|
+
* @param reason Optional cancellation reason. Defaults to 'Task was cancelled'.
|
|
194
|
+
*/
|
|
195
|
+
recordCancellation(reason) {
|
|
196
|
+
const message = reason ?? 'Task was cancelled';
|
|
197
|
+
logger.info(`[A365Observability] Recording cancellation on span[${this.span.spanContext().spanId}]: ${message}`);
|
|
198
|
+
this.span.setStatus({
|
|
199
|
+
code: SpanStatusCode.ERROR,
|
|
200
|
+
message
|
|
201
|
+
});
|
|
202
|
+
this.errorType = OpenTelemetryConstants.ERROR_TYPE_CANCELLED;
|
|
203
|
+
}
|
|
194
204
|
/**
|
|
195
205
|
* Finalizes the scope and records metrics
|
|
196
206
|
*/
|
|
@@ -207,14 +217,11 @@ export class OpenTelemetryScope {
|
|
|
207
217
|
? OpenTelemetryScope.timeInputToMs(this.customEndTime)
|
|
208
218
|
: Date.now();
|
|
209
219
|
const durationMs = Math.max(0, endMs - startMs);
|
|
210
|
-
const duration = durationMs / 1000;
|
|
211
|
-
const finalTags = {};
|
|
212
220
|
if (this.errorType) {
|
|
213
|
-
finalTags[OpenTelemetryConstants.ERROR_TYPE_KEY] = this.errorType;
|
|
214
221
|
this.span.setAttributes({ [OpenTelemetryConstants.ERROR_TYPE_KEY]: this.errorType });
|
|
215
222
|
}
|
|
216
223
|
this.hasEnded = true;
|
|
217
|
-
logger.info(`[A365Observability] Ending span[${this.span.spanContext().spanId}], duration: ${
|
|
224
|
+
logger.info(`[A365Observability] Ending span[${this.span.spanContext().spanId}], duration: ${(durationMs / 1000).toFixed(3)}s`);
|
|
218
225
|
}
|
|
219
226
|
/**
|
|
220
227
|
* Disposes the scope and finalizes telemetry data collection
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OpenTelemetryScope.js","sourceRoot":"","sources":["../../../../src/tracing/scopes/OpenTelemetryScope.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"OpenTelemetryScope.js","sourceRoot":"","sources":["../../../../src/tracing/scopes/OpenTelemetryScope.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAQ,cAAc,EAAE,OAAO,EAA0C,MAAM,oBAAoB,CAAC;AAC5H,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAEtD,OAAO,EAAE,8BAA8B,EAAE,MAAM,gCAAgC,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AACvE,OAAO,MAAM,MAAM,qBAAqB,CAAC;AAEzC;;GAEG;AACH,MAAM,OAAgB,kBAAkB;IAWtC;;;;;;;;;OASG;IACH,YACE,aAAqB,EACrB,QAAgB,EAChB,YAA2B,EAC3B,WAAyB,EACzB,WAAyB;QAjBnB,aAAQ,GAAG,KAAK,CAAC;QAmBvB,MAAM,aAAa,GAAG,WAAW,EAAE,aAAa,CAAC;QACjD,MAAM,SAAS,GAAG,WAAW,EAAE,SAAS,CAAC;QACzC,MAAM,OAAO,GAAG,WAAW,EAAE,OAAO,CAAC;QACrC,MAAM,SAAS,GAAG,WAAW,EAAE,SAAS,CAAC;QACzC,MAAM,IAAI,GAAG,WAAW,EAAE,QAAQ,IAAI,QAAQ,CAAC,MAAM,CAAC;QAEtD,iDAAiD;QACjD,IAAI,cAAc,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QACtC,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,eAAe,CAAC,aAAa,CAAC,EAAE,CAAC;gBACnC,oDAAoD;gBACpD,cAAc,GAAG,8BAA8B,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;gBAC/E,MAAM,CAAC,IAAI,CAAC,2DAA2D,aAAa,CAAC,OAAO,YAAY,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC;YAClI,CAAC;iBAAM,CAAC;gBACN,4EAA4E;gBAC5E,cAAc,GAAG,aAAa,CAAC;YACjC,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,sCAAsC,QAAQ,gBAAgB,aAAa,kBAAkB,YAAY,EAAE,QAAQ,IAAI,SAAS,cAAc,YAAY,EAAE,OAAO,IAAI,SAAS,EAAE,CAAC,CAAC;QAEhM,yEAAyE;QACzE,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;YACxD,IAAI;YACJ,SAAS;YACT,KAAK,EAAE,SAAS;YAChB,UAAU,EAAE;gBACV,CAAC,sBAAsB,CAAC,yBAAyB,CAAC,EAAE,aAAa;aAClE;SACF,EAAE,cAAc,CAAC,CAAC;QAEnB,MAAM,CAAC,IAAI,CAAC,4BAA4B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,KAAK,QAAQ,gBAAgB,aAAa,uBAAuB,CAAC,CAAC;QAEzI,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACnC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;QAE7B,gCAAgC;QAChC,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;YACnF,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,qBAAqB,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;YACvF,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,4BAA4B,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC;YACrG,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,4BAA4B,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;YAC/F,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;YACnF,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,qBAAqB,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;YACvF,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,sBAAsB,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC;YACzF,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,6BAA6B,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAAC;QACxG,CAAC;QAED,mCAAmC;QACnC,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,aAAa,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;QAE/E,iCAAiC;QACjC,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;YACzE,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,cAAc,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;YAC/E,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,aAAa,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC7E,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,2BAA2B,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;QACnG,CAAC;IACH,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAI,QAA0B;QACtD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9D,OAAO,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,KAAY;QAC7B,MAAM,CAAC,KAAK,CAAC,gFAAgF,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAClJ,+CAA+C;QAC/C,IAAI,QAAQ,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC1D,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;YAClB,IAAI,EAAE,cAAc,CAAC,KAAK;YAC1B,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,UAAkG;QACxH,IAAI,CAAC,UAAU;YAAE,OAAO;QACxB,uDAAuD;QACvD,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,UAA6C,EAAE,CAAC;gBACzE,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;oBAAE,SAAS;gBAC7D,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;aAAM,IACL,OAAO,UAAU,KAAK,QAAQ;YAC9B,OAAQ,UAAiD,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,UAAU;YACzF,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;YAC1B,OAAO,UAAU,KAAK,QAAQ,EAC9B,CAAC;YACD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,UAAgD,EAAE,CAAC;gBAC5E,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;oBAAE,SAAS;gBAC7D,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;aAAM,IACL,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACjC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC1C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;oBAAE,SAAS;gBAC7D,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAG,UAA6C,CAAC,GAAG,CAAC,CAAC,CAAC;YACnF,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACO,WAAW,CAA4D,IAAY,EAAE,KAA2B;QACxH,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAwD,EAAE,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;IAED;;;;OAIG;IACO,UAAU,CAAC,GAAW,EAAE,KAAa;QAC7C,iEAAiE;QACjE,0DAA0D;QAC1D,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,CAAY;QACvC,IAAI,OAAO,CAAC,KAAK,QAAQ;YAAE,OAAO,CAAC,CAAC;QACpC,IAAI,CAAC,YAAY,IAAI;YAAE,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;QAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,OAAS,CAAC;QAC9E,MAAM,CAAC,IAAI,CAAC,yEAAyE,OAAO,CAAC,aAAa,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,+BAA+B,CAAC,CAAC;QAC3J,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,OAAkB;QAClC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,kBAAkB,CAAC,MAAe;QACvC,MAAM,OAAO,GAAG,MAAM,IAAI,oBAAoB,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,sDAAsD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,MAAM,OAAO,EAAE,CAAC,CAAC;QACjH,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;YAClB,IAAI,EAAE,cAAc,CAAC,KAAK;YAC1B,OAAO;SACR,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,sBAAsB,CAAC,oBAAoB,CAAC;IAC/D,CAAC;IAED;;OAEG;IACK,GAAG;QACT,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,CAAC,IAAI,CAAC,mDAAmD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;YAClG,OAAO;QACT,CAAC;QAED,6FAA6F;QAC7F,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,KAAK,SAAS;YAChD,CAAC,CAAC,kBAAkB,CAAC,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC;YACxD,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,KAAK,SAAS;YAC5C,CAAC,CAAC,kBAAkB,CAAC,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC;YACtD,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC;QAEhD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,sBAAsB,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,MAAM,CAAC,IAAI,CAAC,mCAAmC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,gBAAgB,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAClI,CAAC;IAED;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBACrC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;;AAxQuB,yBAAM,GAAG,KAAK,CAAC,SAAS,CAAC,sBAAsB,CAAC,WAAW,CAAC,AAAtD,CAAuD"}
|
|
@@ -1,7 +1,5 @@
|
|
|
1
|
-
import { TimeInput } from '@opentelemetry/api';
|
|
2
1
|
import { OpenTelemetryScope } from './OpenTelemetryScope';
|
|
3
|
-
import { AgentDetails,
|
|
4
|
-
import { ParentContext } from '../context/trace-context-propagation';
|
|
2
|
+
import { AgentDetails, UserDetails, OutputResponse, Request, SpanDetails } from '../contracts';
|
|
5
3
|
/**
|
|
6
4
|
* Provides OpenTelemetry tracing scope for output message tracing with parent span linking.
|
|
7
5
|
*/
|
|
@@ -10,19 +8,15 @@ export declare class OutputScope extends OpenTelemetryScope {
|
|
|
10
8
|
private _outputMessagesDirty;
|
|
11
9
|
/**
|
|
12
10
|
* Creates and starts a new scope for output message tracing.
|
|
11
|
+
*
|
|
12
|
+
* @param request Request payload (channel, conversationId, content, sessionId).
|
|
13
13
|
* @param response The response containing initial output messages.
|
|
14
|
-
* @param agentDetails The
|
|
15
|
-
* @param
|
|
16
|
-
* @param
|
|
17
|
-
* @param conversationId Optional conversation identifier.
|
|
18
|
-
* @param channel Optional channel metadata; only `name` and `description` are used for tagging.
|
|
19
|
-
* @param parentContext Optional parent context for cross-async-boundary tracing.
|
|
20
|
-
* Accepts a ParentSpanRef (manual traceId/spanId) or an OTel Context (e.g. from extractTraceContext).
|
|
21
|
-
* @param startTime Optional explicit start time (ms epoch, Date, or HrTime).
|
|
22
|
-
* @param endTime Optional explicit end time (ms epoch, Date, or HrTime).
|
|
14
|
+
* @param agentDetails The agent producing the output. Tenant ID is derived from `agentDetails.tenantId`.
|
|
15
|
+
* @param userDetails Optional human caller identity details.
|
|
16
|
+
* @param spanDetails Optional span configuration (parentContext, startTime, endTime, spanLinks).
|
|
23
17
|
* @returns A new OutputScope instance.
|
|
24
18
|
*/
|
|
25
|
-
static start(response: OutputResponse, agentDetails: AgentDetails,
|
|
19
|
+
static start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScope;
|
|
26
20
|
private constructor();
|
|
27
21
|
/**
|
|
28
22
|
* Records the output messages for telemetry tracking.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OutputScope.d.ts","sourceRoot":"","sources":["../../../../src/tracing/scopes/OutputScope.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"OutputScope.d.ts","sourceRoot":"","sources":["../../../../src/tracing/scopes/OutputScope.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG/F;;GAEG;AACH,qBAAa,WAAY,SAAQ,kBAAkB;IACjD,OAAO,CAAC,eAAe,CAAW;IAClC,OAAO,CAAC,oBAAoB,CAAS;IAErC;;;;;;;;;OASG;WACW,KAAK,CACjB,OAAO,EAAE,OAAO,EAChB,QAAQ,EAAE,cAAc,EACxB,YAAY,EAAE,YAAY,EAC1B,WAAW,CAAC,EAAE,WAAW,EACzB,WAAW,CAAC,EAAE,WAAW,GACxB,WAAW;IAId,OAAO;IAyCP;;;;;OAKG;IACI,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAKrC,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;IAUxB,OAAO,IAAI,IAAI;CAGhC"}
|
|
@@ -9,34 +9,36 @@ import { OpenTelemetryConstants } from '../constants';
|
|
|
9
9
|
export class OutputScope extends OpenTelemetryScope {
|
|
10
10
|
/**
|
|
11
11
|
* Creates and starts a new scope for output message tracing.
|
|
12
|
+
*
|
|
13
|
+
* @param request Request payload (channel, conversationId, content, sessionId).
|
|
12
14
|
* @param response The response containing initial output messages.
|
|
13
|
-
* @param agentDetails The
|
|
14
|
-
* @param
|
|
15
|
-
* @param
|
|
16
|
-
* @param conversationId Optional conversation identifier.
|
|
17
|
-
* @param channel Optional channel metadata; only `name` and `description` are used for tagging.
|
|
18
|
-
* @param parentContext Optional parent context for cross-async-boundary tracing.
|
|
19
|
-
* Accepts a ParentSpanRef (manual traceId/spanId) or an OTel Context (e.g. from extractTraceContext).
|
|
20
|
-
* @param startTime Optional explicit start time (ms epoch, Date, or HrTime).
|
|
21
|
-
* @param endTime Optional explicit end time (ms epoch, Date, or HrTime).
|
|
15
|
+
* @param agentDetails The agent producing the output. Tenant ID is derived from `agentDetails.tenantId`.
|
|
16
|
+
* @param userDetails Optional human caller identity details.
|
|
17
|
+
* @param spanDetails Optional span configuration (parentContext, startTime, endTime, spanLinks).
|
|
22
18
|
* @returns A new OutputScope instance.
|
|
23
19
|
*/
|
|
24
|
-
static start(response, agentDetails,
|
|
25
|
-
return new OutputScope(response, agentDetails,
|
|
20
|
+
static start(request, response, agentDetails, userDetails, spanDetails) {
|
|
21
|
+
return new OutputScope(request, response, agentDetails, userDetails, spanDetails);
|
|
26
22
|
}
|
|
27
|
-
constructor(response, agentDetails,
|
|
28
|
-
|
|
23
|
+
constructor(request, response, agentDetails, userDetails, spanDetails) {
|
|
24
|
+
// Validate tenantId is present (required for telemetry)
|
|
25
|
+
if (!agentDetails.tenantId) {
|
|
26
|
+
throw new Error('OutputScope: tenantId is required on agentDetails');
|
|
27
|
+
}
|
|
28
|
+
// spanKind for OutputScope is always CLIENT
|
|
29
|
+
const resolvedSpanDetails = { ...spanDetails, spanKind: SpanKind.CLIENT };
|
|
30
|
+
super(OpenTelemetryConstants.OUTPUT_MESSAGES_OPERATION_NAME, agentDetails.agentName
|
|
29
31
|
? `${OpenTelemetryConstants.OUTPUT_MESSAGES_OPERATION_NAME} ${agentDetails.agentName}`
|
|
30
|
-
: `${OpenTelemetryConstants.OUTPUT_MESSAGES_OPERATION_NAME} ${agentDetails.agentId}`, agentDetails,
|
|
32
|
+
: `${OpenTelemetryConstants.OUTPUT_MESSAGES_OPERATION_NAME} ${agentDetails.agentId}`, agentDetails, resolvedSpanDetails, userDetails);
|
|
31
33
|
this._outputMessagesDirty = false;
|
|
32
34
|
// Initialize accumulated messages list from the response
|
|
33
35
|
this._outputMessages = [...response.messages];
|
|
34
36
|
// Set initial output messages attribute
|
|
35
37
|
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_OUTPUT_MESSAGES_KEY, JSON.stringify(this._outputMessages));
|
|
36
38
|
// Set conversation and channel
|
|
37
|
-
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CONVERSATION_ID_KEY, conversationId);
|
|
38
|
-
this.setTagMaybe(OpenTelemetryConstants.CHANNEL_NAME_KEY, channel?.name);
|
|
39
|
-
this.setTagMaybe(OpenTelemetryConstants.CHANNEL_LINK_KEY, channel?.description);
|
|
39
|
+
this.setTagMaybe(OpenTelemetryConstants.GEN_AI_CONVERSATION_ID_KEY, request.conversationId);
|
|
40
|
+
this.setTagMaybe(OpenTelemetryConstants.CHANNEL_NAME_KEY, request.channel?.name);
|
|
41
|
+
this.setTagMaybe(OpenTelemetryConstants.CHANNEL_LINK_KEY, request.channel?.description);
|
|
40
42
|
}
|
|
41
43
|
/**
|
|
42
44
|
* Records the output messages for telemetry tracking.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OutputScope.js","sourceRoot":"","sources":["../../../../src/tracing/scopes/OutputScope.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,QAAQ,
|
|
1
|
+
{"version":3,"file":"OutputScope.js","sourceRoot":"","sources":["../../../../src/tracing/scopes/OutputScope.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAEtD;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,kBAAkB;IAIjD;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CACjB,OAAgB,EAChB,QAAwB,EACxB,YAA0B,EAC1B,WAAyB,EACzB,WAAyB;QAEzB,OAAO,IAAI,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;IACpF,CAAC;IAED,YACE,OAAgB,EAChB,QAAwB,EACxB,YAA0B,EAC1B,WAAyB,EACzB,WAAyB;QAEzB,wDAAwD;QACxD,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QAED,4CAA4C;QAC5C,MAAM,mBAAmB,GAAgB,EAAE,GAAG,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;QAEvF,KAAK,CACH,sBAAsB,CAAC,8BAA8B,EACrD,YAAY,CAAC,SAAS;YACpB,CAAC,CAAC,GAAG,sBAAsB,CAAC,8BAA8B,IAAI,YAAY,CAAC,SAAS,EAAE;YACtF,CAAC,CAAC,GAAG,sBAAsB,CAAC,8BAA8B,IAAI,YAAY,CAAC,OAAO,EAAE,EACtF,YAAY,EACZ,mBAAmB,EACnB,WAAW,CACZ,CAAC;QA7CI,yBAAoB,GAAG,KAAK,CAAC;QA+CnC,yDAAyD;QACzD,IAAI,CAAC,eAAe,GAAG,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE9C,wCAAwC;QACxC,IAAI,CAAC,WAAW,CACd,sBAAsB,CAAC,0BAA0B,EACjD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CACrC,CAAC;QAEF,+BAA+B;QAC/B,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,0BAA0B,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;QAC5F,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACjF,IAAI,CAAC,WAAW,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAE1F,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CAAC,QAAkB;QAC5C,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;IACnC,CAAC;IAEe,CAAC,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9B,IAAI,CAAC,WAAW,CACd,sBAAsB,CAAC,0BAA0B,EACjD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CACrC,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAC1B,CAAC;IAEe,OAAO;QACrB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;CACF"}
|
package/dist/esm/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const LIB_VERSION = "0.1.0-preview.
|
|
1
|
+
export declare const LIB_VERSION = "0.1.0-preview.125";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/dist/esm/version.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const LIB_VERSION = "0.1.0-preview.
|
|
1
|
+
export const LIB_VERSION = "0.1.0-preview.125";
|
|
2
2
|
//# sourceMappingURL=version.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@microsoft/agents-a365-observability",
|
|
3
|
-
"version": "0.1.0-preview.
|
|
3
|
+
"version": "0.1.0-preview.125",
|
|
4
4
|
"description": "OpenTelemetry tracing and monitoring SDK for AI agents built with TypeScript/Node.js",
|
|
5
5
|
"main": "dist/cjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"directory": "packages/agents-a365-observability"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@microsoft/agents-a365-runtime": "0.1.0-preview.
|
|
26
|
+
"@microsoft/agents-a365-runtime": "0.1.0-preview.125",
|
|
27
27
|
"@opentelemetry/api": "^1.9.0",
|
|
28
28
|
"@opentelemetry/exporter-trace-otlp-http": "^0.213.0",
|
|
29
29
|
"@opentelemetry/instrumentation": "^0.213.0",
|