Skip to content

Commit f4ef008

Browse files
ericallamericallam
authored
feat: Python otel support, enriching spans, OpenAI Agents SDK example (#1839)
* D3 demo WIP * Agent working and completing token successfully * Sending OpenAI Agent SDK spans through to the platform now works * A couple of perf tweaks for enriching events
1 parent 2a6d825 commit f4ef008

39 files changed

+1495
-171
lines changed

‎apps/webapp/app/v3/otlpExporter.server.ts‎

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import {
2727
import { logger } from "~/services/logger.server";
2828
import { trace, Tracer } from "@opentelemetry/api";
2929
import { startSpan } from "./tracing.server";
30+
import { enrichCreatableEvents } from "./utils/enrichCreatableEvents.server";
3031

3132
export type OTLPExporterConfig = {
3233
batchSize: number;
@@ -54,14 +55,16 @@ class OTLPExporter {
5455
return convertSpansToCreateableEvents(resourceSpan);
5556
});
5657

57-
this.#logEventsVerbose(events);
58+
const enrichedEvents = enrichCreatableEvents(events);
5859

59-
span.setAttribute("event_count", events.length);
60+
this.#logEventsVerbose(enrichedEvents);
61+
62+
span.setAttribute("event_count", enrichedEvents.length);
6063

6164
if (immediate) {
62-
await this._eventRepository.insertManyImmediate(events);
65+
await this._eventRepository.insertManyImmediate(enrichedEvents);
6366
} else {
64-
await this._eventRepository.insertMany(events);
67+
await this._eventRepository.insertMany(enrichedEvents);
6568
}
6669

6770
return ExportTraceServiceResponse.create();
@@ -79,14 +82,16 @@ class OTLPExporter {
7982
return convertLogsToCreateableEvents(resourceLog);
8083
});
8184

82-
this.#logEventsVerbose(events);
85+
const enrichedEvents = enrichCreatableEvents(events);
86+
87+
this.#logEventsVerbose(enrichedEvents);
8388

84-
span.setAttribute("event_count", events.length);
89+
span.setAttribute("event_count", enrichedEvents.length);
8590

8691
if (immediate) {
87-
await this._eventRepository.insertManyImmediate(events);
92+
await this._eventRepository.insertManyImmediate(enrichedEvents);
8893
} else {
89-
await this._eventRepository.insertMany(events);
94+
await this._eventRepository.insertMany(enrichedEvents);
9095
}
9196

9297
return ExportLogsServiceResponse.create();
@@ -135,16 +140,28 @@ class OTLPExporter {
135140
(attribute) => attribute.key === SemanticInternalAttributes.TRIGGER
136141
);
137142

138-
if (!triggerAttribute) {
143+
const executionEnvironmentAttribute = resourceSpan.resource?.attributes.find(
144+
(attribute) => attribute.key === SemanticInternalAttributes.EXECUTION_ENVIRONMENT
145+
);
146+
147+
if (!triggerAttribute && !executionEnvironmentAttribute) {
139148
logger.debug("Skipping resource span without trigger attribute", {
140149
attributes: resourceSpan.resource?.attributes,
141150
spans: resourceSpan.scopeSpans.flatMap((scopeSpan) => scopeSpan.spans),
142151
});
143152

144-
return;
153+
return true; // go ahead and let this resource span through
154+
}
155+
156+
const executionEnvironment = isStringValue(executionEnvironmentAttribute?.value)
157+
? executionEnvironmentAttribute.value.stringValue
158+
: undefined;
159+
160+
if (executionEnvironment === "trigger") {
161+
return true; // go ahead and let this resource span through
145162
}
146163

147-
return isBoolValue(triggerAttribute.value) ? triggerAttribute.value.boolValue : false;
164+
return isBoolValue(triggerAttribute?.value) ? triggerAttribute.value.boolValue : false;
148165
});
149166
}
150167

‎apps/webapp/app/v3/utils/enrichCreatableEvents.server.ts‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
import type { CreatableEvent } from "../eventRepository.server";
2+
3+
export function enrichCreatableEvents(events: CreatableEvent[]) {
4+
return events.map((event) => {
5+
return enrichCreatableEvent(event);
6+
});
7+
}
8+
9+
function enrichCreatableEvent(event: CreatableEvent): CreatableEvent {
10+
const message = formatPythonStyle(event.message, event.properties);
11+
12+
event.message = message;
13+
event.style = enrichStyle(event);
14+
15+
return event;
16+
}
17+
18+
function enrichStyle(event: CreatableEvent) {
19+
const baseStyle = event.style ?? {};
20+
const props = event.properties;
21+
22+
// Direct property access and early returns
23+
// GenAI System check
24+
const system = props["gen_ai.system"];
25+
if (typeof system === "string") {
26+
return { ...baseStyle, icon: `tabler-brand-${system}` };
27+
}
28+
29+
// Agent workflow check
30+
const name = props["name"];
31+
if (typeof name === "string" && name.includes("Agent workflow")) {
32+
return { ...baseStyle, icon: "tabler-brain" };
33+
}
34+
35+
return baseStyle;
36+
}
37+
38+
function repr(value: any): string {
39+
if (typeof value === "string") {
40+
return `'${value}'`;
41+
}
42+
return String(value);
43+
}
44+
45+
function formatPythonStyle(template: string, values: Record<string, any>): string {
46+
// Early return if template is too long
47+
if (template.length >= 256) {
48+
return template;
49+
}
50+
51+
// Early return if no template variables present
52+
if (!template.includes("{")) {
53+
return template;
54+
}
55+
56+
return template.replace(/\{([^}]+?)(?:!r)?\}/g, (match, key) => {
57+
const hasRepr = match.endsWith("!r}");
58+
const actualKey = hasRepr ? key : key;
59+
const value = values[actualKey];
60+
61+
if (value === undefined) {
62+
return match;
63+
}
64+
65+
return hasRepr ? repr(value) : String(value);
66+
});
67+
}

‎apps/webapp/test/otlpExporter.test.ts‎

Lines changed: 397 additions & 0 deletions
Large diffs are not rendered by default.

‎packages/core/src/v3/otel/utils.ts‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { type Span, SpanStatusCode } from "@opentelemetry/api";
1+
import { type Span, SpanStatusCode, context, propagation } from "@opentelemetry/api";
22

33
export function recordSpanException(span: Span, error: unknown) {
44
if (error instanceof Error) {
@@ -20,3 +20,10 @@ function sanitizeSpanError(error: Error) {
2020

2121
return sanitizedError;
2222
}
23+
24+
export function carrierFromContext(): Record<string, string> {
25+
const carrier = {};
26+
propagation.inject(context.active(), carrier);
27+
28+
return carrier;
29+
}

‎packages/core/src/v3/semanticInternalAttributes.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,5 @@ export const SemanticInternalAttributes = {
5757
RATE_LIMIT_RESET: "response.rateLimit.reset",
5858
SPAN_ATTEMPT: "$span.attempt",
5959
METRIC_EVENTS: "$metrics.events",
60+
EXECUTION_ENVIRONMENT: "exec_env",
6061
};

‎packages/core/src/v3/workers/index.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ export { PreciseWallClock as DurableClock } from "../clock/preciseWallClock.js";
44
export { getEnvVar, getNumberEnvVar } from "../utils/getEnv.js";
55
export { OtelTaskLogger, logLevels } from "../logger/taskLogger.js";
66
export { ConsoleInterceptor } from "../consoleInterceptor.js";
7-
export { TracingSDK, type TracingDiagnosticLogLevel, recordSpanException } from "../otel/index.js";
7+
export {
8+
TracingSDK,
9+
type TracingDiagnosticLogLevel,
10+
recordSpanException,
11+
carrierFromContext,
12+
} from "../otel/index.js";
813
export { StandardResourceCatalog } from "../resource-catalog/standardResourceCatalog.js";
914
export {
1015
TaskContextSpanProcessor,

‎packages/python/src/index.ts‎

Lines changed: 58 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ import {
22
AsyncIterableStream,
33
createAsyncIterableStreamFromAsyncIterable,
44
SemanticInternalAttributes,
5+
taskContext,
56
} from "@trigger.dev/core/v3";
67
import { logger } from "@trigger.dev/sdk/v3";
8+
import { carrierFromContext } from "@trigger.dev/core/v3/otel";
79
import assert from "node:assert";
810
import fs from "node:fs";
911
import { Result, x, Options as XOptions } from "tinyexec";
@@ -17,6 +19,8 @@ export const python = {
1719
async run(scriptArgs: string[] = [], options: PythonExecOptions = {}): Promise<Result> {
1820
const pythonBin = process.env.PYTHON_BIN_PATH || "python";
1921

22+
const carrier = carrierFromContext();
23+
2024
return await logger.trace(
2125
"python.run()",
2226
async (span) => {
@@ -27,6 +31,12 @@ export const python = {
2731
env: {
2832
...process.env,
2933
...options.env,
34+
TRACEPARENT: carrier["traceparent"],
35+
OTEL_RESOURCE_ATTRIBUTES: `${
36+
SemanticInternalAttributes.EXECUTION_ENVIRONMENT
37+
}=trigger,${Object.entries(taskContext.attributes)
38+
.map(([key, value]) => `${key}=${value}`)
39+
.join(",")}`,
3040
},
3141
},
3242
throwOnError: false, // Ensure errors are handled manually
@@ -50,7 +60,7 @@ export const python = {
5060
attributes: {
5161
pythonBin,
5262
args: scriptArgs.join(" "),
53-
[SemanticInternalAttributes.STYLE_ICON]: "brand-python",
63+
[SemanticInternalAttributes.STYLE_ICON]: "python",
5464
},
5565
}
5666
);
@@ -69,6 +79,8 @@ export const python = {
6979
async (span) => {
7080
span.setAttribute("scriptPath", scriptPath);
7181

82+
const carrier = carrierFromContext();
83+
7284
const result = await x(
7385
process.env.PYTHON_BIN_PATH || "python",
7486
[scriptPath, ...scriptArgs],
@@ -79,6 +91,13 @@ export const python = {
7991
env: {
8092
...process.env,
8193
...options.env,
94+
TRACEPARENT: carrier["traceparent"],
95+
OTEL_RESOURCE_ATTRIBUTES: `${
96+
SemanticInternalAttributes.EXECUTION_ENVIRONMENT
97+
}=trigger,${Object.entries(taskContext.attributes)
98+
.map(([key, value]) => `${key}=${value}`)
99+
.join(",")}`,
100+
OTEL_LOG_LEVEL: "DEBUG",
82101
},
83102
},
84103
throwOnError: false,
@@ -93,7 +112,7 @@ export const python = {
93112
throw new Error(
94113
`${scriptPath} ${scriptArgs.join(" ")} exited with a non-zero code ${
95114
result.exitCode
96-
}:\n${result.stderr}`
115+
}:\n${result.stdout}\n${result.stderr}`
97116
);
98117
}
99118

@@ -104,7 +123,7 @@ export const python = {
104123
pythonBin: process.env.PYTHON_BIN_PATH || "python",
105124
scriptPath,
106125
args: scriptArgs.join(" "),
107-
[SemanticInternalAttributes.STYLE_ICON]: "brand-python",
126+
[SemanticInternalAttributes.STYLE_ICON]: "python",
108127
},
109128
}
110129
);
@@ -124,6 +143,8 @@ export const python = {
124143
async (tempFilePath) => {
125144
span.setAttribute("tempFilePath", tempFilePath);
126145

146+
const carrier = carrierFromContext();
147+
127148
const pythonBin = process.env.PYTHON_BIN_PATH || "python";
128149
const result = await x(pythonBin, [tempFilePath], {
129150
...options,
@@ -132,6 +153,12 @@ export const python = {
132153
env: {
133154
...process.env,
134155
...options.env,
156+
TRACEPARENT: carrier["traceparent"],
157+
OTEL_RESOURCE_ATTRIBUTES: `${
158+
SemanticInternalAttributes.EXECUTION_ENVIRONMENT
159+
}=trigger,${Object.entries(taskContext.attributes)
160+
.map(([key, value]) => `${key}=${value}`)
161+
.join(",")}`,
135162
},
136163
},
137164
throwOnError: false,
@@ -157,7 +184,7 @@ export const python = {
157184
pythonBin: process.env.PYTHON_BIN_PATH || "python",
158185
contentPreview:
159186
scriptContent.substring(0, 100) + (scriptContent.length > 100 ? "..." : ""),
160-
[SemanticInternalAttributes.STYLE_ICON]: "brand-python",
187+
[SemanticInternalAttributes.STYLE_ICON]: "python",
161188
},
162189
}
163190
);
@@ -167,13 +194,21 @@ export const python = {
167194
run(scriptArgs: string[] = [], options: PythonExecOptions = {}): AsyncIterableStream<string> {
168195
const pythonBin = process.env.PYTHON_BIN_PATH || "python";
169196

197+
const carrier = carrierFromContext();
198+
170199
const pythonProcess = x(pythonBin, scriptArgs, {
171200
...options,
172201
nodeOptions: {
173202
...(options.nodeOptions || {}),
174203
env: {
175204
...process.env,
176205
...options.env,
206+
TRACEPARENT: carrier["traceparent"],
207+
OTEL_RESOURCE_ATTRIBUTES: `${
208+
SemanticInternalAttributes.EXECUTION_ENVIRONMENT
209+
}=trigger,${Object.entries(taskContext.attributes)
210+
.map(([key, value]) => `${key}=${value}`)
211+
.join(",")}`,
177212
},
178213
},
179214
throwOnError: false,
@@ -183,7 +218,7 @@ export const python = {
183218
attributes: {
184219
pythonBin,
185220
args: scriptArgs.join(" "),
186-
[SemanticInternalAttributes.STYLE_ICON]: "brand-python",
221+
[SemanticInternalAttributes.STYLE_ICON]: "python",
187222
},
188223
});
189224

@@ -206,13 +241,21 @@ export const python = {
206241

207242
const pythonBin = process.env.PYTHON_BIN_PATH || "python";
208243

244+
const carrier = carrierFromContext();
245+
209246
const pythonProcess = x(pythonBin, [scriptPath, ...scriptArgs], {
210247
...options,
211248
nodeOptions: {
212249
...(options.nodeOptions || {}),
213250
env: {
214251
...process.env,
215252
...options.env,
253+
TRACEPARENT: carrier["traceparent"],
254+
OTEL_RESOURCE_ATTRIBUTES: `${
255+
SemanticInternalAttributes.EXECUTION_ENVIRONMENT
256+
}=trigger,${Object.entries(taskContext.attributes)
257+
.map(([key, value]) => `${key}=${value}`)
258+
.join(",")}`,
216259
},
217260
},
218261
throwOnError: false,
@@ -223,7 +266,7 @@ export const python = {
223266
pythonBin,
224267
scriptPath,
225268
args: scriptArgs.join(" "),
226-
[SemanticInternalAttributes.STYLE_ICON]: "brand-python",
269+
[SemanticInternalAttributes.STYLE_ICON]: "python",
227270
},
228271
});
229272

@@ -243,13 +286,21 @@ export const python = {
243286

244287
const pythonScriptPath = createTempFileSync(`script_${Date.now()}.py`, scriptContent);
245288

289+
const carrier = carrierFromContext();
290+
246291
const pythonProcess = x(pythonBin, [pythonScriptPath], {
247292
...options,
248293
nodeOptions: {
249294
...(options.nodeOptions || {}),
250295
env: {
251296
...process.env,
252297
...options.env,
298+
TRACEPARENT: carrier["traceparent"],
299+
OTEL_RESOURCE_ATTRIBUTES: `${
300+
SemanticInternalAttributes.EXECUTION_ENVIRONMENT
301+
}=trigger,${Object.entries(taskContext.attributes)
302+
.map(([key, value]) => `${key}=${value}`)
303+
.join(",")}`,
253304
},
254305
},
255306
throwOnError: false,
@@ -260,7 +311,7 @@ export const python = {
260311
pythonBin,
261312
contentPreview:
262313
scriptContent.substring(0, 100) + (scriptContent.length > 100 ? "..." : ""),
263-
[SemanticInternalAttributes.STYLE_ICON]: "brand-python",
314+
[SemanticInternalAttributes.STYLE_ICON]: "python",
264315
},
265316
});
266317

0 commit comments

Comments
 (0)