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

Improve metrics readyz/healthz documentation around recovery and probing #10799

Closed
pschisa opened this issue Mar 3, 2022 · 1 comment
Closed

Improve metrics readyz/healthz documentation around recovery and probing #10799

pschisa opened this issue Mar 3, 2022 · 1 comment
Assignees
@zmb3
Labels
c-bi Internal Customer Reference c-cv Internal Customer Reference documentation

Comments

@pschisa
Copy link
Contributor

pschisa commented Mar 3, 2022

Details

https://goteleport.com/docs/setup/reference/metrics/ provides minimal documentation how the metrics endpoints function.

Request is to add further details such as the probing interval and if that can be influenced on these endpoints. This will help customers understand expectations on recovery times, which is crucial if using these endpoints for health checks.

Category

  • Improve Existing
@pschisa pschisa added documentation c-cv Internal Customer Reference labels Mar 3, 2022
@pschisa pschisa added the c-bi Internal Customer Reference label Mar 10, 2022
@russjones
Copy link
Contributor

@zmb3 Let's find out how much time it takes to recover and update documentation.

@zmb3 zmb3 mentioned this issue Mar 11, 2022
Merged
zmb3 added a commit that referenced this issue Mar 11, 2022
@zmb3
docs: clarify /healthz and /readyz
0a199b1 
Updates #10799
zmb3 added a commit that referenced this issue Mar 14, 2022
@zmb3
docs: clarify /healthz and /readyz
b1a54c6 
Updates #10799
zmb3 added a commit that referenced this issue Mar 16, 2022
@zmb3
docs: clarify /healthz and /readyz
3b80577 
Updates #10799
zmb3 added a commit that referenced this issue Mar 17, 2022
@zmb3 @ptgott
docs: clarify /healthz and /readyz (#11085)
072956e 
- Rename the page, since it's about diagnostics rather than metrics
  alone
- Change major section headings to H2s so they apper in the table of
  contents
- Move information about heartbeats and recovery to an H3 so it's
  more visible

Updates #10799

Co-authored-by: Paul Gottschling <[email protected]>
zmb3 added a commit that referenced this issue Mar 17, 2022
@zmb3 @ptgott
docs: clarify /healthz and /readyz (#11085)
3e18a4a 
- Rename the page, since it's about diagnostics rather than metrics
  alone
- Change major section headings to H2s so they apper in the table of
  contents
- Move information about heartbeats and recovery to an H3 so it's
  more visible

Updates #10799

Co-authored-by: Paul Gottschling <[email protected]>
zmb3 added a commit that referenced this issue Mar 17, 2022
@zmb3 @ptgott
docs: clarify /healthz and /readyz (#11085)
f94206c 
- Rename the page, since it's about diagnostics rather than metrics
  alone
- Change major section headings to H2s so they apper in the table of
  contents
- Move information about heartbeats and recovery to an H3 so it's
  more visible

Updates #10799

Co-authored-by: Paul Gottschling <[email protected]>
zmb3 added a commit that referenced this issue Mar 17, 2022
@zmb3 @ptgott
docs: clarify /healthz and /readyz (#11085)
67ce5a2 
- Rename the page, since it's about diagnostics rather than metrics
  alone
- Change major section headings to H2s so they apper in the table of
  contents
- Move information about heartbeats and recovery to an H3 so it's
  more visible

Updates #10799

Co-authored-by: Paul Gottschling <[email protected]>
zmb3 added a commit that referenced this issue Mar 18, 2022
@zmb3 @ptgott
docs: clarify /healthz and /readyz (#11085) (#11231)
65a3f65 
- Rename the page, since it's about diagnostics rather than metrics
  alone
- Change major section headings to H2s so they apper in the table of
  contents
- Move information about heartbeats and recovery to an H3 so it's
  more visible

Updates #10799

Co-authored-by: Paul Gottschling <[email protected]>

Co-authored-by: Paul Gottschling <[email protected]>
ptgott added a commit that referenced this issue Mar 18, 2022
@zmb3 @ptgott
docs: clarify /healthz and /readyz (#11085)
3514ab9 
- Rename the page, since it's about diagnostics rather than metrics
  alone
- Change major section headings to H2s so they apper in the table of
  contents
- Move information about heartbeats and recovery to an H3 so it's
  more visible

Updates #10799

Co-authored-by: Paul Gottschling <[email protected]>
zmb3 added a commit that referenced this issue Mar 18, 2022
@zmb3 @ptgott
docs: clarify /healthz and /readyz (#11085) (#11233)
83dbf72 
- Rename the page, since it's about diagnostics rather than metrics
  alone
- Change major section headings to H2s so they apper in the table of
  contents
- Move information about heartbeats and recovery to an H3 so it's
  more visible

Updates #10799

Co-authored-by: Paul Gottschling <[email protected]>

Co-authored-by: Paul Gottschling <[email protected]>
zmb3 added a commit that referenced this issue Mar 18, 2022
@zmb3 @ptgott
docs: clarify /healthz and /readyz (#11085) (#11232)
c75ec50 
- Rename the page, since it's about diagnostics rather than metrics
  alone
- Change major section headings to H2s so they apper in the table of
  contents
- Move information about heartbeats and recovery to an H3 so it's
  more visible

Updates #10799

Co-authored-by: Paul Gottschling <[email protected]>

Co-authored-by: Paul Gottschling <[email protected]>
@zmb3 zmb3 closed this as completed Jun 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zmb3 zmb3

Labels
c-bi Internal Customer Reference c-cv Internal Customer Reference documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@russjones @zmb3 @pschisa