Add a reporter that emits test-related Open Telemetry spans. #2087
Conversation
This file contains hidden or 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
This commit introduces a variant of the Check reporter that records Open Telemetry traces for package tests. At present it records a parent span for each context/file and child spans for each test case. Span attributes are drawn from the semantic conventions [0]. It also makes some effort to work out the package's GitHub URL so that we can set VCS-related attributes. Note that this uses the existing session API from the `otel` package to allow parallel testing, but this API has known issues. Basic unit tests are included. [0]: https://opentelemetry.io/docs/specs/semconv/registry/attributes/test/ Signed-off-by: Aaron Jacobs <aaron.jacobs@posit.co>
|
Would it make sense to support telemetry in the already existing reporters? |
|
Yeah, I think that's an alternative, but it might require deeper changes to the package to enable. Having a standalone reporter seemed like the least invasive route. |
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.
This commit introduces a variant of the Check reporter that records Open Telemetry traces for package tests. At present it records a parent span for each context/file and child spans for each test case.
Span attributes are drawn from the semantic conventions.
Here is what it looks like running a part of
testthat's own test suite and sending traces to Logfire:It also makes some effort to work out the package's GitHub URL so that we can set VCS-related attributes. This is what allows the
Open in GitHubbutton shown in Logfire to work:Note that this uses the existing session API from theotelpackage to allow parallel testing, but this API has known issues.Basic unit tests are included.