[Merged by Bors] - api: add hole punching info and data transfer stats #5792
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #5792 +/- ##
========================================
Coverage 81.3% 81.4%
========================================
Files 296 297 +1
Lines 31667 31965 +298
========================================
+ Hits 25764 26036 +272
- Misses 4214 4231 +17
- Partials 1689 1698 +9 ☔ View full report in Codecov by Sentry. |
|
bors try |
tryBuild failed: |
|
Partition test flake: |
|
bors try |
tryBuild succeeded: |
ivan4th
force-pushed
the
feature/holepunch-info
branch
from
3934e9d to
c451fae
Compare
This includes connection kind (relay / hole punching information) and client/server request and transfer statistics.
ivan4th
changed the title
ivan4th
force-pushed
the
feature/holepunch-info
branch
from
d5317c3 to
88ed2e8
Compare
fasmat
reviewed
Jun 4, 2024
go.mod
Outdated
| @@ -38,7 +38,7 @@ require ( | |||
| github.com/rs/cors v1.11.0 | |||
| github.com/santhosh-tekuri/jsonschema/v5 v5.3.1 | |||
| github.com/seehuhn/mt19937 v1.0.0 | |||
| github.com/spacemeshos/api/release/go v1.42.0 | |||
| github.com/spacemeshos/api/release/go v1.42.1-0.20240530113900-b81297d5714c | |||
There was a problem hiding this comment.
The PR in the api repo needs to be merged first I assume?
There was a problem hiding this comment.
Yes, I planned to do so after I address all the other comments here
fasmat
reviewed
Jun 4, 2024
fasmat
approved these changes
Jun 13, 2024
There was a problem hiding this comment.
LGTM, remember to first merge and release spacemeshos/api#322 🙂
|
bors merge |
spacemesh-bors bot
pushed a commit
that referenced
this pull request
Jun 16, 2024
## Motivation Current `AdminService.PeerInfoStream` doesn't provide enough information about whether hole punching was used while connecting to a particular peer, and also doesn't reflect actual utilization of each peer, which makes it harder to see whether the peer connections are being used efficiently. Also, importantly, in case if `go-spacemesh` causes network overload it may be hard to find out what kind of traffic is causing the problems. It would be nice to have some overview of the traffic even in case if the metrics are disabled. The current data transfer rates should be easy to view even without any Prometheus to do `rate` calculations.
|
Pull request successfully merged into develop. Build succeeded:
|
spacemesh-bors
bot
changed the title
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Current
AdminService.PeerInfoStreamdoesn't provide enough information about whether hole punching was used while connecting to a particular peer, and also doesn't reflect actual utilization of each peer, which makes it harder to see whether the peer connections are being used efficiently.Also, importantly, in case if
go-spacemeshcauses network overload it may be hard to find out what kind of traffic is causing the problems. It would be nice to have some overview of the traffic even in case if the metrics are disabled. The current data transfer rates should be easy to view even without any Prometheus to doratecalculations.Description
AdminService.PeerInfoStreamresponse is extended with new fields.This includes connection kind (relay / hole punching information, with
HPInboundandHPOutboundmeaning inbound and out-bound hole-punching, respectively) and client/server request and transfer statistics. Also, it includes the data transfer rates (bytes/s) calculated over 10s and 1m periods.The peer records look like this (not using actual IPs or peer IDs):
{ "id": "...", "connections": [ { "address": "/ip4/123.45.67.89/tcp/15816", "uptime": "1336.521022291s", "outbound": true, "kind": "Outbound" } ], "clientStats": { "successCount": "1", "latency": "0.062496709s" }, "bytesSent": "4635446", "bytesReceived": "29709306", "sendRate": [ "0", "71" ], "recvRate": [ "0", "193" ] } { "id": "...", "connections": [ { "address": "/ip4/23.45.67.89/tcp/1024", "uptime": "449.661134625s", "outbound": true, "kind": "HPInbound" } ], "clientStats": { "successCount": "1", "latency": "0.070969208s" }, "bytesSent": "6110842", "bytesReceived": "39615132", "sendRate": [ "0", "257" ], "recvRate": [ "0", "121" ] }The output of
spacemesh.v1.DebugService.NetworkInfonow looks like:{ "id": "...", "listenAddresses": [ "/ip4/0.0.0.0/tcp/7513", "/ip4/0.0.0.0/udp/7513/quic-v1", "/p2p-circuit" ], "knownAddresses": [ "/ip4/127.0.0.1/tcp/7513", "/ip4/127.0.0.1/udp/7513/quic-v1", "/ip4/123.45.67.89/tcp/7513", "/ip4/192.168.40.159/tcp/7513", "/ip4/192.168.40.159/udp/7513/quic-v1", "/ip4/192.168.64.1/tcp/7513", "/ip4/192.168.64.1/udp/7513/quic-v1", "/ip4/...tcp/5001/p2p/....../p2p-circuit", "/ip4/.../tcp/5001/p2p/....../p2p-circuit" ], "natTypeTcp": "Cone", "reachability": "Private", "stats": { "/ipfs/id/1.0.0": { "bytesSent": "1702673", "bytesReceived": "1461222", "sendRate": [ "0", "25" ], "recvRate": [ "0", "18" ] }, "/ipfs/id/push/1.0.0": { "bytesSent": "207189", "bytesReceived": "8977845", "sendRate": [ "0", "237" ], "recvRate": [ "0", "251" ] }, "/libp2p/autonat/1.0.0": { "bytesSent": "7151", "bytesReceived": "3164" }, "/libp2p/circuit/relay/0.2.0/hop": { "bytesSent": "2589492", "bytesReceived": "2461896" }, "/libp2p/circuit/relay/0.2.0/stop": { "bytesSent": "88239", "bytesReceived": "85382", "sendRate": [ "0", "5" ], "recvRate": [ "0", "5" ] }, "/libp2p/dcutr": { "bytesSent": "9139", "bytesReceived": "12671" }, "/meshsub/1.1.0": { "bytesSent": "5265121597", "bytesReceived": "3980876238", "sendRate": [ "456745", "185721" ], "recvRate": [ "541102", "68351" ] }, "/peersync/1.0/": { "bytesSent": "46385", "bytesReceived": "43979" }, "/spacekad/kad/1.0.0": { "bytesSent": "644931", "bytesReceived": "15350810", "sendRate": [ "0", "41" ], "recvRate": [ "0", "1038" ] }, "__other__": { "bytesSent": "2861993", "bytesReceived": "2857514", "sendRate": [ "0", "33" ], "recvRate": [ "0", "33" ] }, "__total__": { "bytesSent": "5708199745", "bytesReceived": "4558225401", "sendRate": [ "456745", "186550" ], "recvRate": [ "541102", "69955" ] }, "ax/1": { "bytesSent": "86797553", "bytesReceived": "520784404" }, "hs/1": { "bytesSent": "338030798", "bytesReceived": "17237601", "sendRate": [ "0", "251" ], "recvRate": [ "0", "25" ] }, "ld/1": { "bytesSent": "8693168", "bytesReceived": "6800320", "sendRate": [ "0", "222" ], "recvRate": [ "0", "222" ] }, "lp/2": { "bytesSent": "320056", "bytesReceived": "256960", "sendRate": [ "0", "8" ], "recvRate": [ "0", "7" ] }, "ml/1": { "bytesSent": "1079381", "bytesReceived": "1015395" } } }Test Plan
Tested on a mainnet node
TODO