Skip to content

Commit

Permalink
Add back note about batch operations
Browse files Browse the repository at this point in the history
  • Loading branch information
gregkalapos committed Jun 7, 2024
1 parent 0422437 commit bcf3714
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/database/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ For batch operations, if the individual operations are known to have the same op
**[8]:** If using a port other than the default port for this DBMS and if `server.address` is set.

**[9]:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext)
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.

**[10]:** SHOULD be collected by default only if there is sanitization that excludes sensitive information.

Expand Down
6 changes: 2 additions & 4 deletions docs/database/cosmosdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,11 @@ For batch operations, if the individual operations are known to have the same op

**[6]:** If using a port other than the default port for this DBMS and if `server.address` is set.


**[7]:** 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.

**[7]:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext)
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.

**[8]:** SHOULD be collected by default only if there is sanitization that excludes sensitive information.


**[9]:** 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.

**[10]:** The user-agent value is generated by SDK which is a combination of<br> `sdk_version` : Current version of SDK. e.g. 'cosmos-netstandard-sdk/3.23.0'<br> `direct_pkg_version` : Direct package version used by Cosmos DB SDK. e.g. '3.23.1'<br> `number_of_client_instances` : Number of cosmos client instances created by the application. e.g. '1'<br> `type_of_machine_architecture` : Machine architecture. e.g. 'X64'<br> `operating_system` : Operating System. e.g. 'Linux 5.4.0-1098-azure 104 18'<br> `runtime_framework` : Runtime Framework. e.g. '.NET Core 3.1.32'<br> `failover_information` : Generated key to determine if region failover enabled.
Expand Down
1 change: 1 addition & 0 deletions docs/database/database-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ For batch operations, if the individual operations are known to have the same op
**[9]:** If using a port other than the default port for this DBMS and if `server.address` is set.

**[10]:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext)
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.

**[11]:** SHOULD be collected by default only if there is sanitization that excludes sensitive information.

Expand Down
1 change: 1 addition & 0 deletions docs/database/mssql.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ In the case of `EXEC`, this SHOULD be the stored procedure name that is being ex
**[8]:** If using a port other than the default port for this DBMS and if `server.address` is set.

**[9]:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext)
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.

**[10]:** SHOULD be collected by default only if there is sanitization that excludes sensitive information.

Expand Down
1 change: 1 addition & 0 deletions docs/database/sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ In the case of `EXEC`, this SHOULD be the stored procedure name that is being ex
**[8]:** If using a port other than the default port for this DBMS and if `server.address` is set.

**[9]:** For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext)
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.

**[10]:** SHOULD be collected by default only if there is sanitization that excludes sensitive information.

Expand Down
9 changes: 7 additions & 2 deletions model/trace/database.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ groups:
Parameterized query text SHOULD be collected by default
(the query parameter values themselves are opt-in,
see [`db.query.parameter.<key>`](../../docs/attributes-registry/db.md)).
note:
note: >
For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext)
Even though parameterized query text can potentially have sensitive data, by using a parameterized query
Expand All @@ -28,7 +28,12 @@ groups:
brief: This group defines the attributes used to perform database client calls.
attributes:
- ref: db.query.text
note: For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext)
note: >
For sanitization see [Sanitization of `db.query.text`](../../docs/database/database-spans.md#sanitization-of-dbquerytext)
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.
requirement_level:
recommended: >
SHOULD be collected by default only if there is sanitization that excludes sensitive information.
Expand Down

0 comments on commit bcf3714

Please sign in to comment.