You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[`db.namespace`](/docs/registry/attributes/db.md)| string | The database associated with the connection, fully qualified within the server address and port. [1]|`customers`; `test.users`|`Conditionally Required` If available without an additional network call. ||
30
+
|[`db.namespace`](/docs/registry/attributes/db.md)| string | The database associated with the connection, fully qualified within the server address and port. [1]|`customers`; `webshop\|customers`|`Conditionally Required` If available without an additional network call. ||
31
31
|[`db.response.status_code`](/docs/registry/attributes/db.md)| string | Database response code recorded as a string. [2]|`ORA-17027`; `1052`; `2201B`|`Conditionally Required` If response has ended with warning or an error. ||
32
32
|[`error.type`](/docs/registry/attributes/error.md)| string | Describes a class of error the operation ended with. [3]|`timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500`|`Conditionally Required` If and only if the operation failed. ||
33
33
|[`server.port`](/docs/registry/attributes/server.md)| int | Server port number. [4]|`80`; `8080`; `443`|`Conditionally Required`[5]||
34
-
|[`db.collection.name`](/docs/registry/attributes/db.md)| string | The name of a collection (table, container) within the database. [6]|`public.users`; `customers`|`Recommended`[7]||
35
-
|[`db.operation.batch.size`](/docs/registry/attributes/db.md)| int | The number of queries included in a batch operation. [8]|`2`; `3`; `4`|`Recommended`||
36
-
|[`db.operation.name`](/docs/registry/attributes/db.md)| string | The name of the operation or command being executed. [9]|`EXECUTE`; `INSERT`|`Recommended`[10]||
37
-
|[`db.query.summary`](/docs/registry/attributes/db.md)| string | Low cardinality summary of a database query. [11]|`SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id`|`Recommended`[12]||
38
-
|[`db.query.text`](/docs/registry/attributes/db.md)| string | The database query being executed. [13]|`SELECT * FROM wuser_table where username = ?`; `SET mykey ?`|`Recommended`[14]||
39
-
|[`db.stored_procedure.name`](/docs/registry/attributes/db.md)| string |The name of a stored procedure within the database. [15]|`GetCustomer`|`Recommended`[16]||
|[`server.address`](/docs/registry/attributes/server.md)| string | Name of the database host. [18]|`example.com`; `10.1.2.80`; `/tmp/my.sock`|`Recommended`||
42
-
|[`db.query.parameter.<key>`](/docs/registry/attributes/db.md)| string | A database query parameter, with `<key>` being the parameter name, and the attribute value being a string representation of the parameter value. [19]|`someval`; `55`|`Opt-In`||
34
+
|[`db.collection.name`](/docs/registry/attributes/db.md)| string | The name of the tablewithin the database. |`public.users`; `customers`|`Recommended`||
35
+
|[`db.operation.batch.size`](/docs/registry/attributes/db.md)| int | The number of queries included in a batch operation. [6]|`2`; `3`; `4`|`Recommended`||
36
+
|[`db.operation.name`](/docs/registry/attributes/db.md)| string | The name of the operation or command being executed. [7]|`EXECUTE`; `INSERT`|`Recommended`||
37
+
|[`db.query.summary`](/docs/registry/attributes/db.md)| string | Low cardinality summary of a database query. [8]|`SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id`|`Recommended`||
38
+
|[`db.query.text`](/docs/registry/attributes/db.md)| string | The database query being executed. [9]|`SELECT * FROM wuser_table where username = ?`; `SET mykey ?`|`Recommended`[10]||
39
+
|[`db.stored_procedure.name`](/docs/registry/attributes/db.md)| string |In SurrealDB this refers to the function being invoked. |`GetCustomer`|`Recommended`[11]||
|[`server.address`](/docs/registry/attributes/server.md)| string | Name of the database host. [13]|`example.com`; `10.1.2.80`; `/tmp/my.sock`|`Recommended`||
42
+
|[`db.query.parameter.<key>`](/docs/registry/attributes/db.md)| string | A database query parameter, with `<key>` being the parameter name, and the attribute value being a string representation of the parameter value. [14]|`someval`; `55`|`Opt-In`||
43
43
|[`db.response.returned_rows`](/docs/registry/attributes/db.md)| int | Number of rows returned by the operation. |`10`; `30`; `1000`|`Opt-In`||
44
44
45
-
**[1]`db.namespace`:** If a database system has multiple namespace components (e.g. schema name and database name), they SHOULD be concatenated
46
-
from the most general to the most specific namespace component,
47
-
using `|` as a separator between the components.
48
-
Any missing components (and their associated separators) SHOULD be omitted.
45
+
**[1]`db.namespace`:** SurrealDB has the notion of both namespace & database for each client. As such the structure of this attribue would become `{{Namespace}}|{{Database}}`.
49
46
50
-
Semantic conventions for individual database systems SHOULD document what `db.namespace`
51
-
means in the context of that system.
52
-
53
-
A connection's currently associated database may change during its lifetime, e.g. from executing `USE <database>`.
54
-
55
-
If instrumentation is unable to capture the connection's currently associated database on each query
56
-
without triggering an additional query to be executed (e.g. `SELECT DATABASE()`),
57
-
then it is RECOMMENDED to fallback and use the database provided when the connection was established.
58
-
59
-
Instrumentation SHOULD document if `db.namespace` reflects the database provided when the connection was established.
60
-
61
-
It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization.
62
-
63
-
**[2]`db.response.status_code`:** SQL defines [SQLSTATE](https://wikipedia.org/wiki/SQLSTATE) as a database
64
-
return code which is adopted by some database systems like PostgreSQL.
65
-
See [PostgreSQL error codes](https://www.postgresql.org/docs/current/errcodes-appendix.html)
66
-
for the details.
67
-
68
-
Other systems like MySQL, Oracle, or MS SQL Server define vendor-specific
69
-
error codes. Database SQL drivers usually provide access to both properties.
70
-
For example, in Java, the [`SQLException`](https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html)
71
-
class reports them with `getSQLState()` and `getErrorCode()` methods.
72
-
73
-
Instrumentations SHOULD populate the `db.response.status_code` with the
74
-
the most specific code available to them.
75
-
76
-
Here's a non-exhaustive list of databases that report vendor-specific
77
-
codes with granularity higher than SQLSTATE (or don't report SQLSTATE
-[SQLite result codes](https://www.sqlite.org/rescode.html)
86
-
87
-
These systems SHOULD set the `db.response.status_code` to a
88
-
known vendor-specific error code. If only SQLSTATE is available,
89
-
it SHOULD be used.
90
-
91
-
When multiple error codes are available and specificity is unclear,
92
-
instrumentation SHOULD set the `db.response.status_code` to the
93
-
concatenated string of all codes with '/' used as a separator.
94
-
95
-
For example, generic DB instrumentation that detected an error and has
96
-
SQLSTATE `"42000"` and vendor-specific `1071` should set
97
-
`db.response.status_code` to `"42000/1071"`."
47
+
**[2]`db.response.status_code`:** The http response status code is to be used as the database status code.
98
48
99
49
**[3]`error.type`:** The `error.type` SHOULD match the `db.response.status_code` returned by the database or the client library, or the canonical name of exception that occurred.
100
50
When using canonical exception type name, instrumentation SHOULD do the best effort to report the most relevant type. For example, if the original exception is wrapped into a generic one, the original exception SHOULD be preferred.
@@ -104,48 +54,26 @@ Instrumentations SHOULD document how `error.type` is populated.
104
54
105
55
**[5]`server.port`:** If using a port other than the default port for this DBMS and if `server.address` is set.
106
56
107
-
**[6]`db.collection.name`:** The collection name SHOULD NOT be extracted from `db.query.text`.
108
-
109
-
**[7]`db.collection.name`:** If the operation is executed via a higher-level API that does not support multiple collection names.
110
-
111
-
**[8]`db.operation.batch.size`:** Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`.
112
-
113
-
**[9]`db.operation.name`:** The operation name SHOULD NOT be extracted from `db.query.text`.
114
-
115
-
**[10]`db.operation.name`:** If the operation is executed via a higher-level API that does not support multiple operation names.
116
-
117
-
**[11]`db.query.summary`:** The query summary describes a class of database queries and is useful
118
-
as a grouping key, especially when analyzing telemetry for database
119
-
calls involving complex queries.
57
+
**[6]`db.operation.batch.size`:** Operations are only considered batches when they contain two or more operations, and so `db.operation.batch.size` SHOULD never be `1`.
120
58
121
-
Summary may be available to the instrumentation through
122
-
instrumentation hooks or other means. If it is not available, instrumentations
123
-
that support query parsing SHOULD generate a summary following
**[7]`db.operation.name`:** The operation name is to reflect the api method being called ie upsert.
126
60
127
-
**[12]`db.query.summary`:**if available through instrumentation hooks or if the instrumentation supports generating a query summary.
61
+
**[8]`db.query.summary`:**The query summary is to be a concatenation of the method and table being acted on.
128
62
129
-
**[13]`db.query.text`:** For sanitization see [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext).
63
+
**[9]`db.query.text`:** For sanitization see [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext).
130
64
For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
131
65
Parameterized query text SHOULD NOT be sanitized. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
132
66
133
-
**[14]`db.query.text`:** Non-parameterized query text SHOULD NOT be collected by default unless there is sanitization that excludes sensitive data, e.g. by redacting all literal values present in the query text. See [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext).
67
+
**[10]`db.query.text`:** Non-parameterized query text SHOULD NOT be collected by default unless there is sanitization that excludes sensitive data, e.g. by redacting all literal values present in the query text. See [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext).
134
68
Parameterized query text SHOULD be collected by default (the query parameter values themselves are opt-in, see [`db.query.parameter.<key>`](/docs/registry/attributes/db.md)).
135
69
136
-
**[15]`db.stored_procedure.name`:** It is RECOMMENDED to capture the value as provided by the application
137
-
without attempting to do any case normalization.
70
+
**[11]`db.stored_procedure.name`:** If operation applies to a specific stored procedure.
138
71
139
-
For batch operations, if the individual operations are known to have the same
140
-
stored procedure name then that stored procedure name SHOULD be used.
72
+
**[12]`network.protocol.name`:** The value SHOULD be normalized to lowercase.
141
73
142
-
**[16]`db.stored_procedure.name`:**If operation applies to a specific stored procedure.
74
+
**[13]`server.address`:**When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
143
75
144
-
**[17]`network.protocol.name`:** The value SHOULD be normalized to lowercase.
145
-
146
-
**[18]`server.address`:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
147
-
148
-
**[19]`db.query.parameter.<key>`:** If a query parameter has no name and instead is referenced only by index,
76
+
**[14]`db.query.parameter.<key>`:** If a query parameter has no name and instead is referenced only by index,
149
77
then `<key>` SHOULD be the 0-based index.
150
78
151
79
`db.query.parameter.<key>` SHOULD match
@@ -182,17 +110,4 @@ and SHOULD be provided **at span creation time** (if provided at all):
182
110
<!-- END AUTOGENERATED TEXT -->
183
111
<!-- endsemconv -->
184
112
185
-
## Example
186
-
187
-
This is an example of attributes for a MySQL database span:
Copy file name to clipboardExpand all lines: model/database/spans.yaml
+18Lines changed: 18 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1027,3 +1027,21 @@ groups:
1027
1027
`db.system.name` MUST be set to `"surrealdb"` and SHOULD be provided **at span creation time**.
1028
1028
attributes:
1029
1029
- ref: network.protocol.name
1030
+
- ref: db.stored_procedure.name
1031
+
brief: In SurrealDB this refers to the function being invoked.
1032
+
note: ''
1033
+
- ref: db.namespace
1034
+
note: SurrealDB has the notion of both namespace & database for each client. As such the structure of this attribue would become `{{Namespace}}|{{Database}}`.
1035
+
examples: ['customers', 'webshop\|customers']
1036
+
- ref: db.operation.name
1037
+
note: The operation name is to reflect the api method being called ie upsert.
1038
+
requirement_level: recommended
1039
+
- ref: db.response.status_code
1040
+
note: The http response status code is to be used as the database status code.
1041
+
- ref: db.query.summary
1042
+
note: The query summary is to be a concatenation of the method and table being acted on.
0 commit comments