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.

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

Add db.values #3091

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions semantic_conventions/trace/database.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,15 @@ groups:
The database statement being executed.
note: The value may be sanitized to exclude sensitive information.
examples: ['SELECT * FROM wuser_table', 'SET mykey "WuValue"']
- id: values
tag: call-level
type: string
requirement_level:
conditionally_required: >
If applicable and not explicitly disabled via instrumentation configuration.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to indicate here how this can be turned off? Is it something "speced" or it differs from instrumentation to instrumentation? And I guess the "data sensitivity" concern with these values are protected somehow by this opt-in configuration?

brief: >
Array of the values to insert into placeholders in sql query.
examples: [David, 1234]
- id: operation
tag: call-level
type: string
Expand Down
23 changes: 12 additions & 11 deletions specification/trace/semantic_conventions/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@

<!-- toc -->

- [Connection-level attributes](#connection-level-attributes)
* [Notes and well-known identifiers for `db.system`](#notes-and-well-known-identifiers-for-dbsystem)
* [Connection-level attributes for specific technologies](#connection-level-attributes-for-specific-technologies)
- [Call-level attributes](#call-level-attributes)
* [Call-level attributes for specific technologies](#call-level-attributes-for-specific-technologies)
+ [Cassandra](#cassandra)
- [Examples](#examples)
* [MySQL](#mysql)
* [Redis](#redis)
* [MongoDB](#mongodb)
- [Semantic conventions for database client calls](#semantic-conventions-for-database-client-calls)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you run the markdown generator tool or change this manually? I think the build is failing because of it. The top-level page title is not in the table of contents I think, so the diff does not match.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I was sure I closed this PR.
I opened another one yesterday in which I changed only the database.yaml file, can you please refer to it?
#3092.

I thought I only need to change the yaml file, but according to your comment, I'll read the CONTRIBUTING.md file and act accordingly.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused 😅 which PR is the "real" one? This or #3092? Can you close the one that's obsolete now?

- [Connection-level attributes](#connection-level-attributes)
- [Notes and well-known identifiers for `db.system`](#notes-and-well-known-identifiers-for-dbsystem)
- [Connection-level attributes for specific technologies](#connection-level-attributes-for-specific-technologies)
- [Call-level attributes](#call-level-attributes)
- [Call-level attributes for specific technologies](#call-level-attributes-for-specific-technologies)
- [Cassandra](#cassandra)
- [Examples](#examples)
- [MySQL](#mysql)
- [Redis](#redis)
- [MongoDB](#mongodb)

<!-- tocstop -->

Expand Down Expand Up @@ -265,4 +266,4 @@ Furthermore, `db.name` is not specified as there is no database name in Redis an
| `db.name` | `"shopDb"` |
| `db.statement` | not set |
| `db.operation` | `"findAndModify"` |
| `db.mongodb.collection` | `"products"` |
| `db.mongodb.collection` | `"products"` |