Skip to content
This repository has been archived by the owner on Aug 19, 2022. It is now read-only.

self-service guide for handling "resource limit exceeded" messages #27

Closed
Tracked by #1711
BigLep opened this issue Jun 1, 2022 · 2 comments
Closed
Tracked by #1711

Comments

@BigLep
Copy link
Contributor

BigLep commented Jun 1, 2022

Done Criteria

There is a document that walks a user through when they see a "resource limit exceeded" message. This should include things like:

  1. Resource manager basics like scopes.
  2. Potential causes (resource leak, too-low-of-limit)
  3. How to determine the cause (e.g., look at what's consuming the resrouces in log messages, enabling traces)
  4. Prometheus metrics can look at

This document should be linked to when a "resource limit exceeded" error message is logged.

Why Important

As more applications enable go-libp2p resource management, we're going to get better at figuring out how to help application developers to be more self-service in diagnosing problems. By having a central document we improve, we have one place to update and a level of indirection from the code.

User/Customer

Developers of applications that consume go-libp2p

Notes

Ideally the guide will have examples to illustrate the concepts.

An issue for creating a guide on how to determine default limits for an application is here: #28

@BigLep
Copy link
Contributor Author

BigLep commented Aug 7, 2022

This is being handled in libp2p/docs#160

@marten-seemann
Copy link
Contributor

Closing since the docs change has landed.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants