Skip to content

Commit

Permalink
Updates based on review
Browse files Browse the repository at this point in the history
  • Loading branch information
estolfo committed Apr 6, 2023
1 parent 86f988f commit 38f8fc2
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 18 deletions.
17 changes: 7 additions & 10 deletions semantic_conventions/trace/database.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -400,10 +400,10 @@ groups:
brief: >
The document that the request targets.
examples: [ '123', '456' ]
- id: params
- id: url.query
type: string
requirement_level:
conditionally_required: when params are provided as part of the request
conditionally_required: when query params are provided as part of the request
tag: call-level-tech-specific
brief: >
The query params of the request, as a json string.
Expand All @@ -416,20 +416,16 @@ groups:
brief: >
The name of the data stream or index that is targeted.
examples: [ 'users' ]
- id: url
- id: url.path
type: string
requirement_level: required
tag: call-level-tech-specific
brief: >
The url of the request, including the target and exact document id.
The path of the request, including the target and exact document id.
examples: [ '/test-index/_search', '/test-index/_doc/123' ]
- id: method
type: string
- ref: http.method
requirement_level: required
tag: call-level-tech-specific
brief: >
The HTTP method of the request.
examples: [ 'GET', 'PUT' ]

- id: db.sql
prefix: 'db.sql'
type: span
Expand Down Expand Up @@ -562,3 +558,4 @@ groups:
- include: 'db.mongodb'
- include: 'db.sql'
- include: 'db.cosmosdb'
- include: 'db.elasticsearch'
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ When there is no target or document id, the span name will contain the exact url
### Span attributes

<!-- semconv elasticsearch -->
| Attribute | Type | Description | Examples | Requirement Level |
|---------------------------|---|---------------------------------------------------------------------|---------------------------------------------------------|------------------------|
| `db.elasticsearch.doc_id` | string | The document that the request targets, specified in the path. | `'123'` | Conditionally Required |
| `db.elasticsearch.params` | string | The query params of the request, as a json string. | `'"{\"q\":\"test\"}", "{\"refresh\":true}"'` | Conditionally Required |
| `db.elasticsearch.target` | string | The name of the data stream or index that is targeted. | `'users'` | Conditionally Required |
| `db.elasticsearch.url` | string | The exact url of the request, including the target and document id. | `'/test-index/_doc/123'` | Required |
| `db.elasticsearch.method` | string | The HTTP method of the request. | `'GET'` | Required |
| `db.statement` | string | The request body, as a json string. [1] | `"{\"name\":\"TestUser\",\"password\":\"top_secret\"}"` | Conditionally Required |
| Attribute | Type | Description | Examples | Requirement Level |
|----------------------------|---|----------------------------------------------------------------------|---------------------------------------------------------|------------------------|
| `db.elasticsearch.doc_id` | string | The document that the request targets, specified in the path. | `'123'` | Conditionally Required |
| `db.elasticsearch.target` | string | The name of the data stream or index that is targeted. | `'users'` | Conditionally Required |
| `db.elasticsearch.url.path` | string | The exact path of the request, including the target and document id. | `'/test-index/_doc/123'` | Required |
| `db.elasticsearch.url.query` | string | The query params of the request, as a json string. | `'"{\"q\":\"test\"}", "{\"refresh\":true}"'` | Conditionally Required |
| `db.statement` | string | The request body, as a json string. [1] | `"{\"name\":\"TestUser\",\"password\":\"top_secret\"}"` | Conditionally Required |
| `http.method` | string | HTTP request method. | `GET`; `POST`; `HEAD` | Required |

**[1]:** The value may be sanitized to exclude sensitive information.
<!-- endsemconv -->

0 comments on commit 38f8fc2

Please sign in to comment.