Verified Commit f3e040bb authored by WofWca's avatar WofWca Committed by Cecylia Bocovich
Browse files

improvement: less scary failed conn logs & metrics 

...and adjust the `totalFailedConnections` metric name
and description.

This commit should make the periodic stats log messages
and the relevant metric look less scary to users:
P2P connection failures are relatively frequent and are usually
not indicative of the proxy operator having done something wrong.
So let's tone the wording down.

See the discussion: !516 (comment 3173677).
parent f715c397

common/event/interface.go

+2 −2
Changes for common/event/interface.go: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -108,8 +108,8 @@ type EventOnProxyStats struct { 
}



func (e EventOnProxyStats) String() string {

	statString := fmt.Sprintf("In the last %v, there were %v completed successful connections. %v connections failed to establish. Traffic Relayed ↓ %v %v (%.2f %v%s), ↑ %v %v (%.2f %v%s).",

		e.SummaryInterval.String(), e.ConnectionCount, e.FailedConnectionCount,

	statString := fmt.Sprintf("In the last %v, there were %v completed successful connections. Traffic Relayed ↓ %v %v (%.2f %v%s), ↑ %v %v (%.2f %v%s).",

		e.SummaryInterval.String(), e.ConnectionCount,

		e.InboundBytes, e.InboundUnit, float64(e.InboundBytes)/e.SummaryInterval.Seconds(), e.InboundUnit, "/s",

		e.OutboundBytes, e.OutboundUnit, float64(e.OutboundBytes)/e.SummaryInterval.Seconds(), e.OutboundUnit, "/s")

	return statString

proxy/lib/metrics.go

+2 −2
Changes for proxy/lib/metrics.go: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -30,8 +30,8 @@ func NewMetrics() *Metrics { 
		),

		totalFailedConnections: prometheus.NewCounter(prometheus.CounterOpts{

			Namespace: metricNamespace,

			Name:      "failed_connections_total",

			Help:      "The total number of client connection attempts that failed after successful rendezvous",

			Name:      "connection_timeouts_total",

			Help:      "The total number of client connection attempts that failed after successful rendezvous. Note that failures can occur for reasons outside of the proxy's control, such as the client's NAT and censorship situation.",

		}),

		totalInBoundTraffic: prometheus.NewCounter(prometheus.CounterOpts{

			Namespace: metricNamespace,