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.

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
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,7 @@
// 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 @@ -423,6 +424,7 @@
code: SpanStatusCode.ERROR,
message: error.message,
});
recordDuration();

Check warning on line 427 in plugins/node/opentelemetry-instrumentation-pg/src/instrumentation.ts

View check run for this annotation

Codecov / codecov/patch

plugins/node/opentelemetry-instrumentation-pg/src/instrumentation.ts#L427

Added line #L427 was not covered by tests
span.end();
reject(error);
});
Expand Down
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,
'db.client.operation.duration'
trentm marked this conversation as resolved.
Show resolved Hide resolved
);

assert.strictEqual(
metrics[1].descriptor.name,
METRIC_DB_CLIENT_CONNECTION_COUNT
Expand Down Expand Up @@ -572,5 +578,39 @@ 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,
);
});
});
});
Loading