Skip to content

Commit

Permalink
Merge branch 'main' into dluna/restify-semconv-strings
Browse files Browse the repository at this point in the history
  • Loading branch information
@pichlermarc
pichlermarc authored Apr 17, 2024
2 parents f438ab1 + 34796e2 commit 51be0fa
Show file tree
Hide file tree
Showing 13 changed files with 128 additions and 87 deletions.
12 changes: 6 additions & 6 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions plugins/node/opentelemetry-instrumentation-redis-4/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,20 @@ const redisInstrumentation = new RedisInstrumentation({
});
```

## Semantic Conventions

This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)

Attributes collected:

| Attribute | Short Description |
| ---------------------- | ---------------------------------------------------------------------------- |
| `db.connection_string` | The connection string used to connect to the database (without credentials). |
| `db.statement` | The database statement being executed. |
| `db.system` | An identifier for the database management system (DBMS) product being used. |
| `net.peer.name` | Remote hostname or similar, see note below. |
| `net.peer.port` | Remote port number. |

## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
Expand Down
2 changes: 1 addition & 1 deletion plugins/node/opentelemetry-instrumentation-redis-4/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
"dependencies": {
"@opentelemetry/instrumentation": "^0.50.0",
"@opentelemetry/redis-common": "^0.36.1",
"@opentelemetry/semantic-conventions": "^1.0.0"
"@opentelemetry/semantic-conventions": "^1.22.0"
},
"homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-redis-4#readme"
}
4 changes: 2 additions & 2 deletions plugins/node/opentelemetry-instrumentation-redis-4/src/instrumentation.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import { getClientAttributes } from './utils';
import { defaultDbStatementSerializer } from '@opentelemetry/redis-common';
import { RedisInstrumentationConfig } from './types';
import { VERSION } from './version';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { SEMATTRS_DB_STATEMENT } from '@opentelemetry/semantic-conventions';
import type { MultiErrorReply } from './internal-types';

const OTEL_OPEN_SPANS = Symbol(
Expand Down Expand Up @@ -405,7 +405,7 @@ export class RedisInstrumentation extends InstrumentationBase<any> {
try {
const dbStatement = dbStatementSerializer(commandName, commandArgs);
if (dbStatement != null) {
attributes[SemanticAttributes.DB_STATEMENT] = dbStatement;
attributes[SEMATTRS_DB_STATEMENT] = dbStatement;
}
} catch (e) {
this._diag.error('dbStatementSerializer throw an exception', e, {
Expand Down
15 changes: 9 additions & 6 deletions plugins/node/opentelemetry-instrumentation-redis-4/src/utils.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,22 @@
*/
import { Attributes, DiagLogger } from '@opentelemetry/api';
import {
DbSystemValues,
SemanticAttributes,
SEMATTRS_DB_SYSTEM,
SEMATTRS_DB_CONNECTION_STRING,
SEMATTRS_NET_PEER_NAME,
SEMATTRS_NET_PEER_PORT,
DBSYSTEMVALUES_REDIS,
} from '@opentelemetry/semantic-conventions';

export function getClientAttributes(
diag: DiagLogger,
options: any
): Attributes {
return {
[SemanticAttributes.DB_SYSTEM]: DbSystemValues.REDIS,
[SemanticAttributes.NET_PEER_NAME]: options?.socket?.host,
[SemanticAttributes.NET_PEER_PORT]: options?.socket?.port,
[SemanticAttributes.DB_CONNECTION_STRING]:
[SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_REDIS,
[SEMATTRS_NET_PEER_NAME]: options?.socket?.host,
[SEMATTRS_NET_PEER_PORT]: options?.socket?.port,
[SEMATTRS_DB_CONNECTION_STRING]:
removeCredentialsFromDBConnectionStringAttribute(diag, options?.url),
};
}
Expand Down
95 changes: 45 additions & 50 deletions plugins/node/opentelemetry-instrumentation-redis-4/test/redis.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,14 @@ import {
trace,
context,
} from '@opentelemetry/api';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import {
SEMATTRS_DB_CONNECTION_STRING,
SEMATTRS_DB_STATEMENT,
SEMATTRS_DB_SYSTEM,
SEMATTRS_EXCEPTION_MESSAGE,
SEMATTRS_NET_PEER_NAME,
SEMATTRS_NET_PEER_PORT,
} from '@opentelemetry/semantic-conventions';
import { RedisResponseCustomAttributeFunction } from '../src/types';
import { hrTimeToMilliseconds, suppressTracing } from '@opentelemetry/core';

Expand Down Expand Up @@ -94,49 +101,40 @@ describe('redis@^4.0.0', () => {
assert.ok(setSpan);
assert.strictEqual(setSpan?.kind, SpanKind.CLIENT);
assert.strictEqual(setSpan?.name, 'redis-SET');
assert.strictEqual(setSpan?.attributes[SEMATTRS_DB_SYSTEM], 'redis');
assert.strictEqual(
setSpan?.attributes[SemanticAttributes.DB_SYSTEM],
'redis'
);
assert.strictEqual(
setSpan?.attributes[SemanticAttributes.DB_STATEMENT],
setSpan?.attributes[SEMATTRS_DB_STATEMENT],
'SET key [1 other arguments]'
);
assert.strictEqual(
setSpan?.attributes[SemanticAttributes.NET_PEER_NAME],
setSpan?.attributes[SEMATTRS_NET_PEER_NAME],
redisTestConfig.host
);
assert.strictEqual(
setSpan?.attributes[SemanticAttributes.NET_PEER_PORT],
setSpan?.attributes[SEMATTRS_NET_PEER_PORT],
redisTestConfig.port
);
assert.strictEqual(
setSpan?.attributes[SemanticAttributes.DB_CONNECTION_STRING],
setSpan?.attributes[SEMATTRS_DB_CONNECTION_STRING],
redisTestUrl
);

const getSpan = spans.find(s => s.name.includes('GET'));
assert.ok(getSpan);
assert.strictEqual(getSpan?.kind, SpanKind.CLIENT);
assert.strictEqual(getSpan?.name, 'redis-GET');
assert.strictEqual(getSpan?.attributes[SEMATTRS_DB_SYSTEM], 'redis');
assert.strictEqual(getSpan?.attributes[SEMATTRS_DB_STATEMENT], 'GET key');
assert.strictEqual(
getSpan?.attributes[SemanticAttributes.DB_SYSTEM],
'redis'
);
assert.strictEqual(
getSpan?.attributes[SemanticAttributes.DB_STATEMENT],
'GET key'
);
assert.strictEqual(
getSpan?.attributes[SemanticAttributes.NET_PEER_NAME],
getSpan?.attributes[SEMATTRS_NET_PEER_NAME],
redisTestConfig.host
);
assert.strictEqual(
getSpan?.attributes[SemanticAttributes.NET_PEER_PORT],
getSpan?.attributes[SEMATTRS_NET_PEER_PORT],
redisTestConfig.port
);
assert.strictEqual(
getSpan?.attributes[SemanticAttributes.DB_CONNECTION_STRING],
getSpan?.attributes[SEMATTRS_DB_CONNECTION_STRING],
redisTestUrl
);
});
Expand All @@ -149,15 +147,15 @@ describe('redis@^4.0.0', () => {

assert.ok(setSpan);
assert.strictEqual(
setSpan?.attributes[SemanticAttributes.DB_STATEMENT],
setSpan?.attributes[SEMATTRS_DB_STATEMENT],
'SET key [1 other arguments]'
);
assert.strictEqual(
setSpan?.attributes[SemanticAttributes.NET_PEER_NAME],
setSpan?.attributes[SEMATTRS_NET_PEER_NAME],
redisTestConfig.host
);
assert.strictEqual(
setSpan?.attributes[SemanticAttributes.NET_PEER_PORT],
setSpan?.attributes[SEMATTRS_NET_PEER_PORT],
redisTestConfig.port
);
});
Expand All @@ -180,7 +178,7 @@ describe('redis@^4.0.0', () => {
);
assert.strictEqual(exceptions.length, 1);
assert.strictEqual(
exceptions?.[0].attributes?.[SemanticAttributes.EXCEPTION_MESSAGE],
exceptions?.[0].attributes?.[SEMATTRS_EXCEPTION_MESSAGE],
'ERR value is not an integer or out of range'
);
});
Expand All @@ -202,20 +200,17 @@ describe('redis@^4.0.0', () => {

assert.strictEqual(span.name, 'redis-connect');

assert.strictEqual(span.attributes[SEMATTRS_DB_SYSTEM], 'redis');
assert.strictEqual(
span.attributes[SemanticAttributes.DB_SYSTEM],
'redis'
);
assert.strictEqual(
span.attributes[SemanticAttributes.NET_PEER_NAME],
span.attributes[SEMATTRS_NET_PEER_NAME],
redisTestConfig.host
);
assert.strictEqual(
span.attributes[SemanticAttributes.NET_PEER_PORT],
span.attributes[SEMATTRS_NET_PEER_PORT],
redisTestConfig.port
);
assert.strictEqual(
span.attributes[SemanticAttributes.DB_CONNECTION_STRING],
span.attributes[SEMATTRS_DB_CONNECTION_STRING],
redisTestUrl
);
});
Expand All @@ -235,7 +230,7 @@ describe('redis@^4.0.0', () => {
assert.strictEqual(span.name, 'redis-connect');
assert.strictEqual(span.status.code, SpanStatusCode.ERROR);
assert.strictEqual(
span.attributes[SemanticAttributes.DB_CONNECTION_STRING],
span.attributes[SEMATTRS_DB_CONNECTION_STRING],
redisURL
);
});
Expand All @@ -258,11 +253,11 @@ describe('redis@^4.0.0', () => {
assert.strictEqual(span.name, 'redis-connect');
assert.strictEqual(span.status.code, SpanStatusCode.ERROR);
assert.strictEqual(
span.attributes[SemanticAttributes.NET_PEER_NAME],
span.attributes[SEMATTRS_NET_PEER_NAME],
redisTestConfig.host
);
assert.strictEqual(
span.attributes[SemanticAttributes.DB_CONNECTION_STRING],
span.attributes[SEMATTRS_DB_CONNECTION_STRING],
expectAttributeConnString
);
});
Expand All @@ -285,11 +280,11 @@ describe('redis@^4.0.0', () => {
assert.strictEqual(span.name, 'redis-connect');
assert.strictEqual(span.status.code, SpanStatusCode.ERROR);
assert.strictEqual(
span.attributes[SemanticAttributes.NET_PEER_NAME],
span.attributes[SEMATTRS_NET_PEER_NAME],
redisTestConfig.host
);
assert.strictEqual(
span.attributes[SemanticAttributes.DB_CONNECTION_STRING],
span.attributes[SEMATTRS_DB_CONNECTION_STRING],
expectAttributeConnString
);
});
Expand All @@ -314,38 +309,38 @@ describe('redis@^4.0.0', () => {
assert.ok(multiSetSpan);
assert.strictEqual(multiSetSpan.name, 'redis-SET');
assert.strictEqual(
multiSetSpan.attributes[SemanticAttributes.DB_STATEMENT],
multiSetSpan.attributes[SEMATTRS_DB_STATEMENT],
'SET key [1 other arguments]'
);
assert.strictEqual(
multiSetSpan?.attributes[SemanticAttributes.NET_PEER_NAME],
multiSetSpan?.attributes[SEMATTRS_NET_PEER_NAME],
redisTestConfig.host
);
assert.strictEqual(
multiSetSpan?.attributes[SemanticAttributes.NET_PEER_PORT],
multiSetSpan?.attributes[SEMATTRS_NET_PEER_PORT],
redisTestConfig.port
);
assert.strictEqual(
multiSetSpan?.attributes[SemanticAttributes.DB_CONNECTION_STRING],
multiSetSpan?.attributes[SEMATTRS_DB_CONNECTION_STRING],
redisTestUrl
);

assert.ok(multiGetSpan);
assert.strictEqual(multiGetSpan.name, 'redis-GET');
assert.strictEqual(
multiGetSpan.attributes[SemanticAttributes.DB_STATEMENT],
multiGetSpan.attributes[SEMATTRS_DB_STATEMENT],
'GET another-key'
);
assert.strictEqual(
multiGetSpan?.attributes[SemanticAttributes.NET_PEER_NAME],
multiGetSpan?.attributes[SEMATTRS_NET_PEER_NAME],
redisTestConfig.host
);
assert.strictEqual(
multiGetSpan?.attributes[SemanticAttributes.NET_PEER_PORT],
multiGetSpan?.attributes[SEMATTRS_NET_PEER_PORT],
redisTestConfig.port
);
assert.strictEqual(
multiGetSpan?.attributes[SemanticAttributes.DB_CONNECTION_STRING],
multiGetSpan?.attributes[SEMATTRS_DB_CONNECTION_STRING],
redisTestUrl
);
});
Expand All @@ -360,19 +355,19 @@ describe('redis@^4.0.0', () => {
const [multiSetSpan] = getTestSpans();
assert.ok(multiSetSpan);
assert.strictEqual(
multiSetSpan.attributes[SemanticAttributes.DB_STATEMENT],
multiSetSpan.attributes[SEMATTRS_DB_STATEMENT],
'SET key [1 other arguments]'
);
assert.strictEqual(
multiSetSpan?.attributes[SemanticAttributes.NET_PEER_NAME],
multiSetSpan?.attributes[SEMATTRS_NET_PEER_NAME],
redisTestConfig.host
);
assert.strictEqual(
multiSetSpan?.attributes[SemanticAttributes.NET_PEER_PORT],
multiSetSpan?.attributes[SEMATTRS_NET_PEER_PORT],
redisTestConfig.port
);
assert.strictEqual(
multiSetSpan?.attributes[SemanticAttributes.DB_CONNECTION_STRING],
multiSetSpan?.attributes[SEMATTRS_DB_CONNECTION_STRING],
redisTestUrl
);
});
Expand Down Expand Up @@ -513,7 +508,7 @@ describe('redis@^4.0.0', () => {
await client.set('key', 'value');
const [span] = getTestSpans();
assert.strictEqual(
span.attributes[SemanticAttributes.DB_STATEMENT],
span.attributes[SEMATTRS_DB_STATEMENT],
'SET key value'
);
});
Expand All @@ -527,7 +522,7 @@ describe('redis@^4.0.0', () => {
await client.set('key', 'value');
const [span] = getTestSpans();
assert.ok(span);
assert.ok(!(SemanticAttributes.DB_STATEMENT in span.attributes));
assert.ok(!(SEMATTRS_DB_STATEMENT in span.attributes));
});
});

Expand Down
Loading

0 comments on commit 51be0fa

Please sign in to comment.