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.

Sign up for GitHub

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

fix(metrics): use http user-agent if libp2p fails #47

Merged
merged 2 commits into from
Feb 3, 2025
Merged

fix(metrics): use http user-agent if libp2p fails #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94b4c05
fix(metrics): use http user-agent if libp2p fails
lidel Feb 2, 2025
7bb23dc
fix: detect ad-hoc node clients
lidel Feb 3, 2025
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
40 changes: 25 additions & 15 deletions acme/writer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,8 @@ func (c *acmeWriter) OnStartup() error {
return
}

if err := testAddresses(r.Context(), peerID, typedBody.Addresses); err != nil {
httpUserAgent := r.Header.Get("User-Agent")
if err := testAddresses(r.Context(), peerID, typedBody.Addresses, httpUserAgent); err != nil {
w.WriteHeader(http.StatusBadRequest)
_, _ = w.Write([]byte(fmt.Sprintf("error testing addresses: %s", err)))
return
Expand Down Expand Up @@ -214,10 +215,11 @@ func withRequestLogger(next http.Handler) http.Handler {
})
}

func testAddresses(ctx context.Context, p peer.ID, addrs []string) error {
func testAddresses(ctx context.Context, p peer.ID, addrs []string, httpUserAgent string) error {
agentVersion := agentType(httpUserAgent)
h, err := libp2p.New(libp2p.NoListenAddrs, libp2p.DisableRelay())
if err != nil {
peerProbeCount.WithLabelValues("error", "unknown").Add(1)
peerProbeCount.WithLabelValues("error", agentVersion).Add(1)
return err
}
defer h.Close()
Expand All @@ -226,23 +228,22 @@ func testAddresses(ctx context.Context, p peer.ID, addrs []string) error {
for _, addr := range addrs {
ma, err := multiaddr.NewMultiaddr(addr)
if err != nil {
peerProbeCount.WithLabelValues("error", "unknown").Add(1)
peerProbeCount.WithLabelValues("error", agentVersion).Add(1)
return err
}
mas = append(mas, ma)
}

err = h.Connect(ctx, peer.AddrInfo{ID: p, Addrs: mas})
if err != nil {
peerProbeCount.WithLabelValues("error", "unknown").Add(1)
peerProbeCount.WithLabelValues("error", agentVersion).Add(1)
return err
}

// TODO: Do we need to listen on the identify event instead?
// TODO: Where do we want to record this information if anywhere?
var agentVersion string
if v, err := h.Peerstore().Get(p, "AgentVersion"); err == nil {
if vs, ok := v.(string); ok {
// if we had successful libp2p identify we prefer agentVersion from it
agentVersion = vs
}
}
Expand All @@ -255,18 +256,27 @@ func testAddresses(ctx context.Context, p peer.ID, addrs []string) error {
// libp2p clients can set agent version to arbitrary strings,
// and the metric labels have to have a bound cardinality
func agentType(agentVersion string) string {
if strings.HasPrefix(agentVersion, "kubo/") {
switch {
case strings.HasPrefix(agentVersion, "kubo/"):
return "kubo"
}
if strings.HasPrefix(agentVersion, "helia/") {
case strings.HasPrefix(agentVersion, "go-ipfs/"): // not kubo, but maybe storm ;)
return "go-ipfs"
case strings.HasPrefix(agentVersion, "helia/"):
return "helia"
}
// TODO: revisit once js0libp2p cleans up default user agents to something unique and not "libp2p/"
if strings.HasPrefix(agentVersion, "libp2p/") || strings.HasPrefix(agentVersion, "js-libp2p/") {
case strings.HasPrefix(agentVersion, "libp2p/") || strings.Contains(agentVersion, "js-libp2p/"):
return "js-libp2p"
}
if strings.Contains(agentVersion, "go-libp2p") {
case strings.Contains(agentVersion, "go-libp2p"):
return "go-libp2p"
case strings.Contains(agentVersion, "Go-http-client"):
return "go-http-client"
case strings.Contains(agentVersion, "python-requests"):
return "python-requests"
case strings.HasPrefix(agentVersion, "curl/"):
return "curl"
case agentVersion == "node": // sent when running via 'node poc.js' (not matching prefix as it is too generic, could match node-foo)
return "node"
case strings.HasPrefix(agentVersion, "Mozilla/"): // most of browsers make requests with user-agent header value starting with
return "browser"
}
return "other"
}
Expand Down