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

add metrics in go-libp2p blogpost #77

Merged
merged 11 commits into from
Aug 15, 2023
Merged

add metrics in go-libp2p blogpost #77

merged 11 commits into from
Aug 15, 2023

Conversation

sukunrt
Copy link
Member

@sukunrt sukunrt commented Jun 15, 2023

@p-shahi
I don't have a lot more to add here, Once we have this and the public grafana dashboard, I'll update the details.
Please let me know if there something else we should talk about. I don't want to discuss all the metrics that we've added, I think that's better served by a doc in the go-libp2p repo.

fixes: #69

@sukunrt sukunrt marked this pull request as draft June 15, 2023 19:38
@github-actions
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 44.6%, saving 240.36 KB.

Filename Before After Improvement Visual comparison
src/assets/metrics-in-go-libp2p-evtlocaladdressesupdated.png 94.06 KB 50.84 KB -45.9% View diff
src/assets/metrics-in-go-libp2p-evtlocalreachabilitychanged.png 98.45 KB 55.07 KB -44.1% View diff
src/assets/metrics-in-go-libp2p-evtprotocolsupdated.png 97.24 KB 53.49 KB -45.0% View diff
src/assets/metrics-in-go-libp2p-smart-dialing.png 248.83 KB 138.82 KB -44.2% View diff

55 images did not require optimisation.

Copy link
Member

@p-shahi p-shahi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for writing this! Took a first look at it and left comments.

src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
@p-shahi
Copy link
Member

p-shahi commented Jun 16, 2023

For some reason your name is rendering like so
image
might be because of the and

src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Show resolved Hide resolved
@github-actions
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 43.8%, saving 124.91 KB.

Filename Before After Improvement Visual comparison
src/assets/metrics-in-go-libp2p-prometheus-ui.png 285.15 KB 160.24 KB -43.8% View diff

59 images did not require optimisation.

@sukunrt
Copy link
Member Author

sukunrt commented Jun 19, 2023

@p-shahi
this is the issue: https://github.com/libp2p/blog/blob/main/src/.vuepress/plugins/pageData.js#L44
it should be " and " and not just and

@p-shahi p-shahi mentioned this pull request Jun 20, 2023
@p-shahi
Copy link
Member

p-shahi commented Jun 20, 2023

@p-shahi this is the issue: https://github.com/libp2p/blog/blob/main/src/.vuepress/plugins/pageData.js#L44 it should be " and " and not just and

can you include this change in this pr?

src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
@sukunrt sukunrt marked this pull request as ready for review June 20, 2023 15:56
@marten-seemann
Copy link
Contributor

Should this blog post also mention how easy it is to use metrics locally, once we have libp2p/go-libp2p#2383?

@sukunrt
Copy link
Member Author

sukunrt commented Jun 21, 2023

@marten-seemann that makes sense. I'll edit the post to include that.

@sukunrt
Copy link
Member Author

sukunrt commented Jun 21, 2023

@marten-seemann Add a section titled Local development and debugging setup here

Copy link
Member

@p-shahi p-shahi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This lgtm, let's wait for the header image and a review+approval from others before merging

@sukunrt
Copy link
Member Author

sukunrt commented Jun 27, 2023

Will need a small change depending on how libp2p/go-libp2p#2385 goes

Copy link
Contributor

@MarcoPolo MarcoPolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some nits

src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Show resolved Hide resolved

- If you’d like to get involved and contribute to libp2p, you can reach out to us using these means: [https://libp2p.io/#community](https://libp2p.io/#community)
- If you’re a self-starter and want to start pushing code immediately, feel free to ping the maintainers in any of these help wanted/good first issues: [go-libp2p](https://github.com/libp2p/go-libp2p/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), [js-libp2p](https://github.com/libp2p/js-libp2p/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and [rust-libp2p](https://github.com/libp2p/rust-libp2p/issues?q=is%3Aopen+is%3Aissue+label%3Agetting-started).
- If you want to work in and around libp2p full-time, there are various teams hiring including the implementation teams. See [https://jobs.protocol.ai/jobs?q=libp2p](https://jobs.protocol.ai/jobs?q=libp2p) for opportunities across the [Protocol Labs Network](https://plnetwork.io/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to

@p-shahi
Copy link
Member

p-shahi commented Jun 29, 2023

@sukunrt are we ready to publish - I think the header image is ready right?

@sukunrt
Copy link
Member Author

sukunrt commented Jun 29, 2023

Waiting for resolution here libp2p/go-libp2p#2385
cc @MarcoPolo

@MarcoPolo
Copy link
Contributor

I'll update that, but how is that a blocker?

- grafana
title: Metrics in go-libp2p
description:
date: 2023-06-15
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to update this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can update it once we are ready to release. #77 (review)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Contributor

@marten-seemann marten-seemann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't publish this post before we don't have a node connected to our public instance at libp2p.grafana.net.

Slack thread: https://filecoinproject.slack.com/archives/C03CKEPVA1Y/p1688063239680209

Comment on lines 82 to 83
To see the dashboards in action check the [Metrics and Dashboards](https://github.com/libp2p/go-libp2p/tree/master/examples/metrics-and-dashboards) example in the go-libp2p repo. This example sets up a dummy libp2p app configured with a Prometheus and Grafana instance. You can check all the dashboards available at <http://localhost:3000/dashboards>.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarcoPolo if we remove the example, I'll need to remove this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just saw: libp2p/go-libp2p#2385 (comment)

As long as we are keeping the example, this is not a blocker. So we are good to go.

@sukunrt
Copy link
Member Author

sukunrt commented Jun 29, 2023

title: Metrics in go-libp2p
description:
date: 2023-06-29
permalink: "/2023-06-15-metrics-in-go-libp2p/"
Copy link
Member

@p-shahi p-shahi Jun 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
permalink: "/2023-06-15-metrics-in-go-libp2p/"
permalink: "/2023-06-15-metrics-in-go-libp2p/"

note the permalink needs to change as well. can update date and permalink the day of merge

@p-shahi
Copy link
Member

p-shahi commented Aug 8, 2023

@sukunrt Is this ready to merge? I think from our last discussion go-libp2p maintainers were all in agreement to display metrics from PL managed grafana (from a bifrost node). Is all that's remaining to add the right link in this post?

src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Outdated Show resolved Hide resolved
src/_blog/metrics-in-go-libp2p.md Show resolved Hide resolved
@p-shahi p-shahi merged commit 4850c21 into main Aug 15, 2023
1 check passed
@p-shahi p-shahi deleted the metrics-in-go-libp2p branch August 15, 2023 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

metrics in go-libp2p
4 participants