mirror of https://github.com/tokio-rs/tracing.git synced 2025-09-28 21:42:15 +00:00

History

Hayden Stainsby 5197803f23 mock: change helper functions to expect::<thing> (#2377 )

* mock: change helper functions to `expect::<thing>`

The current format of test expectations in `tracing-mock` isn't ideal.
The format `span::expect` requires importing `tracing_mock::<thing>` which
may conflict with imports from other tracing crates, especially
`tracing-core`.

So we change the order and move the functions into a module called
`expect` so that:
* `event::expect` becomes `expect::event`
* `span::expect` becomes `expect::span`
* `field::expect` becomes `expect::field`

This format has two advantages.
1. It reads as natural English, e.g "expect span"
2. It is no longer common to import the modules directly.

Regarding point (2), the following format was previously common:

```rust
use tracing_mock::field;

field::expect();
```

This import of the `field` module may then conflict with importing the
same from `tracing_core`, making it necessary to rename one of the
imports.

The same code would now be written:

```rust
use tracing_mock::expect;

expect::field();
```

Which is less likely to conflict.

This change also fixes an unused warning on `MockHandle::new` when the
`tracing-subscriber` feature is not enabled.

Refs: #539

2023-10-01 10:46:02 -07:00

src

mock: change helper functions to expect::<thing> (#2377 )

2023-10-01 10:46:02 -07:00

tests

mock: change helper functions to expect::<thing> (#2377 )

2023-10-01 10:46:02 -07:00

Cargo.toml

tracing, tracing-futures: instrument Future inside Drop (#2562 )

2023-04-21 16:59:51 -07:00

CHANGELOG.md

futures: prepare to release 0.2.5 (#1241 )

2021-02-16 13:16:26 -08:00

LICENSE

chore: Include the LICENSE in every crate (#842 )

2020-07-23 12:23:04 -07:00

README.md

subscriber: dim Compact targets, matching the default formatter (#2409 )

2023-04-21 16:59:51 -07:00

README.md

tracing-futures

Utilities for instrumenting futures-based code with tracing.

Documentation | Chat

Overview

tracing is a framework for instrumenting Rust programs to collect structured, event-based diagnostic information. This crate provides utilities for using tracing to instrument asynchronous code written using futures and async/await.

The crate provides the following traits:

Instrument allows a tracing span to be attached to a future, sink, stream, or executor.
WithSubscriber allows a tracing Subscriber to be attached to a future, sink, stream, or executor.

Compiler support: requires rustc 1.56+

Supported Rust Versions

Tracing is built against the latest stable release. The minimum supported version is 1.56. The current Tracing version is not guaranteed to build on Rust versions earlier than the minimum supported version.

Tracing follows the same compiler support policies as the rest of the Tokio project. The current stable Rust compiler and the three most recent minor versions before it will always be supported. For example, if the current stable compiler version is 1.69, the minimum supported version will not be increased past 1.66, three minor versions prior. Increasing the minimum supported compiler version is not considered a semver breaking change as long as doing so complies with this policy.

License

This project is licensed under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tracing by you, shall be licensed as MIT, without any additional terms or conditions.