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

Jump to bottom

refactor(instr-mysql2): use exported strings for attributes #2115

Merged
merged 2 commits into from
Apr 19, 2024
Merged

refactor(instr-mysql2): use exported strings for attributes #2115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d4aa8b
refactor(instr-mysql2): use exported strings for attributes
david-luna Apr 18, 2024
a16817a
Merge branch 'main' into dluna/mysql2-semconv-strings
trentm Apr 19, 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
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

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

16 changes: 16 additions & 0 deletions plugins/node/opentelemetry-instrumentation-mysql2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,22 @@ You can set the following instrumentation options:
| `responseHook` | `MySQL2InstrumentationExecutionResponseHook` (function) | Function for adding custom attributes from db response |
| `addSqlCommenterCommentToQueries` | `boolean` | If true, adds [sqlcommenter](https://github.com/open-telemetry/opentelemetry-sqlcommenter) specification compliant comment to queries with tracing context (default false). _NOTE: A comment will not be added to queries that already contain `--` or `/* ... */` in them, even if these are not actually part of comments_ |

## 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. |
| `db.name` | This attribute is used to report the name of the database being accessed. |
| `db.statement` | The database statement being executed. |
| `db.system` | An identifier for the database management system (DBMS) product being used. |
| `db.user` | Username for accessing the database. |
| `net.peer.name` | Remote hostname or similar. |
| `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-mysql2/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
},
"dependencies": {
"@opentelemetry/instrumentation": "^0.50.0",
"@opentelemetry/semantic-conventions": "^1.0.0",
"@opentelemetry/semantic-conventions": "^1.22.0",
"@opentelemetry/sql-common": "^0.40.0"
},
"homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-mysql2#readme"
Expand Down
13 changes: 5 additions & 8 deletions plugins/node/opentelemetry-instrumentation-mysql2/src/instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ import {
safeExecuteInTheMiddle,
} from '@opentelemetry/instrumentation';
import {
DbSystemValues,
SemanticAttributes,
DBSYSTEMVALUES_MYSQL,
SEMATTRS_DB_STATEMENT,
SEMATTRS_DB_SYSTEM,
} from '@opentelemetry/semantic-conventions';
import { addSqlCommenterComment } from '@opentelemetry/sql-common';
import type * as mysqlTypes from 'mysql2';
Expand All @@ -40,7 +41,7 @@ type formatType = typeof mysqlTypes.format;

export class MySQL2Instrumentation extends InstrumentationBase<any> {
static readonly COMMON_ATTRIBUTES = {
[SemanticAttributes.DB_SYSTEM]: DbSystemValues.MYSQL,
[SEMATTRS_DB_SYSTEM]: DBSYSTEMVALUES_MYSQL,
};

constructor(config?: MySQL2InstrumentationConfig) {
Expand Down Expand Up @@ -115,11 +116,7 @@ export class MySQL2Instrumentation extends InstrumentationBase<any> {
attributes: {
...MySQL2Instrumentation.COMMON_ATTRIBUTES,
...getConnectionAttributes(this.config),
[SemanticAttributes.DB_STATEMENT]: getDbStatement(
query,
format,
values
),
[SEMATTRS_DB_STATEMENT]: getDbStatement(query, format, values),
},
});

Expand Down
40 changes: 19 additions & 21 deletions plugins/node/opentelemetry-instrumentation-mysql2/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,14 @@
* limitations under the License.
*/

import { SpanAttributes } from '@opentelemetry/api';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import { Attributes } from '@opentelemetry/api';
import {
SEMATTRS_DB_CONNECTION_STRING,
SEMATTRS_DB_NAME,
SEMATTRS_DB_USER,
SEMATTRS_NET_PEER_NAME,
SEMATTRS_NET_PEER_PORT,
} from '@opentelemetry/semantic-conventions';

/*
Following types declare an expectation on mysql2 types and define a subset we
Expand All @@ -42,35 +48,27 @@ interface Config {
connectionConfig?: Config;
}
/**
* Get an SpanAttributes map from a mysql connection config object
* Get an Attributes map from a mysql connection config object
*
* @param config ConnectionConfig
*/
export function getConnectionAttributes(config: Config): SpanAttributes {
export function getConnectionAttributes(config: Config): Attributes {
const { host, port, database, user } = getConfig(config);
const portNumber = parseInt(port, 10);
if (!isNaN(portNumber)) {
return {
[SemanticAttributes.NET_PEER_NAME]: host,
[SemanticAttributes.NET_PEER_PORT]: portNumber,
[SemanticAttributes.DB_CONNECTION_STRING]: getJDBCString(
host,
port,
database
),
[SemanticAttributes.DB_NAME]: database,
[SemanticAttributes.DB_USER]: user,
[SEMATTRS_NET_PEER_NAME]: host,
[SEMATTRS_NET_PEER_PORT]: portNumber,
[SEMATTRS_DB_CONNECTION_STRING]: getJDBCString(host, port, database),
[SEMATTRS_DB_NAME]: database,
[SEMATTRS_DB_USER]: user,
};
}
return {
[SemanticAttributes.NET_PEER_NAME]: host,
[SemanticAttributes.DB_CONNECTION_STRING]: getJDBCString(
host,
port,
database
),
[SemanticAttributes.DB_NAME]: database,
[SemanticAttributes.DB_USER]: user,
[SEMATTRS_NET_PEER_NAME]: host,
[SEMATTRS_DB_CONNECTION_STRING]: getJDBCString(host, port, database),
[SEMATTRS_DB_NAME]: database,
[SEMATTRS_DB_USER]: user,
};
}

Expand Down
31 changes: 15 additions & 16 deletions plugins/node/opentelemetry-instrumentation-mysql2/test/mysql.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,13 @@ import * as semver from 'semver';
import { context, trace, SpanStatusCode } from '@opentelemetry/api';
import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
import {
DbSystemValues,
SemanticAttributes,
DBSYSTEMVALUES_MYSQL,
SEMATTRS_DB_NAME,
SEMATTRS_DB_STATEMENT,
SEMATTRS_DB_SYSTEM,
SEMATTRS_DB_USER,
SEMATTRS_NET_PEER_NAME,
SEMATTRS_NET_PEER_PORT,
} from '@opentelemetry/semantic-conventions';
import * as testUtils from '@opentelemetry/contrib-test-utils';
import {
Expand Down Expand Up @@ -177,10 +182,7 @@ describe('mysql2@2.x', () => {
query.on('end', () => {
const spans = memoryExporter.getFinishedSpans();
assert.strictEqual(spans[0].name, 'SELECT');
assert.strictEqual(
spans[0].attributes[SemanticAttributes.DB_STATEMENT],
sql
);
assert.strictEqual(spans[0].attributes[SEMATTRS_DB_STATEMENT], sql);
done();
});
});
Expand All @@ -198,7 +200,7 @@ describe('mysql2@2.x', () => {
const spans = memoryExporter.getFinishedSpans();
assert.strictEqual(spans[0].name, 'SELECT');
assert.strictEqual(
spans[0].attributes[SemanticAttributes.DB_STATEMENT],
spans[0].attributes[SEMATTRS_DB_STATEMENT],
query.sql
);
done();
Expand Down Expand Up @@ -1215,16 +1217,13 @@ function assertSpan(
values?: any,
errorMessage?: string
) {
assert.strictEqual(span.attributes[SEMATTRS_DB_SYSTEM], DBSYSTEMVALUES_MYSQL);
assert.strictEqual(span.attributes[SEMATTRS_DB_NAME], database);
assert.strictEqual(span.attributes[SEMATTRS_NET_PEER_PORT], port);
assert.strictEqual(span.attributes[SEMATTRS_NET_PEER_NAME], host);
assert.strictEqual(span.attributes[SEMATTRS_DB_USER], user);
assert.strictEqual(
span.attributes[SemanticAttributes.DB_SYSTEM],
DbSystemValues.MYSQL
);
assert.strictEqual(span.attributes[SemanticAttributes.DB_NAME], database);
assert.strictEqual(span.attributes[SemanticAttributes.NET_PEER_PORT], port);
assert.strictEqual(span.attributes[SemanticAttributes.NET_PEER_NAME], host);
assert.strictEqual(span.attributes[SemanticAttributes.DB_USER], user);
assert.strictEqual(
span.attributes[SemanticAttributes.DB_STATEMENT],
span.attributes[SEMATTRS_DB_STATEMENT],
mysqlTypes.format(sql, values)
);
if (errorMessage) {
Expand Down
Loading