github-personal/firezone
1
0
Fork 0
mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(telemetry): don't embed errors values in telemetry_event! (#7366)

Browse Source 
Due to https://github.com/getsentry/sentry-rust/issues/702, errors which
are embedded as `tracing::Value` unfortunately get silently discarded
when reported as part of Sentry "Event"s and not "Exception"s.

The design idea of these telemetry events is that they aren't fatal
errors so we don't need to treat them with the highest priority. They
may also appear quite often, so to save performance and bandwidth, we
sample them at a rate of 1% at creation time.

In order to not lose the context of these errors, we instead format them
into the message. This makes them completely identical to the `debug!`
logs which we have on every call-site of `telemetry_event!` which
prompted me to make that implicit as part of creating the
`telemetry_event!`.

Resolves: #7343.
This commit is contained in:
Thomas Eizinger
2024-11-18 18:17:08 +00:00
committed by GitHub
parent 24f7ba530d
commit de35bb067e
10 changed files with 30 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
rust/gateway/src/eventloop.rs
View File

@@ -5,7 +5,7 @@ use connlib_model::{ClientId, ResourceId};
#[cfg(not(target_os = "windows"))]
use dns_lookup::{AddrInfoHints, AddrInfoIter, LookupError};
use firezone_logging::{
anyhow_dyn_err, err_with_sources, std_dyn_err, telemetry_event, telemetry_span,
anyhow_dyn_err, err_with_src, std_dyn_err, telemetry_event, telemetry_span,
};
use firezone_tunnel::messages::gateway::{
AllowAccess, ClientIceCandidates, ClientsIceCandidates, ConnectionReady, EgressMessages,
@@ -80,8 +80,7 @@ impl Eventloop {
continue;
}
Poll::Ready(Err(e)) => {
tracing::debug!("Tunnel error: {}", err_with_sources(&e));
telemetry_event!(error = std_dyn_err(&e), "Tunnel error");
telemetry_event!("Tunnel error: {}", err_with_src(&e));
continue;
}
Poll::Pending => {}
@@ -355,7 +354,7 @@ impl Eventloop {
req: RequestConnection,
) {
let addresses = result
.inspect_err(|e| tracing::debug!(client = %req.client.id, reference = %req.reference, "DNS resolution timed out as part of connection request: {}", err_with_sources(e)))
.inspect_err(|e| tracing::debug!(client = %req.client.id, reference = %req.reference, "DNS resolution timed out as part of connection request: {}", err_with_src(e)))
.unwrap_or_default();
let answer = match self.tunnel.state_mut().accept(
@@ -411,7 +410,7 @@ impl Eventloop {
pub fn allow_access(&mut self, result: Result<Vec<IpAddr>, Timeout>, req: AllowAccess) {
let addresses = result
.inspect_err(|e| tracing::debug!(client = %req.client_id, reference = %req.reference, "DNS resolution timed out as part of allow access request: {}", err_with_sources(e)))
.inspect_err(|e| tracing::debug!(client = %req.client_id, reference = %req.reference, "DNS resolution timed out as part of allow access request: {}", err_with_src(e)))
.unwrap_or_default();
if let Err(e) = self.tunnel.state_mut().allow_access(
@@ -435,7 +434,7 @@ impl Eventloop {
name: DomainName,
) {
let addresses = result
.inspect_err(|e| tracing::debug!(%conn_id, "DNS resolution timed out as part of allow access request: {}", err_with_sources(e)))
.inspect_err(|e| tracing::debug!(%conn_id, "DNS resolution timed out as part of allow access request: {}", err_with_src(e)))
.unwrap_or_default();
self.tunnel.state_mut().refresh_translation(