Skip to content

Commit f9ecfc0

Browse files
committed
chore(instr-mysql): update README
1 parent 6d71a50 commit f9ecfc0

File tree

1 file changed

+17
-0
lines changed
  • plugins/node/opentelemetry-instrumentation-mysql

1 file changed

+17
-0
lines changed

plugins/node/opentelemetry-instrumentation-mysql/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,23 @@ See [examples/mysql](https://github.com/open-telemetry/opentelemetry-js-contrib/
4949
| [`enhancedDatabaseReporting`](./src/types.ts#L24) | `boolean` | `false` | If true, an attribute containing the query's parameters will be attached the spans generated to represent the query |
5050
|
5151

52+
## Semantic Conventions
53+
54+
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)
55+
56+
Attributes collected:
57+
58+
| Attribute | Short Description |
59+
| ----------------------- | ------------------------------------------------------------------------------ |
60+
| `db.connection_string` | The connection string used to connect to the database. |
61+
| `db.name` | This attribute is used to report the name of the database being accessed. |
62+
| `db.operation` | The name of the operation being executed. |
63+
| `db.statement` | The database statement being executed. |
64+
| `db.system` | An identifier for the database management system (DBMS) product being used. |
65+
| `db.user` | Username for accessing the database. |
66+
| `net.peer.name` | Remote hostname or similar. |
67+
| `net.peer.port` | Remote port number. |
68+
5269
## Useful links
5370

5471
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>

0 commit comments

Comments
 (0)