docs: "remote" errors from resource manager (#9653)
Being more clear that the "remote" string means its from a remote peer. This came up in: https://github.com/ipfs/kubo/issues/9432#issuecomment-1402022085 https://github.com/ipfs/kubo/issues/9432#issuecomment-1402276883 https://github.com/ipfs/kubo/issues/9432#issuecomment-1410444354
Steve Loeppky committed
Feb 16, 2023 at 13:17 UTC
05afb879f3f5f1d6fcd4646523dc3eda32ac8901
1 file changed
+15
-11
docs/libp2p-resource-management.md
+15
-11
@@ -12,22 +12,26 @@ Good places to start are:
12
3. Understand [how to inspect and change limits](#user-supplied-override-limits)
13
14
## Table of Contents
15
+<!-- TOC depthfrom:2 -->
16
16
-- [libp2p Network Resource Manager <small>(`Swarm.ResourceMgr`)</small>](#libp2p-network-resource-manager-smallswarmresourcemgrsmall)
17
- - [Purpose](#purpose)
18
- - [Levels of Configuration](#levels-of-configuration)
17
+- [Purpose](#purpose)
18
+- [🙋 Help! The resource manager is protecting my node but I want to understand more](#-help--the-resource-manager-is-protecting-my-node-but-i-want-to-understand-more)
19
+- [Table of Contents](#table-of-contents)
20
+- [Levels of Configuration](#levels-of-configuration)
21
- [Approach](#approach)
22
- [Computed Default Limits](#computed-default-limits)
23
- [User Supplied Override Limits](#user-supplied-override-limits)
24
- [Infinite limits](#infinite-limits)
23
- - [FAQ](#faq)
25
+- [FAQ](#faq)
26
- [What do these "Protected from exceeding resource limits" log messages mean?](#what-do-these-protected-from-exceeding-resource-limits-log-messages-mean)
25
- - [What are the "Application error ... cannot reserve ..." messages?](#what-are-the-application-error--cannot-reserve--messages)
26
- - [How does the resource manager (ResourceMgr) relate to the connection manager (ConnMgr)?](#how-does-the-resource-manager-resourcemgr-relate-to-the-connection-manager-connmgr)
27
+ - [What are the "Application error 0x0 remote ... cannot reserve ..." messages?](#what-are-the-application-error-0x0-remote--cannot-reserve--messages)
28
+ - [How does the resource manager ResourceMgr relate to the connection manager ConnMgr?](#how-does-the-resource-manager-resourcemgr-relate-to-the-connection-manager-connmgr)
29
- [How does one see the Active Limits?](#how-does-one-see-the-active-limits)
30
- [How does one see the Computed Default Limits?](#how-does-one-see-the-computed-default-limits)
31
- [How does one monitor libp2p resource usage?](#how-does-one-monitor-libp2p-resource-usage)
30
- - [History](#history)
32
+- [History](#history)
33
+
34
+<!-- /TOC -->
35
36
## Levels of Configuration
37
@@ -128,15 +132,15 @@ Sources:
132
* [kubo resource manager logging](https://github.com/ipfs/kubo/blob/master/core/node/libp2p/rcmgr_logging.go)
133
* [libp2p resource manager messages](https://github.com/libp2p/go-libp2p/blob/master/p2p/host/resource-manager/scope.go)
134
131
-### What are the "Application error ... cannot reserve ..." messages?
132
-These are messages from a *remote* go-libp2p peer (likely another Kubo node) with the resource manager enabled on why it failed to establish a connection.
135
+### What are the "Application error 0x0 (remote) ... cannot reserve ..." messages?
136
+These are messages coming from a *remote* go-libp2p peer (likely another Kubo node) with the resource manager enabled on why it failed to establish a connection.
137
134
-This can be confusing, but these `Application error ... cannot reserve ...` messages can occur even if your local node has the resoure manager disabled.
138
+This can be confusing, but these `Application error 0x0 (remote) ... cannot reserve ...` messages can occur even if your local node has the resoure manager disabled.
139
140
You can distinguish resource manager messages originating from your local node if they're from the `resourcemanager` / `libp2p/rcmgr_logging.go` logger
141
or you see the string that is unique to Kubo (and not in go-libp2p): "Protected from exceeding resource limits".
142
139
-There is a go-libp2p issue ([#1928](https://github.com/libp2p/go-libp2p/issues/1928)) to make it clearer that this is an error message originating from a remote peer.
143
+There is a go-libp2p issue ([#1928](https://github.com/libp2p/go-libp2p/issues/1928)) to make it even clearer that this is an error message originating from a remote peer.
144
145
### How does the resource manager (ResourceMgr) relate to the connection manager (ConnMgr)?
146
As discussed [here](https://github.com/libp2p/go-libp2p/tree/master/p2p/host/resource-manager#connmanager-vs-resource-manager)