Add tracing #1100
Merged
Add tracing #1100
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
ka3de
force-pushed
the
feat/tracing
branch
7 times, most recently
from
37a5123
to
f635676
Compare
ka3de
commented
Nov 17, 2023
inancgumus
previously approved these changes
Nov 21, 2023
ankur22
previously approved these changes
Nov 29, 2023
This was referenced Dec 4, 2023
I knew I have read this question somewhere but missed to answer it @ankur22. |
This package provides high level tracing APIs tailored to k6 browser needs, defining methods that allow to correlate async events with the pages to which they belong to.
Adds a new traces registry which will hold the references for every iteration root span and wrapping context. This span will be extended for every instrumented method call during the iteration execution.
The traces registry has to be held per VU scope, as it stores traces indexed per iteration, which are only unique per VU. Therefore keep it under browser registry so we can use it to handle traces generation based on iter events. Because VU.State is nil when the browser registry is initialized, we have to initialize the traces registry on the first VU iteration so we can get access to the k6 TracerProvider. This is done within a sync.Once so we ensure the traces registry is only initialized once per VU.
This also sets the trace context, wrapping the iteration's root span, as the context for browser, which will be inherited by the other components such as browser context, page, etc.
Only stop the traces registry if it has been previously initialized, which won't happen for the initial VU. When stopping, ensure any active live span is ended before exiting.
This is so the tracer can be retrieved by the other components which inherit the browser context (BrowserContext, Page, etc) and use it to generate spans that represent their actions.
Generate a span that represents a WebVital measurement.
ka3de
force-pushed
the
feat/tracing
branch
2 times, most recently
from
25eebcf
to
f4cdfc8
Compare
Defines a tracer interface with only the methods required for the common package tracing. This also allows us to implement higher level helper functions that will automatically retrieve the Tracer from a given context and use it to generate a span, or return a noop span if no tracer is found in the context, avoiding a possible NPE.
This functions will try to call the same method they implement from the tracer contained in the given context. If the tracer is not found in the context, they return a noop Span. This makes the code in the common package cleaner and avoids dealing with possible NPEs. At the sime time avoids having to mock the tracer in tests.
Allows to set a specific TracerProvider for the test VU implementation. If not set, it defaults to NoopTracerProvider.
Reduces nested levels.
Modifies the browser registry constructor to accept a context that will be used in order to build the browser context which will eventually be inherited by the other browser components.
|
Squashed fixup commits, rebased on top of main to resolve conflict on |
inancgumus
approved these changes
Dec 11, 2023
This was referenced Dec 14, 2023
Merged
5 tasks
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.
What?
This PR uses the tracing instrumentation provided by k6 through the
VU.Statein order to generate traces that represent the inner workings of k6 browser.Why?
Tracing has been chosen as the best suited method in order to build a timeline view of a k6 browser test, which can provide a more visual representation of a browser test along with the metrics associated for each action, such as specific WebVitals measurements per navigation, errors produced, etc.
Checklist
Related PR(s)/Issue(s)
Related: grafana/k6#3445