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

Improve interval explanation in the telemetry doc #2379

Closed
slackpad opened this issue Sep 30, 2016 · 0 comments · Fixed by #9905
Closed

Improve interval explanation in the telemetry doc #2379

slackpad opened this issue Sep 30, 2016 · 0 comments · Fixed by #9905
Labels
theme/telemetry Anything related to telemetry or observability type/docs Documentation needs to be created/updated/clarified
Milestone

Comments

@slackpad
Copy link
Contributor

slackpad commented Sep 30, 2016

https://www.consul.io/docs/agent/telemetry.html

When telemetry is being streamed to an external metrics store, the interval is defined to be that store's flush interval. Otherwise, the interval can be assumed to be 10 seconds when retrieving metrics from the built-in store using the above described signals.

It's confusing what interval means. We need to clean this up and maybe add a table that shows the default flush interval for the different telemetry sinks that we support. We should also link "interval" down below to an anchor so it's clear where that's explained in the doc.

@slackpad slackpad added the type/docs Documentation needs to be created/updated/clarified label Sep 30, 2016
@slackpad slackpad added this to the Unplanned milestone Jan 5, 2018
@jsosulska jsosulska added the theme/telemetry Anything related to telemetry or observability label Jul 21, 2020
jsosulska added a commit that referenced this issue 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 pushed a commit that referenced this issue 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 pushed a commit that referenced this issue 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 issue 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
theme/telemetry Anything related to telemetry or observability type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants