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

docs: How to setup monitoring stack? #480

Merged
merged 1 commit into from
Jul 8, 2020

Conversation

surajssd
Copy link
Member

Fixes: #450

@surajssd surajssd force-pushed the surajssd/document-prom-access branch from 89356d3 to 6f5b13e Compare May 26, 2020 09:52
@surajssd
Copy link
Member Author

surajssd commented May 26, 2020

Blocked on #468

@surajssd surajssd force-pushed the surajssd/document-prom-access branch from 6f5b13e to 111bdbb Compare May 29, 2020 15:48
@surajssd surajssd marked this pull request as ready for review May 29, 2020 15:48
@surajssd surajssd requested a review from johananl as a code owner May 29, 2020 15:48
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
@surajssd surajssd force-pushed the surajssd/document-prom-access branch from 111bdbb to 2974a0c Compare June 3, 2020 11:10
@surajssd surajssd requested review from ipochi and invidian June 3, 2020 11:10
Copy link
Member

@johananl johananl left a comment

Choose a reason for hiding this comment

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

Thanks for the PR.

There are multiple capitalization problems and missing articles throughout the docs. Could you please fix these?
In addition, the writing style feels different from other docs we already have. Would you consider rephrasing the guide to help preserve a consistent tone and feel in the Lokomotive docs?

docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
@johananl
Copy link
Member

johananl commented Jun 3, 2020

One more thing: like my feedback here, I'm getting the feeling "how to access" is too narrow as a topic for a how-to guide. I'd rather expect to see this as a section in a more complete "how to monitor Lokomotive clusters" how-to guide.

@surajssd surajssd force-pushed the surajssd/document-prom-access branch 2 times, most recently from 512e7fb to 9f7e1da Compare June 3, 2020 14:26
@surajssd
Copy link
Member Author

surajssd commented Jun 3, 2020

In addition, the writing style feels different from other docs we already have. Would you consider rephrasing the guide to help preserve a consistent tone and feel in the Lokomotive docs?

Can you be specific about what do you mean here?

@surajssd surajssd force-pushed the surajssd/document-prom-access branch 7 times, most recently from 1b1b7c2 to 5970737 Compare June 5, 2020 11:13
@johananl
Copy link
Member

johananl commented Jun 5, 2020

In addition, the writing style feels different from other docs we already have. Would you consider rephrasing the guide to help preserve a consistent tone and feel in the Lokomotive docs?

Can you be specific about what do you mean here?

I guess what I wanted to say is that IMO there are language and phrasing problems throughout the PR. I will comment on specific cases.

Copy link
Member

@johananl johananl left a comment

Choose a reason for hiding this comment

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

Thanks for your effort @surajssd. I've added some comments. If anything seems "arbitrary" to you or if my intention isn't clear, please talk to me.

docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
docs/how-to-guides/access-monitoring.md Outdated Show resolved Hide resolved
@surajssd surajssd force-pushed the surajssd/document-prom-access branch 6 times, most recently from b589895 to 961196f Compare June 10, 2020 09:47
@surajssd surajssd force-pushed the surajssd/document-prom-access branch 6 times, most recently from 1915ba5 to 7b6f720 Compare June 10, 2020 10:16
@surajssd surajssd changed the title docs: How to access monitoring stack? docs: How to setup monitoring stack? Jun 10, 2020
@surajssd surajssd requested a review from johananl June 10, 2020 10:16
@surajssd
Copy link
Member Author

@iaguis @johananl PTAL at the changed PR.

@surajssd
Copy link
Member Author

@invidian @johananl @iaguis PTAl the changed PR.

Copy link
Member

@invidian invidian left a comment

Choose a reason for hiding this comment

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

Just some nits, PR looks largely OK to me. However, it seems accessing monitoring require a bit of effort right now. We could perhaps improve that somehow.

Copy link
Member

@johananl johananl left a comment

Choose a reason for hiding this comment

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

Thanks @surajssd 🙏

I've added some comments. My main issue is missing articles throughout the document. There are also a couple of places where I feel the tone/phrasing should be improved.

docs/how-to-guides/monitoring-with-prometheus-operator.md Outdated Show resolved Hide resolved
docs/how-to-guides/monitoring-with-prometheus-operator.md Outdated Show resolved Hide resolved
docs/how-to-guides/monitoring-with-prometheus-operator.md Outdated Show resolved Hide resolved
docs/how-to-guides/monitoring-with-prometheus-operator.md Outdated Show resolved Hide resolved
docs/how-to-guides/monitoring-with-prometheus-operator.md Outdated Show resolved Hide resolved
docs/how-to-guides/monitoring-with-prometheus-operator.md Outdated Show resolved Hide resolved
docs/how-to-guides/monitoring-with-prometheus-operator.md Outdated Show resolved Hide resolved
docs/how-to-guides/monitoring-with-prometheus-operator.md Outdated Show resolved Hide resolved
docs/how-to-guides/monitoring-with-prometheus-operator.md Outdated Show resolved Hide resolved
@surajssd surajssd force-pushed the surajssd/document-prom-access branch 2 times, most recently from 1471ef9 to a1cab6c Compare June 26, 2020 08:55
@surajssd surajssd requested review from invidian, johananl and iaguis June 26, 2020 08:55
@surajssd surajssd force-pushed the surajssd/document-prom-access branch from a1cab6c to d6e374a Compare June 26, 2020 11:10
@surajssd surajssd requested a review from iaguis June 29, 2020 06:00
This commit adds a guide to setup monitoring stack and access it.

Signed-off-by: Suraj Deshmukh <suraj@kinvolk.io>
@surajssd surajssd force-pushed the surajssd/document-prom-access branch from d6e374a to 6280ef0 Compare July 7, 2020 14:50
@surajssd
Copy link
Member Author

surajssd commented Jul 8, 2020

PTAL @iaguis

Copy link
Contributor

@iaguis iaguis left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Member

@ipochi ipochi left a comment

Choose a reason for hiding this comment

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

Thanks for the PR and patience @surajssd !!

LGTM

@surajssd surajssd dismissed stale reviews from invidian and johananl July 8, 2020 10:25

All the changes mentioned were incorporated.

@surajssd surajssd merged commit c0263bd into master Jul 8, 2020
@surajssd surajssd deleted the surajssd/document-prom-access branch July 8, 2020 10:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to access Prometheus, Alertmanager, Grafana
5 participants