mirror of
https://github.com/tokio-rs/tracing.git
synced 2025-09-29 22:10:38 +00:00
2520f97964
## Motivation As discussed in #308, there are a large number of crates in this repository, which can be confusing for users and can increase the maintainance burden for maintainers. Also, the `tracing-fmt` and `tracing-subscriber` crates both contain filtering implementations with similar behaviour and APIs, but `tracing-subscriber`'s filter module offers more advanced features (filtering on field values), and is usable with any subscriber implementation. Two separate filter implementations also has the potential to be confusing for users. ## Solution This branch moves most of the code from `tracing-fmt` into a module in `tracing-subscriber`, and changes the `tracing-fmt` builder APIs to use the `Filter` type in `tracing-subscriber`. The `tracing-subscriber/fmt` feature flag can be used to disable the formatting subscriber when it is not used. The `tracing-fmt` crate has been updated to re-export the APIs from `tracing-subscriber`, and marked as deprecated. Once we've published a new version of `tracing-subscriber` with the format APIs, we can publish a final release of `tracing-fmt` that will update the documentation & mark all APIs as deprecated, so that users know to move to the `tracing-subscriber` crate. Refs: #308 Signed-off-by: Eliza Weisman <eliza@buoyant.io>
121 lines
4.2 KiB
Rust
121 lines
4.2 KiB
Rust
//! A "hello world" echo server [from Tokio][echo-example]
|
|
//!
|
|
//! This server will create a TCP listener, accept connections in a loop, and
|
|
//! write back everything that's read off of each TCP connection.
|
|
//!
|
|
//! Because the Tokio runtime uses a thread pool, each TCP connection is
|
|
//! processed concurrently with all other TCP connections across multiple
|
|
//! threads.
|
|
//!
|
|
//! To see this server in action, you can run this in one terminal:
|
|
//!
|
|
//! cargo +nightly run --example echo
|
|
//!
|
|
//! and in another terminal you can run:
|
|
//!
|
|
//! nc localhost 3000
|
|
//!
|
|
//! Each line you type in to the `netcat` terminal should be echo'd back to
|
|
//! you! If you open up multiple terminals with `netcat` instances connected
|
|
//! to the same address you should be able to see them all make progress simultaneously.
|
|
//!
|
|
//! [echo-example]: https://github.com/tokio-rs/tokio/blob/master/tokio/examples/echo.rs
|
|
|
|
#![warn(rust_2018_idioms)]
|
|
|
|
use futures::future::{FutureExt, TryFutureExt};
|
|
use tokio;
|
|
use tokio::io::{AsyncReadExt, AsyncWriteExt};
|
|
use tokio::net::TcpListener;
|
|
|
|
use std::env;
|
|
use std::error::Error;
|
|
use std::net::SocketAddr;
|
|
|
|
use tracing::{debug, info, info_span, trace_span, warn};
|
|
use tracing_futures::Instrument;
|
|
|
|
#[tokio::main]
|
|
async fn main() -> Result<(), Box<dyn Error>> {
|
|
let subscriber = tracing_subscriber::fmt::Subscriber::builder()
|
|
.with_filter("echo=trace")
|
|
.finish();
|
|
tracing::subscriber::set_global_default(subscriber)?;
|
|
|
|
// Allow passing an address to listen on as the first argument of this
|
|
// program, but otherwise we'll just set up our TCP listener on
|
|
// 127.0.0.1:8080 for connections.
|
|
let addr = env::args().nth(1).unwrap_or("127.0.0.1:3000".to_string());
|
|
let addr = addr.parse::<SocketAddr>()?;
|
|
|
|
// Next up we create a TCP listener which will listen for incoming
|
|
// connections. This TCP listener is bound to the address we determined
|
|
// above and must be associated with an event loop.
|
|
let mut listener = TcpListener::bind(&addr).await?;
|
|
// Use `fmt::Debug` impl for `addr` using the `%` sybmol
|
|
info!(message = "Listening on", %addr);
|
|
|
|
loop {
|
|
// Asynchronously wait for an inbound socket.
|
|
let (mut socket, peer_addr) = listener.accept().await?;
|
|
|
|
info!(message = "Got connection from", %peer_addr);
|
|
|
|
// And this is where much of the magic of this server happens. We
|
|
// crucially want all clients to make progress concurrently, rather than
|
|
// blocking one on completion of another. To achieve this we use the
|
|
// `tokio::spawn` function to execute the work in the background.
|
|
//
|
|
// Essentially here we're executing a new task to run concurrently,
|
|
// which will allow all of our clients to be processed concurrently.
|
|
|
|
tokio::spawn(async move {
|
|
let mut buf = [0; 1024];
|
|
|
|
// In a loop, read data from the socket and write the data back.
|
|
loop {
|
|
let n: usize = socket
|
|
.read(&mut buf)
|
|
.map(|bytes| {
|
|
if let Ok(n) = bytes {
|
|
debug!(bytes_read = n);
|
|
}
|
|
|
|
bytes
|
|
})
|
|
.map_err(|error| {
|
|
warn!(%error);
|
|
error
|
|
})
|
|
.instrument(trace_span!("read"))
|
|
.await
|
|
.expect("failed to read data from socket");
|
|
|
|
if n == 0 {
|
|
return;
|
|
}
|
|
|
|
socket
|
|
.write_all(&buf[0..n])
|
|
.map(|bytes| {
|
|
if let Ok(()) = bytes {
|
|
debug!(bytes_written = n);
|
|
}
|
|
|
|
bytes
|
|
})
|
|
.map_err(|error| {
|
|
warn!(%error);
|
|
error
|
|
})
|
|
.instrument(trace_span!("write"))
|
|
.await
|
|
.expect("failed to write data to socket");
|
|
|
|
info!(message = "echo'd data", %peer_addr, size = n);
|
|
}
|
|
})
|
|
.instrument(info_span!("echo", %peer_addr));
|
|
}
|
|
}
|