Add tracing instrumentation release notes #3477
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## release-notes-v0.48.0 #3477 +/- ##
========================================================
Coverage ? 73.28%
========================================================
Files ? 264
Lines ? 19960
Branches ? 0
========================================================
Hits ? 14628
Misses ? 4418
Partials ? 914
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| Where `opt`s can be one of the following options: | ||
| * `proto`: Specifies the protocol to use in the connection to the traces backend. Supports `grpc` *(default)* and `http`. | ||
| * `header.<header_name>`: Specifies an additional header to include in the connection to the traces backend. | ||
|
|
||
| Example: | ||
| ``` | ||
| K6_TRACES_OUTPUT=https://traces.k6.io/v1/traces,proto=http,header.Authorization=Bearer token | ||
| ``` |
There was a problem hiding this comment.
I would like to replace it with just a link to the documentation.
There was a problem hiding this comment.
If we want to link to the documentation, then I would say we should remove the last part since:
The format for the otel traces output configuration is the following:
...
Otherwise mentioning the format without mentioning the details in the release notes might not be the best. In any case, for me it's always tricky to decide what is included in the release notes and what is left for documentation. In this case I think the content is not so long so it can be included directly in the release notes, without requiring our users to go to the docs, but no strong opinion.
There was a problem hiding this comment.
Let's merge this, and we could give a final round of the review in the #3458
|
@ka3de not sure how actively we should promote this option, but at least shortly, maybe we need to mention a PR for the k6-docs. See an example grafana/k6-docs#1417 |
There is a PR already, see grafana/k6-docs#1433. I'm waiting for some more reviews, but otherwise I will merge it on Monday morning max. |
|
My bad, missed that 👍 |
What?
Adds the release notes corresponding to the base tracing instrumentation implemented in #3445.
Why?
In order to reflect this new feature in the upcoming v0.48.0 release notes.
Checklist
make lint) and all checks pass. (N/A)make tests) and all tests pass. (N/A)