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

Update telemetry docs #9905

Merged
merged 6 commits into from
Mar 22, 2021
Merged

Update telemetry docs #9905

merged 6 commits into from
Mar 22, 2021

Conversation

jsosulska
Copy link
Contributor

@jsosulska jsosulska commented Mar 19, 2021

Taking a pass at updating telemetry.md. This update is based on the search query: is:open label:theme/telemetry label:type/docs. Aims to fix #8422

This PR is deceptively large, and works best if you split out the changes into commits. I included a brief explination as to whats in the commits.

Fixes #2379-Improve interval explanation in the telemetry doc

  • Moved interval explanation to the top of the guide, and included a chart as requested in the ticket. Please let me know if I missed any sinks.

Fixes #4734-Update consul memory metrics

  • Included a link to the MemStat page as well as the GitHub issue for more context.

Fixes #4836-Removed node.deregistration as that isn't in state.go

  • The larger ticket has been resolved per Telemetry/fix missing and stale docs #9261. There was a metric that we said we exposed node.deregistration that wasn't actually exposed, and that was deleted from the table.

partially #8986-Trim redundant language

  • The ticket talks about reorganizing the metrics presentation, alphabetizing them, trimming redundant language, and adding more sections. This particular commit removes "This {measures,counts,increments}" from the descriptions, as well as adds a missing code \`` for consul.version`

Fixes #9087-Adds helpful details to telemetry on autopilot

  • The original issue requests adding some direction for operators reading through this guide. I added a link to the other sections wrt leadership and raft timings.
    Fixes consul_autopilot_healthy metric is NaN #9274-Addresses NaN output in autopilot
  • Adds an explicit call out to the docs about NaN being reflected on any non-leader server when prometheus metrics are requested.

@jsosulska jsosulska added type/docs Documentation needs to be created/updated/clarified type/docs-cherrypick pr/no-changelog PR does not need a corresponding .changelog entry labels Mar 19, 2021
@jsosulska jsosulska requested review from mkcp and a team March 19, 2021 00:41
Copy link
Contributor

@mkcp mkcp left a comment

Choose a reason for hiding this comment

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

We went over this on zoom! Looks good!

@jsosulska jsosulska merged commit 277de5a into master Mar 22, 2021
@jsosulska jsosulska deleted the jono/fixes_docs branch March 22, 2021 22:47
@hashicorp-ci
Copy link
Contributor

🍒 If backport labels were added before merging, cherry-picking will start automatically.

To retroactively trigger a backport after merging, add backport labels and re-run https://circleci.com/gh/hashicorp/consul/341716.

@hashicorp-ci
Copy link
Contributor

🍒✅ Cherry pick of commit 277de5a onto stable-website succeeded!

hashicorp-ci pushed a commit that referenced this pull request Mar 22, 2021
* Fixes #2379-Improve interval explanation in the telemetry doc

* Fixes #4734-Update consul memory metrics

* Fixes #4836-Removed node.deregistration as that isn't in state.go

* Fixes #8986 partially-Trim redundant language

* Fixes #9087-Adds helpful details to telemetry on autopilot

* Fixes #9274-Addresses NaN output in autopilot
@hashicorp-ci
Copy link
Contributor

🍒✅ Cherry pick of commit 277de5a onto release/1.9.x succeeded!

hashicorp-ci pushed a commit that referenced this pull request Mar 22, 2021
* Fixes #2379-Improve interval explanation in the telemetry doc

* Fixes #4734-Update consul memory metrics

* Fixes #4836-Removed node.deregistration as that isn't in state.go

* Fixes #8986 partially-Trim redundant language

* Fixes #9087-Adds helpful details to telemetry on autopilot

* Fixes #9274-Addresses NaN output in autopilot
dizzyup pushed a commit that referenced this pull request Apr 21, 2021
* Fixes #2379-Improve interval explanation in the telemetry doc

* Fixes #4734-Update consul memory metrics

* Fixes #4836-Removed node.deregistration as that isn't in state.go

* Fixes #8986 partially-Trim redundant language

* Fixes #9087-Adds helpful details to telemetry on autopilot

* Fixes #9274-Addresses NaN output in autopilot
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/no-changelog PR does not need a corresponding .changelog entry type/docs Documentation needs to be created/updated/clarified
Projects
None yet
3 participants