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

doc: Add Prometheus and Grafana integration to MONITORING #63

Merged
merged 8 commits into from
Jan 31, 2023

Conversation

levaitamas
Copy link
Member

Based on PR #51.

Comments are welcome.

Copy link
Member

@rg0now rg0now left a comment

Choose a reason for hiding this comment

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

Apart from some short comments I'm fine with the PR, thanks. The comments:

  • Why do we put the configuration part (PodMonitor config) first, and only after that installation part (stunner-prometheus helm chart)? For me the straightforward order of the subsections would be Installation, Configuration, Test, with these titles.
  • From the description it is not clear to me whether it is the user's responsibility to create the PodMonitor resource or it it automatically done by the helm chart.
  • I love the screenshots but can we maybe highlight a case where there is an actual reading in the plot instead of the boring line at zero? Why not performing the iperf test (simple-tunnel) and then presenting the packet counter or the byte counter screenshots?

@levaitamas levaitamas marked this pull request as ready for review January 26, 2023 11:53
@levaitamas
Copy link
Member Author

@rg0now that was spot on, thanks!

I did a major rewrite: combined the Prometheus and Grafana integration into a single section with the subsections as Installation, Configuration and Usage, and Troubleshooting. The focus is shifted to the helm chart-based install and to Grafana visualization.

Installation focuses on the helm chart only -- omitted the PodMonitor configuration part to keep the focus on the helm chart-based install.

Configuration and Usage shows how to visualize STUNner metrics in Grafana: how to add new plots and how to use it.

Troubleshooting gives pointers to checking the path of metrics from STUNNer to Prometheus, and from Prometheus to Grafana.

Screenshots are in sync with current metrics and show some real traffic.

wdyt?

@levaitamas levaitamas requested a review from rg0now January 26, 2023 12:38
@rg0now rg0now merged commit 51a0537 into main Jan 31, 2023
@rg0now rg0now deleted the monitoring-doc branch January 31, 2023 17:38
@rg0now
Copy link
Member

rg0now commented Jan 31, 2023

Thanks a lot, applied

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

Successfully merging this pull request may close these issues.

2 participants