Skip to content

Commit b321d3a

Browse files
thompson-tomomartincostellolmolkova
authored
Add Query http method #2642 (#2643)
Co-authored-by: Martin Costello <[email protected]> Co-authored-by: Liudmila Molkova <[email protected]>
1 parent 1cf2476 commit b321d3a

File tree

6 files changed

+77
-26
lines changed

6 files changed

+77
-26
lines changed

‎.chloggen/add_http_query_method.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Use this changelog template to create an entry for release notes.
2+
#
3+
# If your change doesn't affect end users you should instead start
4+
# your pull request title with [chore] or use the "Skip Changelog" label.
5+
6+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
7+
change_type: enhancement
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: http
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: Adds in the HTTP QUERY method.
14+
15+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
16+
# The values here must be integers.
17+
issues: [2642]
18+
19+
# (Optional) One or more lines of additional information to render under the primary note.
20+
# These lines will be padded with 2 spaces and then inserted directly into the document.
21+
# Use pipe (|) for multiline entries.
22+
subtext:

‎docs/database/elasticsearch.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,9 @@ with the endpoint identifier stored in `db.operation.name`, and the index stored
5858
For batch operations, if the individual operations are known to have the same operation name then that operation name SHOULD be used prepended by `bulk `, otherwise `db.operation.name` SHOULD be `bulk`.
5959

6060
**[2] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
61-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
62-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
61+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
62+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
63+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
6364

6465
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
6566

@@ -159,6 +160,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
159160
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
160161
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
161162
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
163+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
162164
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
163165

164166
<!-- markdownlint-restore -->

‎docs/http/http-metrics.md‎

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,9 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
9292
| [`user_agent.synthetic.type`](/docs/registry/attributes/user-agent.md) | string | Specifies the category of synthetic traffic, such as tests or bots. [10] | `bot`; `test` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
9393

9494
**[1] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
95-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
96-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
95+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
96+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
97+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
9798

9899
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
99100

@@ -169,6 +170,7 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
169170
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
170171
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
171172
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
173+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
172174
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
173175

174176
---
@@ -208,8 +210,9 @@ This metric is optional.
208210
| [`server.port`](/docs/registry/attributes/server.md) | int | Port of the local HTTP server that received the request. [3] | `80`; `8080`; `443` | `Opt-In` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
209211

210212
**[1] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
211-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
212-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
213+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
214+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
215+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
213216

214217
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
215218

@@ -247,6 +250,7 @@ Tracing instrumentations that do so, MUST also set `http.request.method_original
247250
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
248251
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
249252
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
253+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
250254
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
251255

252256
<!-- markdownlint-restore -->
@@ -285,8 +289,9 @@ This metric is optional.
285289
| [`user_agent.synthetic.type`](/docs/registry/attributes/user-agent.md) | string | Specifies the category of synthetic traffic, such as tests or bots. [10] | `bot`; `test` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
286290

287291
**[1] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
288-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
289-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
292+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
293+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
294+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
290295

291296
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
292297

@@ -362,6 +367,7 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
362367
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
363368
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
364369
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
370+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
365371
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
366372

367373
---
@@ -409,8 +415,9 @@ This metric is optional.
409415
| [`user_agent.synthetic.type`](/docs/registry/attributes/user-agent.md) | string | Specifies the category of synthetic traffic, such as tests or bots. [10] | `bot`; `test` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
410416

411417
**[1] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
412-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
413-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
418+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
419+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
420+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
414421

415422
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
416423

@@ -486,6 +493,7 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin
486493
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
487494
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
488495
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
496+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
489497
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
490498

491499
---
@@ -538,8 +546,9 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
538546
| [`url.template`](/docs/registry/attributes/url.md) | string | The low-cardinality template of an [absolute path reference](https://www.rfc-editor.org/rfc/rfc3986#section-4.2). [8] | `/users/{id}`; `/users/:id`; `/users?id={id}` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
539547

540548
**[1] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
541-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
542-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
549+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
550+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
551+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
543552

544553
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
545554

@@ -614,6 +623,7 @@ If the request has completed successfully, instrumentations SHOULD NOT set `erro
614623
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
615624
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
616625
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
626+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
617627
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
618628

619629
<!-- markdownlint-restore -->
@@ -651,8 +661,9 @@ This metric is optional.
651661
| [`url.scheme`](/docs/registry/attributes/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https` | `Opt-In` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
652662

653663
**[1] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
654-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
655-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
664+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
665+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
666+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
656667

657668
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
658669

@@ -727,6 +738,7 @@ If the request has completed successfully, instrumentations SHOULD NOT set `erro
727738
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
728739
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
729740
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
741+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
730742
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
731743

732744
<!-- markdownlint-restore -->
@@ -764,8 +776,9 @@ This metric is optional.
764776
| [`url.scheme`](/docs/registry/attributes/url.md) | string | The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. | `http`; `https` | `Opt-In` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
765777

766778
**[1] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
767-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
768-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
779+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
780+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
781+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
769782

770783
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
771784

@@ -840,6 +853,7 @@ If the request has completed successfully, instrumentations SHOULD NOT set `erro
840853
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
841854
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
842855
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
856+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
843857
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
844858

845859
<!-- markdownlint-restore -->
@@ -971,8 +985,9 @@ In all other cases, `server.port` SHOULD match the port component of the
971985
**[3] `url.template`:** The `url.template` MUST have low cardinality. It is not usually available on HTTP clients, but may be known by the application or specialized HTTP instrumentation.
972986

973987
**[4] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
974-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
975-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
988+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
989+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
990+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
976991

977992
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
978993

@@ -1000,6 +1015,7 @@ Tracing instrumentations that do so, MUST also set `http.request.method_original
10001015
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
10011016
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
10021017
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
1018+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
10031019
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
10041020

10051021
<!-- markdownlint-restore -->

‎docs/http/http-spans.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,9 @@ There are two ways HTTP client spans can be implemented in an instrumentation:
171171
| [`user_agent.synthetic.type`](/docs/registry/attributes/user-agent.md) | string | Specifies the category of synthetic traffic, such as tests or bots. [15] | `bot`; `test` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
172172

173173
**[1] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
174-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
175-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
174+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
175+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
176+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
176177

177178
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
178179

@@ -320,6 +321,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
320321
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
321322
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
322323
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
324+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
323325
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
324326

325327
---
@@ -472,8 +474,9 @@ This span represents an inbound HTTP request.
472474
| [`user_agent.synthetic.type`](/docs/registry/attributes/user-agent.md) | string | Specifies the category of synthetic traffic, such as tests or bots. [18] | `bot`; `test` | `Opt-In` | ![Development](https://img.shields.io/badge/-development-blue) |
473475

474476
**[1] `http.request.method`:** HTTP request method value SHOULD be "known" to the instrumentation.
475-
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods)
476-
and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html).
477+
By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods),
478+
the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html)
479+
and the QUERY method defined in [httpbis-safe-method-w-body](https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/?include_text=1).
477480

478481
If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`.
479482

@@ -614,6 +617,7 @@ and SHOULD be provided **at span creation time** (if provided at all):
614617
| `PATCH` | PATCH method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
615618
| `POST` | POST method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
616619
| `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
620+
| `QUERY` | QUERY method. | ![Development](https://img.shields.io/badge/-development-blue) |
617621
| `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
618622

619623
---

0 commit comments

Comments
 (0)