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.

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

Provide Open Metrics (/Prometheus) Wrapper #2013

Closed
mxinden opened this issue Mar 24, 2021 · 0 comments · Fixed by #2063
Closed

Provide Open Metrics (/Prometheus) Wrapper #2013

mxinden opened this issue Mar 24, 2021 · 0 comments · Fixed by #2063
Assignees
Labels
difficulty:moderate getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted priority:nicetohave

Comments

@mxinden
Copy link
Member

mxinden commented Mar 24, 2021

By design rust-libp2p does not expose Prometheus style metrics. Instead, given its event-based architecture, one should record the events emitted by rust-libp2p as a user.

Consider providing a wrapper around libp2p-swarm which records emitted events before bubbling them upwards. In case a generic wrapper is not feasible, offer a tutorial on how to instrument ones rust-libp2p instance.

The Prometheus format has been standardized, in a backwards compatible way, under the Open Metrics name, thus supporting Open Metrics instead of the old Prometheus style format is both more future-proof and likely better supported by monitoring systems.

Libraries:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty:moderate getting-started Issues that can be tackled if you don't know the internals of libp2p very well help wanted priority:nicetohave
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant