awslabs / awslabs/shuttle

[TRACING] Improved testing of tracing functionality

Open
#130 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
1.1k
Forks
59
Avg merge
4d 2h
Merged PRs (30d)
15

Description

See https://github.com/awslabs/shuttle/pull/128, in particular: https://github.com/awslabs/shuttle/pull/128#discussion_r1419144606.

Resolving this will involve:
1. Creating a custom tracing `Subscriber` which checks the traces emitted by the tests in `tracing.rs` (and optionally elsewhere).
2. Un-`#[ignore]`-ing the tests in `tracing.rs`.
3. Make the tests in `tracing.rs` always enable some `LevelFilter` (as in: overwriting the level set by `RUST_LOG`). Bonus points for making the tests try all different `LevelFilter`s.
4. [OPTIONAL] Add more tests.

Contributor guide

Open the contributing guide

Research direction

Start by reading the discussion on PR 128 and the tests in tracing.rs. Create the custom tracing Subscriber described there, remove the #[ignore] markers, and ensure the tests override RUST_LOG with a LevelFilter. Done means the tracing tests run reliably and check the traces they emit.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
observability-sre, testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.