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

Docs: Add an overview section, including high level architecture diagram #1471

Closed
tzach opened this issue Jul 5, 2021 · 3 comments · Fixed by #1525
Closed

Docs: Add an overview section, including high level architecture diagram #1471

tzach opened this issue Jul 5, 2021 · 3 comments · Fixed by #1525
Assignees
Labels
documentation Documentation related

Comments

@tzach
Copy link
Contributor

tzach commented Jul 5, 2021

No description provided.

@amnonh
Copy link
Collaborator

amnonh commented Jul 5, 2021

There is such an overview page (the main index) it should be updted and add the diagram

@tzach
Copy link
Contributor Author

tzach commented Jul 5, 2021

You mean this one https://monitoring.docs.scylladb.com/stable/ ?
its out of date (only 3 docker), and give very little info on the architecture.
I suggest to fix it, and add an architecture page

@nyh
Copy link
Contributor

nyh commented Jul 5, 2021

I think the overview on https://monitoring.docs.scylladb.com/stable/ is much too short. If someone comes to it familiar witth Scylla but not already having a good mental image what "prometheus", "grafana" or "alert manager are", he will not understand anything. I think what is needed is text - not a diagram.

Some text (doesn't have to be very long) explaining that:
Scylla publishes various metrics, such as number of requests, disk activity, memory use, and a lot lot more (here you could have a link to a document or user guide or something with better list). All of these metrics are true to the moment they are requested. Prometheus is a time-series database which collects these metrics over time, and also collects them from multiple nodes and all their shards. Prometheus then allows querying and graphing these saved metrics. Grafana is a UI which further improves this graphing abilities, by showing multiple graphs in nice easy-to-use panels (see example below). Now explain also Loki (?), alert manager, advisor, etc.

https://github.com/scylladb/scylla/blob/master/docs/design-notes/metrics.md is my developer-oriented explanation of the same thing, but it has too much detail for users, and also predates the Loki, Alert manager, and Advisor stuff which isn't described there.

@amnonh amnonh added the documentation Documentation related label Jul 22, 2021
@amnonh amnonh mentioned this issue Aug 24, 2021
@amnonh amnonh added this to the Monitoring 3.9 milestone Aug 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants