Skip to content

chore: clean up docs, drop obsolete tokio_unstable references, and widen CI triggers#2

Merged
mattwend merged 3 commits intov0.x.xfrom
fix/prepare_release
Apr 26, 2026
Merged

chore: clean up docs, drop obsolete tokio_unstable references, and widen CI triggers#2
mattwend merged 3 commits intov0.x.xfrom
fix/prepare_release

Conversation

@mattwend
Copy link
Copy Markdown
Owner

What changed

Documentation (README.md, src/lib.rs)

  • Rewrite README for clearer quick-start, configuration, and feature-flag guidance
  • Document TelemetryGuard lifetime, explicit vs best-effort shutdown, and multi-thread vs
    current-thread drop behavior
  • Clarify Tokio metrics prerequisites when OTLP is and is not enabled

Code (src/tokio_metrics.rs)

  • Remove obsolete tokio_unstable cfg gate references from comments — the crate no longer
    requires the flag

CI (.github/workflows/ci.yml)

  • Remove branch restriction on push-triggered CI so all branches run the pipeline

Clarify that tokio runtime metrics are recorded through the
OpenTelemetry global meter and document the no-op behavior when no meter
provider is installed.

Also make OTLP endpoint suffix detection stricter to avoid false matches
on unrelated paths, update the 0.1.0 changelog date, and slightly reduce
log-control test port allocation races before the initial release.
Tokio 1.52 already provides the runtime metrics used by this crate on
stable, so requiring consumers and CI to compile with --cfg tokio_unstable
was unnecessary.

Remove the outdated prerequisite from crate docs, README, and CI while
keeping the real requirement documented: tokio-metrics still needs an
installed OpenTelemetry meter provider to emit anything.
@mattwend mattwend self-assigned this Apr 26, 2026
@codecov-commenter
Copy link
Copy Markdown

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@mattwend mattwend merged commit 68b2e71 into v0.x.x Apr 26, 2026
5 checks passed
@mattwend mattwend deleted the fix/prepare_release branch April 26, 2026 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants