Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include server address in server error logs #2500

Merged
merged 1 commit into from
Nov 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions linkerd/app/admin/src/stack.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ use linkerd_app_core::{
serve,
svc::{self, ExtractParam, InsertParam, Param},
tls, trace,
transport::{self, listen::Bind, ClientAddr, Local, OrigDstAddr, Remote, ServerAddr},
transport::{
self, addrs::AddrPair, listen::Bind, ClientAddr, Local, OrigDstAddr, Remote, ServerAddr,
},
Error, Result,
};
use linkerd_app_inbound as inbound;
Expand Down Expand Up @@ -84,7 +86,9 @@ impl Config {
where
R: FmtMetrics + Clone + Send + Sync + Unpin + 'static,
B: Bind<ServerConfig>,
B::Addrs: svc::Param<Remote<ClientAddr>> + svc::Param<Local<ServerAddr>>,
B::Addrs: svc::Param<Remote<ClientAddr>>,
B::Addrs: svc::Param<Local<ServerAddr>>,
B::Addrs: svc::Param<AddrPair>,
{
let (listen_addr, listen) = bind.bind(&self.server)?;

Expand Down Expand Up @@ -202,6 +206,14 @@ impl Param<Remote<ClientAddr>> for Http {
}
}

impl Param<AddrPair> for Http {
fn param(&self) -> AddrPair {
let Remote(client) = self.tcp.client;
let Local(server) = self.tcp.addr;
AddrPair(client, server)
}
}

impl Param<tls::ConditionalServerTls> for Http {
fn param(&self) -> tls::ConditionalServerTls {
self.tcp.tls.clone()
Expand Down
22 changes: 16 additions & 6 deletions linkerd/app/core/src/serve.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
use crate::{
io, is_caused_by,
svc::{self, Param},
transport::{ClientAddr, Remote},
Result,
};
use futures::prelude::*;
use linkerd_error::Error;
use linkerd_proxy_transport::AddrPair;
use tower::util::ServiceExt;
use tracing::{debug, debug_span, info, instrument::Instrument, warn};

Expand All @@ -18,7 +18,7 @@ pub async fn serve<M, S, I, A>(
shutdown: impl Future,
) where
I: Send + 'static,
A: Param<Remote<ClientAddr>>,
A: Param<AddrPair>,
M: svc::NewService<A, Service = S>,
S: tower::Service<io::ScopedIo<I>, Response = ()> + Send + 'static,
S::Error: Into<Error>,
Expand All @@ -40,8 +40,8 @@ pub async fn serve<M, S, I, A>(
};

// The local addr should be instrumented from the listener's context.
let Remote(ClientAddr(client_addr)) = addrs.param();
let span = debug_span!("accept", client.addr = %client_addr).entered();
let AddrPair(client_addr, server_addr) = addrs.param();
let span = debug_span!("accept", client.addr = %client_addr, server.addr = %server_addr).entered();
let accept = new_accept.new_service(addrs);

// Dispatch all of the work for a given connection onto a
Expand All @@ -57,10 +57,20 @@ pub async fn serve<M, S, I, A>(
{
Ok(()) => debug!("Connection closed"),
Err(reason) if is_caused_by::<std::io::Error>(&*reason) => {
debug!(%reason, "Connection closed")
debug!(
reason,
client.addr = %client_addr,
server.addr = %server_addr,
"Connection closed"
);
}
Err(error) => {
info!(error, client.addr = %client_addr, "Connection closed")
info!(
error,
client.addr = %client_addr,
server.addr = %server_addr,
"Connection closed"
);
}
}
// Hold the service until the connection is complete. This
Expand Down
7 changes: 5 additions & 2 deletions linkerd/app/inbound/src/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use linkerd_app_core::{
io, profiles,
proxy::http,
serve, svc,
transport::{self, ClientAddr, Local, OrigDstAddr, Remote, ServerAddr},
transport::{self, addrs::*},
Error, Result,
};
use std::{fmt::Debug, sync::Arc};
Expand Down Expand Up @@ -43,7 +43,10 @@ impl Inbound<()> {
profiles: P,
gateway: G,
) where
A: svc::Param<Remote<ClientAddr>> + svc::Param<OrigDstAddr> + Clone + Send + Sync + 'static,
A: svc::Param<Remote<ClientAddr>>,
A: svc::Param<OrigDstAddr>,
A: svc::Param<AddrPair>,
A: Clone + Send + Sync + 'static,
I: io::AsyncRead + io::AsyncWrite + io::Peek + io::PeerAddr,
I: Debug + Unpin + Send + Sync + 'static,
G: svc::NewService<direct::GatewayTransportHeader, Service = GSvc>,
Expand Down
2 changes: 1 addition & 1 deletion linkerd/app/outbound/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ impl Outbound<()> {
resolve: R,
) where
// Target describing a server-side connection.
T: svc::Param<Remote<ClientAddr>>,
T: svc::Param<AddrPair>,
T: svc::Param<OrigDstAddr>,
T: Clone + Send + Sync + 'static,
// Server-side socket.
Expand Down
14 changes: 10 additions & 4 deletions linkerd/app/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ use linkerd_app_core::{
metrics::FmtMetrics,
svc::Param,
telemetry,
transport::{listen::Bind, ClientAddr, Local, OrigDstAddr, Remote, ServerAddr},
transport::{addrs::*, listen::Bind},
Error, ProxyRuntime,
};
use linkerd_app_gateway as gateway;
Expand Down Expand Up @@ -102,11 +102,17 @@ impl Config {
) -> Result<App, Error>
where
BIn: Bind<ServerConfig> + 'static,
BIn::Addrs: Param<Remote<ClientAddr>> + Param<Local<ServerAddr>> + Param<OrigDstAddr>,
BIn::Addrs: Param<Remote<ClientAddr>>
+ Param<Local<ServerAddr>>
+ Param<OrigDstAddr>
+ Param<AddrPair>,
BOut: Bind<ServerConfig> + 'static,
BOut::Addrs: Param<Remote<ClientAddr>> + Param<Local<ServerAddr>> + Param<OrigDstAddr>,
BOut::Addrs: Param<Remote<ClientAddr>>
+ Param<Local<ServerAddr>>
+ Param<OrigDstAddr>
+ Param<AddrPair>,
BAdmin: Bind<ServerConfig> + Clone + 'static,
BAdmin::Addrs: Param<Remote<ClientAddr>> + Param<Local<ServerAddr>>,
BAdmin::Addrs: Param<Remote<ClientAddr>> + Param<Local<ServerAddr>> + Param<AddrPair>,
{
let Config {
admin,
Expand Down
3 changes: 2 additions & 1 deletion linkerd/app/src/tap.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use linkerd_app_core::{
serve,
svc::{self, ExtractParam, InsertParam, Param},
tls,
transport::{listen::Bind, ClientAddr, Local, Remote, ServerAddr},
transport::{addrs::AddrPair, listen::Bind, ClientAddr, Local, Remote, ServerAddr},
Error,
};
use std::{collections::HashSet, pin::Pin};
Expand Down Expand Up @@ -47,6 +47,7 @@ impl Config {
where
B: Bind<ServerConfig>,
B::Addrs: Param<Remote<ClientAddr>>,
B::Addrs: Param<AddrPair>,
{
let (registry, server) = tap::new();
match self {
Expand Down
4 changes: 4 additions & 0 deletions linkerd/proxy/transport/src/addrs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ pub struct Local<T>(pub T);
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub struct Remote<T>(pub T);

/// Describes a connection from a client to a server.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub struct AddrPair(pub ClientAddr, pub ServerAddr);

// === impl ClientAddr ===

impl std::ops::Deref for ClientAddr {
Expand Down
2 changes: 1 addition & 1 deletion linkerd/proxy/transport/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ pub mod listen;
pub mod orig_dst;

pub use self::{
addrs::{ClientAddr, ListenAddr, Local, OrigDstAddr, Remote, ServerAddr},
addrs::{AddrPair, ClientAddr, ListenAddr, Local, OrigDstAddr, Remote, ServerAddr},
connect::ConnectTcp,
listen::{Bind, BindTcp},
orig_dst::BindWithOrigDst,
Expand Down
9 changes: 9 additions & 0 deletions linkerd/proxy/transport/src/listen.rs
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,12 @@ impl Param<Local<ServerAddr>> for Addrs {
self.server
}
}

impl Param<AddrPair> for Addrs {
#[inline]
fn param(&self) -> AddrPair {
let Remote(client) = self.client;
let Local(server) = self.server;
AddrPair(client, server)
}
}
13 changes: 13 additions & 0 deletions linkerd/proxy/transport/src/orig_dst.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ pub struct Addrs<A = listen::Addrs> {
// === impl Addrs ===

impl<A> Param<OrigDstAddr> for Addrs<A> {
#[inline]
fn param(&self) -> OrigDstAddr {
self.orig_dst
}
Expand All @@ -32,11 +33,23 @@ impl<A> Param<Remote<ClientAddr>> for Addrs<A>
where
A: Param<Remote<ClientAddr>>,
{
#[inline]
fn param(&self) -> Remote<ClientAddr> {
self.inner.param()
}
}

impl<A> Param<AddrPair> for Addrs<A>
where
A: Param<Remote<ClientAddr>>,
{
#[inline]
fn param(&self) -> AddrPair {
let Remote(client) = self.inner.param();
AddrPair(client, ServerAddr(self.orig_dst.into()))
}
}

impl<A> Param<Local<ServerAddr>> for Addrs<A>
where
A: Param<Local<ServerAddr>>,
Expand Down