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.

Sign up for GitHub

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

Jump to bottom

Added the docs for all the grafana dashboards. #21795

Merged
merged 97 commits into from
Nov 5, 2024
Merged

Added the docs for all the grafana dashboards. #21795

merged 97 commits into from
Nov 5, 2024

Conversation

YasminLorinKaygalak
Copy link
Contributor

@YasminLorinKaygalak YasminLorinKaygalak commented Oct 1, 2024 •
edited
Loading

Description

NET-11158
Added the docs for the grafana dashboards.

PR Checklist

  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

@hashicorp-cla-app HashiCorp CLA App
Copy link

hashicorp-cla-app bot commented Oct 1, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Oct 1, 2024
@missylbytes missylbytes requested review from missylbytes, a team and xwa153 and removed request for a team October 3, 2024 14:11
@YasminLorinKaygalak YasminLorinKaygalak marked this pull request as ready for review October 3, 2024 15:58
@YasminLorinKaygalak YasminLorinKaygalak requested a review from a team as a code owner October 3, 2024 15:58
@missylbytes missylbytes added the pr/do-not-merge PR cannot be merged in its current form. label Oct 3, 2024
boruszak
boruszak reviewed Oct 3, 2024
View reviewed changes
Copy link
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

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

@YasminLorinKaygalak Here is a preliminary review that outlines the repeated problems to correct.

For each of the reference pages, please implement the following three changes to each of the metrics and their descriptions:

  1. Sentence case in headings
  2. Line break between heading and list
  3. Grafana query instead of Metric

Then, remove the colons from the headings and ensure that there are sentences between each heading. Feel free to use the suggestions in this review as templates for each of the pages.

Don't worry about rewriting all of the descriptions at this time. Let's get these repeated formatting issues fixed first!

website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/index.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/index.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/index.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
@missylbytes missylbytes added the backport/1.20 Changes are backported to 1.20 label Oct 4, 2024
@boruszak boruszak added the pr/no-changelog PR does not need a corresponding .changelog entry label Oct 8, 2024
@missylbytes
Copy link
Contributor

missylbytes commented Oct 9, 2024 •
edited
Loading

Do we care about ordering these alphabetically in the sidebar? @boruszak
image

@missylbytes
Copy link
Contributor

missylbytes commented Oct 9, 2024 •
edited
Loading

Also I don't know what the standard is for this, but is there a way to make these look a bit more readable?
image
i.e. are we allowed to put this as the ``` multiline-type formatting like in the following? This is probably a @boruszak question.
image

blake
blake reviewed Oct 10, 2024
View reviewed changes
website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consuldataplanedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consulk8sdashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consulk8sdashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consulk8sdashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consulserverdashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consulserverdashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/service-to-servicedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/servicedashboard.mdx Outdated Show resolved Hide resolved
boruszak
boruszak reviewed Oct 11, 2024
View reviewed changes
Copy link
Contributor

@boruszak boruszak left a comment

Choose a reason for hiding this comment

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

These docs are coming along very well, Lorin!

After you implement suggestions from Melisa, Blake, and me, please do the following:

  1. Add the with the query language set to the Grafana queries (combining mine and Blake's examples).
  2. Add the CodeTabs to the item Blake suggestions. Check for other metrics where Code Tabs might be appropriate.

After those steps are done, we should be really close to the end of the review process.

website/content/docs/connect/observability/grafanadashboards/consulk8sdashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consulk8sdashboard.mdx Outdated
- **Grafana query:** `sum(rate(container_fs_writes_bytes_total{pod=~"consul-server-.*",
container="consul"}[5m])) by (pod, device)`
- **Grafana query:** `sum(rate(container_fs_reads_bytes_total{pod=~"consul-server-.*", container="consul"}[5m])) by (pod, device)`
- **Description:** Monitors disk read and write operations over 5-minute intervals for Consul servers. This helps identify potential disk bottlenecks or issues.
Copy link
Contributor

Choose a reason for hiding this comment

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

@YasminLorinKaygalak Note how Blake suggestions changing this second sentence so that it gives an imperative command in active voice (use this metric to do x), instead of the indirect and sometimes passive voice (operators can use this metric to do x)

website/content/docs/connect/observability/grafanadashboards/consulk8sdashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consulserverdashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/consulserverdashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/service-to-servicedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/service-to-servicedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/servicedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/servicedashboard.mdx Outdated Show resolved Hide resolved
website/content/docs/connect/observability/grafanadashboards/servicedashboard.mdx Outdated Show resolved Hide resolved
@missylbytes missylbytes force-pushed the Net-12345--docs-for-grafana-dashboards branch from 3243ce4 to db619f5 Compare October 30, 2024 20:05
@missylbytes missylbytes requested review from a team as code owners October 30, 2024 20:05
@missylbytes missylbytes added the pr/do-not-merge PR cannot be merged in its current form. label Oct 30, 2024
missylbytes
missylbytes requested changes Oct 30, 2024
View reviewed changes
Copy link
Contributor

@missylbytes missylbytes left a comment

Choose a reason for hiding this comment

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

Going to wait for Vercel to fix itself

@missylbytes missylbytes self-requested a review November 4, 2024 17:28
@missylbytes missylbytes removed the pr/do-not-merge PR cannot be merged in its current form. label Nov 4, 2024
@YasminLorinKaygalak @boruszak
Update website/content/docs/connect/observability/grafanadashboards/c…
42c5c48 
…onsuldataplanedashboard.mdx

Co-authored-by: Jeff Boruszak <[email protected]>
@YasminLorinKaygalak @boruszak
Update website/content/docs/connect/observability/grafanadashboards/s…
73c4939 
…ervice-to-servicedashboard.mdx

Co-authored-by: Jeff Boruszak <[email protected]>
@YasminLorinKaygalak @boruszak
Update website/content/docs/connect/observability/grafanadashboards/s…
4c20394 
…ervice-to-servicedashboard.mdx

Co-authored-by: Jeff Boruszak <[email protected]>
@YasminLorinKaygalak @boruszak
Update website/content/docs/connect/observability/grafanadashboards/s…
1ad666d 
…ervicedashboard.mdx

Co-authored-by: Jeff Boruszak <[email protected]>
@YasminLorinKaygalak @boruszak
Update website/content/docs/connect/observability/grafanadashboards/s…
592fd27 
…ervicedashboard.mdx

Co-authored-by: Jeff Boruszak <[email protected]>
@YasminLorinKaygalak YasminLorinKaygalak merged commit 32515c7 into main Nov 5, 2024
64 checks passed
@YasminLorinKaygalak YasminLorinKaygalak deleted the Net-12345--docs-for-grafana-dashboards branch November 5, 2024 15:06
@hc-github-team-consul-core hc-github-team-consul-core mentioned this pull request Nov 5, 2024
Merged
3 tasks
missylbytes pushed a commit that referenced this pull request Nov 5, 2024
@YasminLorinKaygalak @blake @missylbytes
Added the docs for all the grafana dashboards. (#21795)
57f91de 
* Added the docs for all the grafana dashboards.

 Author:   Yasmin Lorin Kaygalak <[email protected]>

Co-authored-by: Jeff Boruszak <[email protected]>

Co-authored-by: Blake Covarrubias <[email protected]>
YasminLorinKaygalak added a commit that referenced this pull request Nov 5, 2024
@hc-github-team-consul-core @YasminLorinKaygalak @blake
Backport of Added the docs for all the grafana dashboards. into relea…
616f9ba 
…se/1.20.x (#21918)

Added the docs for all the grafana dashboards. (#21795)

* Added the docs for all the grafana dashboards.

 Author:   Yasmin Lorin Kaygalak <[email protected]>

Co-authored-by: Yasmin Lorin Kaygalak <[email protected]>
Co-authored-by: Blake Covarrubias <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@boruszak boruszak boruszak approved these changes

@jm96441n jm96441n jm96441n left review comments

@blake blake blake left review comments

@missylbytes missylbytes missylbytes approved these changes

@xwa153 xwa153 Awaiting requested review from xwa153 xwa153 was automatically assigned from hashicorp/consul-api-gateway

Assignees
No one assigned
Labels
backport/1.20 Changes are backported to 1.20 pr/no-changelog PR does not need a corresponding .changelog entry type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.