Skip to content

Commit 58f815b

Browse files
committed
fix lint and tests
1 parent 776a031 commit 58f815b

File tree

3 files changed

+66
-30
lines changed

3 files changed

+66
-30
lines changed

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

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,10 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
255255

256256
const span = plugin.tracer.startSpan(SpanNames.CONNECT, {
257257
kind: SpanKind.CLIENT,
258-
attributes: utils.getSemanticAttributesFromConnection(this, plugin._semconvStability),
258+
attributes: utils.getSemanticAttributesFromConnection(
259+
this,
260+
plugin._semconvStability
261+
),
259262
});
260263

261264
if (callback) {
@@ -280,7 +283,7 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
280283

281284
private recordOperationDuration(attributes: Attributes, startTime: HrTime) {
282285
const metricsAttributes: Attributes = {};
283-
let keysToCopy = [
286+
const keysToCopy = [
284287
ATTR_DB_NAMESPACE,
285288
ATTR_ERROR_TYPE,
286289
ATTR_SERVER_PORT,
@@ -562,7 +565,10 @@ export class PgInstrumentation extends InstrumentationBase<PgInstrumentationConf
562565
// setup span
563566
const span = plugin.tracer.startSpan(SpanNames.POOL_CONNECT, {
564567
kind: SpanKind.CLIENT,
565-
attributes: utils.getSemanticAttributesFromPool(this.options, plugin._semconvStability),
568+
attributes: utils.getSemanticAttributesFromPool(
569+
this.options,
570+
plugin._semconvStability
571+
),
566572
});
567573

568574
plugin._setPoolConnectEventListeners(this);

plugins/node/opentelemetry-instrumentation-pg/src/utils.ts

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,10 @@ import {
5858
} from './internal-types';
5959
import { PgInstrumentationConfig } from './types';
6060
import type * as pgTypes from 'pg';
61-
import { safeExecuteInTheMiddle, SemconvStability, semconvStabilityFromStr } from '@opentelemetry/instrumentation';
61+
import {
62+
safeExecuteInTheMiddle,
63+
SemconvStability,
64+
} from '@opentelemetry/instrumentation';
6265
import { SpanNames } from './enums/SpanNames';
6366

6467
/**
@@ -152,7 +155,7 @@ function getPort(port: number | undefined): number | undefined {
152155

153156
export function getSemanticAttributesFromConnection(
154157
params: PgParsedConnectionParams,
155-
semconvStability: SemconvStability,
158+
semconvStability: SemconvStability
156159
) {
157160
let attributes: Attributes = {};
158161

@@ -165,7 +168,7 @@ export function getSemanticAttributesFromConnection(
165168
[SEMATTRS_DB_USER]: params.user,
166169
[SEMATTRS_NET_PEER_NAME]: params.host, // required
167170
[SEMATTRS_NET_PEER_PORT]: getPort(params.port),
168-
}
171+
};
169172
}
170173
if (semconvStability & SemconvStability.STABLE) {
171174
attributes = {
@@ -174,15 +177,15 @@ export function getSemanticAttributesFromConnection(
174177
[ATTR_DB_NAMESPACE]: params.namespace,
175178
[ATTR_NETWORK_PEER_ADDRESS]: params.host,
176179
[ATTR_NETWORK_PEER_PORT]: getPort(params.port),
177-
}
180+
};
178181
}
179182

180183
return attributes;
181184
}
182185

183186
export function getSemanticAttributesFromPool(
184187
params: PgPoolOptionsParams,
185-
semconvStability: SemconvStability,
188+
semconvStability: SemconvStability
186189
) {
187190
let url: URL | undefined;
188191
try {
@@ -206,7 +209,7 @@ export function getSemanticAttributesFromPool(
206209
[SEMATTRS_NET_PEER_NAME]: url?.hostname ?? params.host,
207210
[SEMATTRS_NET_PEER_PORT]: Number(url?.port) || getPort(params.port),
208211
[SEMATTRS_DB_USER]: url?.username ?? params.user,
209-
}
212+
};
210213
}
211214
if (semconvStability & SemconvStability.STABLE) {
212215
attributes = {
@@ -215,7 +218,7 @@ export function getSemanticAttributesFromPool(
215218
[ATTR_DB_NAMESPACE]: params.namespace,
216219
[ATTR_NETWORK_PEER_ADDRESS]: url?.hostname ?? params.host,
217220
[ATTR_NETWORK_PEER_PORT]: Number(url?.port) || getPort(params.port),
218-
}
221+
};
219222
}
220223

221224
return attributes;
@@ -246,7 +249,10 @@ export function handleConfigQuery(
246249
const spanName = getQuerySpanName(dbName, queryConfig);
247250
const span = tracer.startSpan(spanName, {
248251
kind: SpanKind.CLIENT,
249-
attributes: getSemanticAttributesFromConnection(connectionParameters, semconvStability),
252+
attributes: getSemanticAttributesFromConnection(
253+
connectionParameters,
254+
semconvStability
255+
),
250256
});
251257

252258
if (!queryConfig) {

plugins/node/opentelemetry-instrumentation-pg/test/utils.test.ts

Lines changed: 43 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616

1717
import { context, trace } from '@opentelemetry/api';
1818
import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
19-
import { InstrumentationConfig } from '@opentelemetry/instrumentation';
19+
import {
20+
InstrumentationConfig,
21+
SemconvStability,
22+
} from '@opentelemetry/instrumentation';
2023
import {
2124
BasicTracerProvider,
2225
InMemorySpanExporter,
@@ -163,6 +166,7 @@ describe('utils.ts', () => {
163166
client,
164167
tracer,
165168
instrumentationConfig,
169+
SemconvStability.STABLE,
166170
queryConfig
167171
);
168172
querySpan.end();
@@ -182,6 +186,7 @@ describe('utils.ts', () => {
182186
client,
183187
tracer,
184188
extPluginConfig,
189+
SemconvStability.STABLE,
185190
queryConfig
186191
);
187192
querySpan.end();
@@ -196,42 +201,60 @@ describe('utils.ts', () => {
196201
describe('.getSemanticAttributesFromConnection()', () => {
197202
it('should set port attribute to undefined when port is not an integer', () => {
198203
assert.strictEqual(
199-
utils.getSemanticAttributesFromConnection({
200-
port: Infinity,
201-
})[SEMATTRS_NET_PEER_PORT],
204+
utils.getSemanticAttributesFromConnection(
205+
{
206+
port: Infinity,
207+
},
208+
SemconvStability.STABLE
209+
)[SEMATTRS_NET_PEER_PORT],
202210
undefined
203211
);
204212
assert.strictEqual(
205-
utils.getSemanticAttributesFromConnection({
206-
port: -Infinity,
207-
})[SEMATTRS_NET_PEER_PORT],
213+
utils.getSemanticAttributesFromConnection(
214+
{
215+
port: -Infinity,
216+
},
217+
SemconvStability.STABLE
218+
)[SEMATTRS_NET_PEER_PORT],
208219
undefined
209220
);
210221
assert.strictEqual(
211-
utils.getSemanticAttributesFromConnection({
212-
port: NaN,
213-
})[SEMATTRS_NET_PEER_PORT],
222+
utils.getSemanticAttributesFromConnection(
223+
{
224+
port: NaN,
225+
},
226+
SemconvStability.STABLE
227+
)[SEMATTRS_NET_PEER_PORT],
214228
undefined
215229
);
216230
assert.strictEqual(
217-
utils.getSemanticAttributesFromConnection({
218-
port: 1.234,
219-
})[SEMATTRS_NET_PEER_PORT],
231+
utils.getSemanticAttributesFromConnection(
232+
{
233+
port: 1.234,
234+
},
235+
SemconvStability.STABLE
236+
)[SEMATTRS_NET_PEER_PORT],
220237
undefined
221238
);
222239
});
223240

224241
it('should set port attribute when port is an integer', () => {
225242
assert.strictEqual(
226-
utils.getSemanticAttributesFromConnection({
227-
port: 1234,
228-
})[SEMATTRS_NET_PEER_PORT],
243+
utils.getSemanticAttributesFromConnection(
244+
{
245+
port: 1234,
246+
},
247+
SemconvStability.STABLE
248+
)[SEMATTRS_NET_PEER_PORT],
229249
1234
230250
);
231251
assert.strictEqual(
232-
utils.getSemanticAttributesFromConnection({
233-
port: Number.MAX_VALUE,
234-
})[SEMATTRS_NET_PEER_PORT],
252+
utils.getSemanticAttributesFromConnection(
253+
{
254+
port: Number.MAX_VALUE,
255+
},
256+
SemconvStability.STABLE
257+
)[SEMATTRS_NET_PEER_PORT],
235258
Number.MAX_VALUE
236259
);
237260
});
@@ -244,6 +267,7 @@ describe('utils.ts', () => {
244267
port: 1234,
245268
user: 'username',
246269
database: 'database_name',
270+
namespace: 'database_namespace',
247271
idleTimeoutMillis: 10,
248272
maxClient: 5,
249273
max: 5,

0 commit comments

Comments
 (0)