Skip to content

feat: PostgreSQL Tracing Support #3064

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.

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

Merged
merged 4 commits into from
Dec 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions packages/tracing/src/integrations/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export { Express } from './express';
export { Postgres } from './postgres';
export { Mysql } from './mysql';
export { Mongo } from './mongo';
73 changes: 73 additions & 0 deletions packages/tracing/src/integrations/postgres.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
import { Hub } from '@sentry/hub';
import { EventProcessor, Integration } from '@sentry/types';
import { dynamicRequire, fill, logger } from '@sentry/utils';

interface PgClient {
prototype: {
query: () => void | Promise<unknown>;
};
}

/** Tracing integration for node-postgres package */
export class Postgres implements Integration {
/**
* @inheritDoc
*/
public static id: string = 'Postgres';

/**
* @inheritDoc
*/
public name: string = Postgres.id;

/**
* @inheritDoc
*/
public setupOnce(_: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
let client: PgClient;

try {
const pgModule = dynamicRequire(module, 'pg') as { Client: PgClient };
client = pgModule.Client;
} catch (e) {
logger.error('Postgres Integration was unable to require `pg` package.');
return;
}

/**
* function (query, callback) => void
* function (query, params, callback) => void
* function (query) => Promise
* function (query, params) => Promise
*/
fill(client.prototype, 'query', function(orig: () => void | Promise<unknown>) {
return function(this: unknown, config: unknown, values: unknown, callback: unknown) {
const scope = getCurrentHub().getScope();
const parentSpan = scope?.getSpan();
const span = parentSpan?.startChild({
description: typeof config === 'string' ? config : (config as { text: string }).text,
op: `db`,
});

if (typeof callback === 'function') {
return orig.call(this, config, values, function(err: Error, result: unknown) {
span?.finish();
callback(err, result);
});
}

if (typeof values === 'function') {
return orig.call(this, config, function(err: Error, result: unknown) {
span?.finish();
values(err, result);
});
}

return (orig.call(this, config, values) as Promise<unknown>).then((res: unknown) => {
span?.finish();
return res;
});
};
});
}
}