typelevel / typelevel/cats-effect
Tracing mode JVM parameter changed without notice in `3.2.0`
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 2.2k
- Forks
- 576
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 18
Description
The configuration to control tracing mode was changed in 3.2.0. Specifically in f1c5e8df8d894f3c2268acb1a1a8bba63291126c of #2147. This wasn't really highlighted in the release notes at all, only being mentioned indirectly.
cats.effect.stackTracingMode -> cats.effect.tracing.mode
I'd be surprised if I am the only person who had missed this. Is there a reason this can't be made backwards compatible at all? And/or potentially a warning on boot if the old flag is detected?
I mentioned this on discord and was asked to open an issue! Thanks!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the 3.2.0 release notes, commit f1c5e8df8d894f3c2268acb1a1a8bba63291126c, and issue #2147. Compare handling of cats.effect.stackTracingMode and cats.effect.tracing.mode, then determine whether compatibility or a startup warning is feasible. Done means the chosen behavior is implemented and the parameter change is clearly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- observability
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100