Skip to content

Commit edff90b

Browse files
thompson-tomothompson-tomo
committed
Add explicit documentation
1 parent 5feed7a commit edff90b

File tree

2 files changed

+209
-0
lines changed

2 files changed

+209
-0
lines changed

‎docs/database/surrealdb.md

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
<!--- Hugo front matter used to generate the website version of this page:
2+
linkTitle: SQL
3+
--->
4+
5+
# Semantic conventions for SureealDB client operations
6+
7+
**Status**: [Development][DocumentStatus]
8+
9+
## Spans
10+
11+
<!-- semconv span.db.surrealdb.client -->
12+
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
13+
<!-- see templates/registry/markdown/snippet.md.j2 -->
14+
<!-- prettier-ignore-start -->
15+
<!-- markdownlint-capture -->
16+
<!-- markdownlint-disable -->
17+
18+
**Status:** ![Development](https://img.shields.io/badge/-development-blue)
19+
20+
Spans representing calls to a SurrealDB database adhere to the general [Semantic Conventions for Database Client Spans](database-spans.md).
21+
22+
`db.system.name` MUST be set to `"surrealdb"` and SHOULD be provided **at span creation time**.
23+
24+
**Span kind** SHOULD be `CLIENT`.
25+
26+
**Span status** SHOULD follow the [Recording Errors](/docs/general/recording-errors.md) document.
27+
28+
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
29+
|---|---|---|---|---|---|
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`; `test.users` | `Conditionally Required` If available without an additional network call. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
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. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
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. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
33+
| [`server.port`](/docs/registry/attributes/server.md) | int | Server port number. [4] | `80`; `8080`; `443` | `Conditionally Required` [5] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
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] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
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` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
36+
| [`db.operation.name`](/docs/registry/attributes/db.md) | string | The name of the operation or command being executed. [9] | `EXECUTE`; `INSERT` | `Recommended` [10] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
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] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
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] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
39+
| [`db.stored_procedure.name`](/docs/registry/attributes/db.md) | string | The name of a stored procedure within the database. [15] | `GetCustomer` | `Recommended` [16] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
40+
| [`network.protocol.name`](/docs/registry/attributes/network.md) | string | [OSI application layer](https://wikipedia.org/wiki/Application_layer) or non-OSI equivalent. [17] | `amqp`; `http`; `mqtt` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
41+
| [`server.address`](/docs/registry/attributes/server.md) | string | Name of the database host. [18] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
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` | ![Development](https://img.shields.io/badge/-development-blue) |
43+
| [`db.response.returned_rows`](/docs/registry/attributes/db.md) | int | Number of rows returned by the operation. | `10`; `30`; `1000` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
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.
49+
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
78+
at all):
79+
80+
- [DB2 SQL codes](https://www.ibm.com/docs/db2-for-zos/12?topic=codes-sql).
81+
- [Maria DB error codes](https://mariadb.com/kb/en/mariadb-error-code-reference/)
82+
- [Microsoft SQL Server errors](https://docs.microsoft.com/sql/relational-databases/errors-events/database-engine-events-and-errors)
83+
- [MySQL error codes](https://dev.mysql.com/doc/mysql-errors/9.0/en/error-reference-introduction.html)
84+
- [Oracle error codes](https://docs.oracle.com/cd/B28359_01/server.111/b28278/toc.htm)
85+
- [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"`."
98+
99+
**[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+
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.
101+
Instrumentations SHOULD document how `error.type` is populated.
102+
103+
**[4] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.
104+
105+
**[5] `server.port`:** If using a port other than the default port for this DBMS and if `server.address` is set.
106+
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.
120+
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
124+
[Generating query summary](/docs/database/database-spans.md#generating-a-summary-of-the-query)
125+
section.
126+
127+
**[12] `db.query.summary`:** if available through instrumentation hooks or if the instrumentation supports generating a query summary.
128+
129+
**[13] `db.query.text`:** For sanitization see [Sanitization of `db.query.text`](/docs/database/database-spans.md#sanitization-of-dbquerytext).
130+
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+
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+
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).
134+
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+
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.
138+
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.
141+
142+
**[16] `db.stored_procedure.name`:** If operation applies to a specific stored procedure.
143+
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,
149+
then `<key>` SHOULD be the 0-based index.
150+
151+
`db.query.parameter.<key>` SHOULD match
152+
up with the parameterized placeholders present in `db.query.text`.
153+
154+
`db.query.parameter.<key>` SHOULD NOT be captured on batch operations.
155+
156+
Examples:
157+
158+
- For a query `SELECT * FROM users where username = %s` with the parameter `"jdoe"`,
159+
the attribute `db.query.parameter.0` SHOULD be set to `"jdoe"`.
160+
161+
- For a query `"SELECT * FROM users WHERE username = %(username)s;` with parameter
162+
`username = "jdoe"`, the attribute `db.query.parameter.username` SHOULD be set to `"jdoe"`.
163+
164+
The following attributes can be important for making sampling decisions
165+
and SHOULD be provided **at span creation time** (if provided at all):
166+
167+
* [`db.query.summary`](/docs/registry/attributes/db.md)
168+
* [`db.query.text`](/docs/registry/attributes/db.md)
169+
* [`server.address`](/docs/registry/attributes/server.md)
170+
* [`server.port`](/docs/registry/attributes/server.md)
171+
172+
---
173+
174+
`error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
175+
176+
| Value | Description | Stability |
177+
|---|---|---|
178+
| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
179+
180+
<!-- markdownlint-restore -->
181+
<!-- prettier-ignore-end -->
182+
<!-- END AUTOGENERATED TEXT -->
183+
<!-- endsemconv -->
184+
185+
## Example
186+
187+
This is an example of attributes for a MySQL database span:
188+
189+
| Key | Value |
190+
|:-----------------------| :----------------------------------------------------------- |
191+
| Span name | `"SELECT orders"` |
192+
| `db.namespace` | `"ShopDb"` |
193+
| `db.system.name` | `"mysql"` |
194+
| `server.address` | `"shopdb.example.com"` |
195+
| `server.port` | `3306` |
196+
| `db.query.text` | `"SELECT * FROM orders WHERE order_id = 'o4711'"` |
197+
198+
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

‎model/database/spans.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1016,3 +1016,14 @@ groups:
10161016
For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used,
10171017
otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
10181018
examples: ["SELECT * FROM wuser_table where username = :mykey"]
1019+
- id: span.db.surrealdb.client
1020+
type: span
1021+
stability: development
1022+
extends: span.db.sql.client
1023+
span_kind: client
1024+
brief: >
1025+
Spans representing calls to a SurrealDB database adhere to the general [Semantic Conventions for Database Client Spans](database-spans.md).
1026+
note: |
1027+
`db.system.name` MUST be set to `"surrealdb"` and SHOULD be provided **at span creation time**.
1028+
attributes:
1029+
- ref: network.protocol.name

0 commit comments

Comments
 (0)