Skip to content
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

fix(instrumentation-pg): ensure db.client.operation.duration metric is recorded for Promises API usage of pg #2480

Merged
merged 8 commits into from
Oct 23, 2024
Merged

fix(instrumentation-pg): ensure db.client.operation.duration metric is recorded for Promises API usage of pg #2480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5a7e89a
fix(instrumentation-pg): ensure db.client.operation.duration metric i…
trentm Oct 11, 2024
29bc7de
Merge branch 'main' into tm-pg-duration-metric-with-promises
trentm Oct 15, 2024
2120edf
use semconv constants
trentm Oct 15, 2024
21bebd3
fix lint
trentm Oct 15, 2024
fd844d6
another semconv const
trentm Oct 15, 2024
f8fb951
Merge branch 'main' into tm-pg-duration-metric-with-promises
trentm Oct 21, 2024
a6bba4d
Merge branch 'main' into tm-pg-duration-metric-with-promises
trentm Oct 22, 2024
67ac071
Merge branch 'main' into tm-pg-duration-metric-with-promises
trentm Oct 23, 2024
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
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-pg/src/instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,7 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
// Return a pass-along promise which ends the span and then goes to user's orig resolvers
return new Promise(resolve => {
utils.handleExecutionResult(plugin.getConfig(), span, result);
recordDuration();
span.end();
resolve(result);
});
Expand All @@ -424,6 +425,7 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
code: SpanStatusCode.ERROR,
message: error.message,
});
recordDuration();
span.end();
reject(error);
});
Expand Down
42 changes: 41 additions & 1 deletion plugins/node/opentelemetry-instrumentation-pg/test/pg-pool.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,10 @@ import {
SEMATTRS_DB_STATEMENT,
} from '@opentelemetry/semantic-conventions';
import {
ATTR_DB_CLIENT_CONNECTION_STATE,
METRIC_DB_CLIENT_CONNECTION_COUNT,
METRIC_DB_CLIENT_CONNECTION_PENDING_REQUESTS,
ATTR_DB_CLIENT_CONNECTION_STATE,
METRIC_DB_CLIENT_OPERATION_DURATION,
} from '@opentelemetry/semantic-conventions/incubating';

const memoryExporter = new InMemorySpanExporter();
Expand Down Expand Up @@ -524,6 +525,11 @@ describe('pg-pool', () => {
);

const metrics = resourceMetrics.scopeMetrics[0].metrics;
assert.strictEqual(
metrics[0].descriptor.name,
METRIC_DB_CLIENT_OPERATION_DURATION
);

assert.strictEqual(
metrics[1].descriptor.name,
METRIC_DB_CLIENT_CONNECTION_COUNT
Expand Down Expand Up @@ -573,6 +579,40 @@ describe('pg-pool', () => {
});
});

it('should generate `db.client.*` metrics (Promises-style)', async (...args) => {
const client = await pool.connect();

try {
const ret = await client.query('SELECT NOW()');
assert.ok(ret);
} finally {
client.release();
}

const { resourceMetrics, errors } = await metricReader.collect();
assert.deepEqual(
errors,
[],
'expected no errors from the callback during metric collection'
);

// We just test the expected metric *names* here. The particulars of the
// metric values are already tested in other test cases.
const metrics = resourceMetrics.scopeMetrics[0].metrics;
assert.strictEqual(
metrics[0].descriptor.name,
METRIC_DB_CLIENT_OPERATION_DURATION
);
assert.strictEqual(
metrics[1].descriptor.name,
METRIC_DB_CLIENT_CONNECTION_COUNT
);
assert.strictEqual(
metrics[2].descriptor.name,
METRIC_DB_CLIENT_CONNECTION_PENDING_REQUESTS
);
});

it('should not add duplicate event listeners to PgPool events', done => {
const poolAux: pgPool<pg.Client> = new pgPool(CONFIG);
let completed = 0;
Expand Down