Skip to content

Commit

Permalink
adds fixes for review comments
Browse files Browse the repository at this point in the history
adds a generated toc
  • Loading branch information
RobertKielty committed May 31, 2021
1 parent 3b25079 commit d9a6347
Showing 1 changed file with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions contributors/devel/sig-testing/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,41 @@ description: |
## Monitoring Kubernetes Health

### Table of Contents
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
**Table of Contents**

- [-](#-)
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
- [Monitoring the health of Kubernetes CI Jobs with TestGrid](#monitoring-the-health-of-kubernetes-ci-jobs-with-testgrid)
- [What dashboards should I monitor?](#what-dashboards-should-i-monitor)
- [Pull request test failures caused by tests unrelated to your change](#pull-request-test-failures-caused-by-tests-unrelated-to-your-change)
- [What do I do when I see a TestGrid alert?](#what-do-i-do-when-i-see-a-testgrid-alert)
- [Communicate your findings](#communicate-your-findings)
- [Creating a GitHub Issue for Flaking or Failing Tests](#creating-a-github-issue-for-flaking-or-failing-tests)
- [Fill out the issue for a Flaking Test](#fill-out-the-issue-for-a-flaking-test)
- [Iterate](#iterate)

<!-- markdown-toc end -->

- [Monitoring the health of Kubernetes with TestGrid](#monitoring-the-health-of-kubernetes-with-testgrid)
- [What dashboards should I monitor?](#what-dashboards-should-i-monitor)
- [Test failures that block my Pull Request](#pr-test-failures)
- [What do I do when I see a TestGrid alert?](#what-do-i-do-when-i-see-a-testgrid-alert)
- [Communicate your findings](#communicate-your-findings)
- [Fill out the issue](#fill-out-the-issue)
- [Creating a GitHub Issue for Flaking or Failing Tests](#creating-a-github-issue-for-flaking-or-failing-tests)
- [Iterate](#iterate)

## Overview

This document describes the tools used to monitor CI jobs that check the
correctness of changes made to core Kubernetes.
This document describes the tools used to monitor CI jobs and the tests that
they run that check the correctness of changes made to core Kubernetes.

## Monitoring the health of Kubernetes CI Jobs with TestGrid

TestGrid is a highly-configurable, interactive dashboard for viewing your test
results in a grid. TestGrid's back end components are open sourced and can be
viewed in the [TestGrid repo] The front-end code
viewed in the [TestGrid repo] The front-end code
that renders the dashboard is not currently open sourced.

The Kubernetes community has its own [TestGrid instance] which we use to monitor
Expand Down Expand Up @@ -162,7 +178,7 @@ You can:

- Add a link to the Prow job where the latest test failure has occurred, and
- Note the error message

New evidence is especially useful if the root cause of the problem with the test
has not yet been determined and the issue still has a *needs-triage* label.

Expand All @@ -174,7 +190,7 @@ You can jump to create either test issue type using the following links :
- [create a new issue - Failing Test]
- [create a new issue - Flaking Test]

#### Filling out an issue
#### Creating a GitHub Issue for Flaking or Failing Tests

Both test issue templates are reasonably self-explanatory, what follows are
guidelines and tips on filling out the templates.
Expand Down Expand Up @@ -250,7 +266,7 @@ community, as the issue reporter you do not have to find the reason for failure
right away (nor the solution). You can just log the error reported by the test
when the job was run.

Click on the failed runs (the red cells in the grid) to see the results in
Click on the failed runs (the red cells in the grid) to see the results in
SpyGlass.

For `node-kubelet-master`, we see the following:
Expand Down Expand Up @@ -322,6 +338,7 @@ issue! All issues are unique and require a bit of experience to figure out how
to work on them. For the time being, reach out to people in Slack or the mailing
list.

<!-- links -->
[TestGrid repo]: https://github.com/GoogleCloudPlatform/testgrid
[TestGrid instance]: https://testgrid.k8s.io/

Expand Down

0 comments on commit d9a6347

Please sign in to comment.