Skip to content

feat(pg-instrumentation): record exceptions as span events #3182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+241 −36
Open

feat(pg-instrumentation): record exceptions as span events #3182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86205fd
fix(pg-instrumentation): record exceptions as span events
aryamohanan Oct 18, 2025
8a0c23b
test: added an additional status code assertion
aryamohanan Oct 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions packages/instrumentation-pg/src/instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,8 +339,8 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
values: Array.isArray(args[1]) ? args[1] : undefined,
}
: firstArgIsQueryObjectWithText
? (arg0 as utils.ObjectWithText)
: undefined;
? (arg0 as utils.ObjectWithText)
: undefined;

const attributes: Attributes = {
[ATTR_DB_SYSTEM]: DB_SYSTEM_VALUE_POSTGRESQL,
Expand Down Expand Up @@ -469,6 +469,9 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
try {
result = original.apply(this, args as never);
} catch (e: unknown) {
if (e instanceof Error) {
span.recordException(e);
}
span.setStatus({
code: SpanStatusCode.ERROR,
message: utils.getErrorMessage(e),
Expand All @@ -491,6 +494,9 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
})
.catch((error: Error) => {
return new Promise((_, reject) => {
if (error instanceof Error) {
span.recordException(error);
}
span.setStatus({
code: SpanStatusCode.ERROR,
message: error.message,
Expand Down Expand Up @@ -612,6 +618,9 @@ function handleConnectResult(span: Span, connectResult: unknown) {
return result;
})
.catch((error: unknown) => {
if (error instanceof Error) {
span.recordException(error);
}
span.setStatus({
code: SpanStatusCode.ERROR,
message: utils.getErrorMessage(error),
Expand Down
10 changes: 9 additions & 1 deletion packages/instrumentation-pg/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,9 @@ export function patchCallback(
if (Object.prototype.hasOwnProperty.call(err, 'code')) {
attributes[ATTR_ERROR_TYPE] = (err as any)['code'];
}

if (err instanceof Error) {
span.recordException(err);
}
span.setStatus({
code: SpanStatusCode.ERROR,
message: err.message,
Expand Down Expand Up @@ -412,6 +414,9 @@ export function patchCallbackPGPool(
done: any
) {
if (err) {
if (err instanceof Error) {
span.recordException(err);
}
span.setStatus({
code: SpanStatusCode.ERROR,
message: err.message,
Expand All @@ -428,6 +433,9 @@ export function patchClientConnectCallback(span: Span, cb: Function): Function {
err: Error
) {
if (err) {
if (err instanceof Error) {
span.recordException(err);
}
span.setStatus({
code: SpanStatusCode.ERROR,
message: err.message,
Expand Down
114 changes: 114 additions & 0 deletions packages/instrumentation-pg/test/pg-pool.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,6 +530,120 @@ describe('pg-pool', () => {
});
});

describe('exception event recording', () => {
const queryText = 'SELECT foo FROM nonexistent_table';

it('should record exceptions as events on spans for a query to a nonexistent table (callback)', done => {
const parentSpan = provider
.getTracer('test-pg-pool')
.startSpan('test span');
context.with(trace.setSpan(context.active(), parentSpan), () => {
pool.query(queryText, err => {
assert.notEqual(err, null, 'Expected query to throw an error');

const spans = memoryExporter.getFinishedSpans();

const querySpan = spans.find(
s =>
s.attributes?.[ATTR_DB_STATEMENT] &&
String(s.attributes[ATTR_DB_STATEMENT]).includes(
'nonexistent_table'
)
);
assert.ok(
querySpan,
'Expected a span for the nonexistent table query'
);

const exceptionEvents = querySpan.events.filter(
e => e.name === 'exception'
);
assert.ok(
exceptionEvents.length > 0,
'Expected at least one exception event'
);

exceptionEvents.forEach(e => {
const attrs = e.attributes!;
assert.strictEqual(
attrs['exception.type'],
'42P01',
'exception.type should match Postgres error code'
);
assert.ok(
attrs['exception.message'],
'exception.message should exist'
);
assert.ok(
attrs['exception.stacktrace'],
'exception.stacktrace should exist'
);
});

memoryExporter.reset();
done();
});
});
});

it('should record exceptions as events on spans for a query to a nonexistent table (async-await)', async () => {
const parentSpan = provider
.getTracer('test-pg-pool')
.startSpan('test span');

await context.with(
trace.setSpan(context.active(), parentSpan),
async () => {
try {
await pool.query(queryText);
assert.fail('Expected query to throw an error');
} catch {
const spans = memoryExporter.getFinishedSpans();

const querySpan = spans.find(
s =>
s.attributes?.[ATTR_DB_STATEMENT] &&
String(s.attributes[ATTR_DB_STATEMENT]).includes(
'nonexistent_table'
)
);
assert.ok(
querySpan,
'Expected a span for the nonexistent table query'
);

const exceptionEvents = querySpan.events.filter(
e => e.name === 'exception'
);
assert.ok(
exceptionEvents.length > 0,
'Expected at least one exception event'
);

exceptionEvents.forEach(e => {
const attrs = e.attributes!;
assert.strictEqual(
attrs['exception.type'],
'42P01',
'exception.type should match Postgres error code'
);
assert.ok(
attrs['exception.message'],
'exception.message should exist'
);
assert.ok(
attrs['exception.stacktrace'],
'exception.stacktrace should exist'
);
});

memoryExporter.reset();
}
}
);
});
});

describe('pg metrics', () => {
let metricReader: testUtils.TestMetricReader;

Expand Down
140 changes: 107 additions & 33 deletions packages/instrumentation-pg/test/pg.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,8 @@ describe('pg', () => {
});

beforeEach(() => {
memoryExporter.reset();

contextManager = new AsyncLocalStorageContextManager().enable();
context.setGlobalContextManager(contextManager);

Expand Down Expand Up @@ -192,47 +194,57 @@ describe('pg', () => {
return /node_modules[/\\]pg/.test(src);
};

assert.throws(
() => {
(client as any).query();
const errorThrowCases = [
{ fn: () => (client as any).query(), desc: 'no args provided' },
{ fn: () => (client as any).query(null), desc: 'null as only arg' },
{
fn: () => (client as any).query(undefined),
desc: 'undefined as only arg',
},
assertPgError,
'pg should throw when no args provided'
);
runCallbackTest(null, DEFAULT_ATTRIBUTES, [], errorStatus);
memoryExporter.reset();
];

assert.throws(
() => {
(client as any).query(null);
},
assertPgError,
'pg should throw when null provided as only arg'
);
runCallbackTest(null, DEFAULT_ATTRIBUTES, [], errorStatus);
memoryExporter.reset();
errorThrowCases.forEach(({ fn, desc }) => {
assert.throws(fn, assertPgError, `pg should throw when ${desc}`);
const spans = memoryExporter.getFinishedSpans();
assert.ok(spans.length > 0, 'No spans recorded');

assert.throws(
() => {
(client as any).query(undefined);
},
assertPgError,
'pg should throw when undefined provided as only arg'
);
runCallbackTest(null, DEFAULT_ATTRIBUTES, [], errorStatus);
memoryExporter.reset();
const exceptionEvents = spans[0].events.filter(
e => e.name === 'exception'
);

assert.strictEqual(spans[0].status.code, errorStatus.code);

assert.strictEqual(
exceptionEvents.length,
1,
'Expected one exception event'
);

const event = exceptionEvents[0];
assert.strictEqual(
event.attributes!['exception.message'],
'Client was passed a null or undefined query'
);
assert.strictEqual(event.attributes!['exception.type'], 'TypeError');
assert.ok(event.time.length === 2, 'Event time should be a HrTime array');

memoryExporter.reset();
});

assert.doesNotThrow(
() =>
(client as any).query({ foo: 'bar' }, undefined, () => {
runCallbackTest(
null,
{
...DEFAULT_ATTRIBUTES,
},
[],
errorStatus
const spans = memoryExporter.getFinishedSpans();
assert.strictEqual(spans.length, 1);
const exceptionEvents = spans[0].events.filter(
e => e.name === 'exception'
);
assert.strictEqual(
exceptionEvents.length,
1,
'Expected 1 exception event'
);
memoryExporter.reset();
}),
'pg should not throw when invalid config args are provided'
);
Expand Down Expand Up @@ -982,6 +994,68 @@ describe('pg', () => {
});
});

describe('exception event recording', () => {
const assertExceptionEvents = (pgSpan: any) => {
assert.strictEqual(
pgSpan.status.code,
SpanStatusCode.ERROR,
'Span should have ERROR status'
);

const exceptionEvents = pgSpan.events.filter(
(e: { name: string }) => e.name === 'exception'
);
assert.ok(
exceptionEvents.length > 0,
'Expected at least one exception event'
);

exceptionEvents.forEach((err: { attributes: any }) => {
const attrs = err.attributes!;
assert.ok(attrs['exception.message'], 'Expected exception.message');
assert.strictEqual(
attrs['exception.type'],
'42P01',
'exception.type should match Postgres error code'
);
assert.ok(
attrs['exception.stacktrace'],
'Expected exception.stacktrace'
);
});
};

it('should record exceptions as events on spans for a query to a nonexistent table (callback)', done => {
client.query('SELECT foo FROM nonexistent_table', err => {
assert.notEqual(err, null, 'Expected query to throw an error');

const spans = memoryExporter.getFinishedSpans();
assert.strictEqual(spans.length, 1, 'Expected one finished span');
const pgSpan = spans[0];

assertExceptionEvents(pgSpan);

memoryExporter.reset();
done();
});
});

it('should record exceptions as events on spans for a query to a nonexistent table (promise)', async () => {
try {
await client.query('SELECT foo FROM nonexistent_table');
assert.fail('Expected query to throw an error');
} catch {
const spans = memoryExporter.getFinishedSpans();
assert.strictEqual(spans.length, 1, 'Expected one finished span');
const pgSpan = spans[0];

assertExceptionEvents(pgSpan);

memoryExporter.reset();
}
});
});

describe('pg metrics', () => {
let metricReader: testUtils.TestMetricReader;

Expand Down