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

docs(config): mark Swarm.ResourceMgr as experimental #9039

Merged
merged 1 commit into from
Jun 16, 2022
Merged

docs(config): mark Swarm.ResourceMgr as experimental #9039

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1630,10 +1630,16 @@ Type: `duration`

### `Swarm.ResourceMgr`

**EXPERIMENTAL: `Swarm.ResourceMgr` configuration will change in future release**

The [libp2p Network Resource Manager](https://github.com/libp2p/go-libp2p-resource-manager#readme) allows setting limits per a scope,
and tracking recource usage over time.

#### `Swarm.ResourceMgr.Enabled`

**EXPERIMENTAL: `Swarm.ResourceMgr` is in active development, enable it only if you want to provide maintainers with feedback**


Enables the libp2p Network Resource Manager and auguments the default limits
using user-defined ones in `Swarm.ResourceMgr.Limits` (if present).

Expand All @@ -1643,12 +1649,14 @@ Type: `flag`

#### `Swarm.ResourceMgr.Limits`

**EXPERIMENTAL: `Swarm.ResourceMgr.Limits` configuration will change in future release, exposed here only for convenience**

Map of resource limits [per scope](https://github.com/libp2p/go-libp2p-resource-manager#resource-scopes).

The map supports fields from [`BasicLimiterConfig`](https://github.com/libp2p/go-libp2p-resource-manager/blob/v0.3.0/limit_config.go#L165-L185)
struct from [go-libp2p-resource-manager](https://github.com/libp2p/go-libp2p-resource-manager#readme).

Example:
**Example: (format may change in future release)**

```json
{
Expand Down