k6/execution: Add metadata JS API #3037
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A bare minimum API to set and get metadata set for the whole VU. It is added on top of the vu property and on top of a new `metrics` one so. If `k6/execution` is imported as `exec` - `exec.vu.metrics.metadata["foo"]` will get you the currently set metadata for `foo` the same way `exec.vu.tags["bar"]` will get you the value of the tag `bar`. Setting metadata is the same. It also adds `exec.vu.metrics.tags` which is the same as `exec.vu.tags` for consistency. While leaving the old one for backwards compatibility. This also includes dropping the ability to list metadata keys and values from `exec.vu.tags`. This was likely left in by mistake. This is a breaking change due to the fact that before that `iter` and `vu` could've been accessed this way but this will now need to be done through the new `exec.vu.metrics.metadata`. Closes #2766
mstoykov
requested review from
olegbespalov and
imiric
and removed request for
olegbespalov
Co-authored-by: Ivan <[email protected]>
|
note: I will just squash at the end |
Codecov Report
@@ Coverage Diff @@
## master #3037 +/- ##
=======================================
Coverage 77.04% 77.05%
=======================================
Files 229 229
Lines 17065 17107 +42
=======================================
+ Hits 13147 13181 +34
- Misses 3077 3084 +7
- Partials 841 842 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
imiric
reviewed
May 8, 2023
js/modules/k6/execution/execution.go
Outdated
Comment on lines
222
to
225
| }) | ||
| err = o.Set("tags", tagsDynamicObject) | ||
|
|
||
| if err != nil { |
There was a problem hiding this comment.
Suggested change
| }) | |
| err = o.Set("tags", tagsDynamicObject) | |
| if err != nil { | |
| }) | |
| // This is kept for backwards compatibility reasons, but should be deprecated, | |
| // since tags are also accessible via vu.metrics.tags. | |
| err = o.Set("tags", tagsDynamicObject) | |
| if err != nil { |
Also, should we add a deprecation warning when this is first used?
There was a problem hiding this comment.
I would prefer to add an issue to discuss if we even want to deprecate it 🤷
Co-authored-by: Ivan Mirić <[email protected]>
imiric
approved these changes
May 9, 2023
codebien
approved these changes
May 9, 2023
mstoykov
added
the
documentation-needed
|
documented in grafana/k6-docs#1207 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A bare minimum API to set and get metadata set for the whole VU.
It is added on top of the vu property and on top of a new
metricsone so. Ifk6/executionis imported asexec-exec.vu.metrics.metadata["foo"]will get you the currently set metadata forfoothe same wayexec.vu.tags["bar"]will get you the value of the tagbar.Setting metadata is the same.
It also adds
exec.vu.metrics.tagswhich is the same asexec.vu.tagsfor consistency. While leaving the old one for backwards compatibility.This also includes dropping the ability to list metadata keys and values from
exec.vu.tags. This was likely left in by mistake.This is a breaking change due to the fact that before that
iterandvucould've been accessed this way but this will now need to be done through the newexec.vu.metrics.metadata.Closes #2766