Documentation page for system properties

[RaasAhsan]

Since we're relying more and more on system properties to customize the behavior of IO, we should document them all in a dedicated doc page for discoverability.

[djspiewak]

Very much this

[i10416]

Any other properties?

• cats.effect.cancelation.check.threshold
• cats.effect.auto.yield.threshold.multiplier
• cats.effect.logNonDaemonThreadsOnExit
• cats.effect.logNonDaemonThreads.sleepIntervalMillis
• cats.effect.tracing.mode

series/3.x

• https://github.com/typelevel/cats-effect/blob/series/3.x/core/jvm/src/main/scala/cats/effect/unsafe/IORuntimeConfigCompanionPlatform.scala#L22
• https://github.com/typelevel/cats-effect/blob/series/3.x/core/jvm/src/main/scala/cats/effect/NonDaemonThreadLogger.scala#L28
• https://github.com/typelevel/cats-effect/blob/series/3.x/core/jvm/src/main/java/cats/effect/tracing/TracingConstants.java#L27

series/2.x

• ???

[vasilmkd]

cats.effect.tracing.exceptions.enhanced, cats.effect.tracing.buffer.size in https://github.com/typelevel/cats-effect/blob/series/3.x/core/jvm/src/main/scala/cats/effect/unsafe/IORuntimeConfigCompanionPlatform.scala

[i10416]

@vasilmkd Thank you.
I made PR to get todo list up-to-date #2398 and going to send another PR to add documentation. I'm considering putting a doc page for system property in "Scaling and Tuning" section. What do you think?

[vasilmkd]

Go for it @i10416.

[armanbilge]

We should also list the equivalent environmental variable names for the JS runtimes as well on this page, but only after they are released.