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

Document the various event files produced by CI #1066

Merged
merged 1 commit into from
Jun 21, 2022

Conversation

DennisPeriquet
Copy link
Contributor

No description provided.

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 21, 2022
Copy link
Contributor

@dgoodwin dgoodwin left a comment

Choose a reason for hiding this comment

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

Let's give deads a few days for the upstream stuff he's on but then ping him about this next week. We'll definitely need his clarification.

* [Example](https://gcsweb-ci.apps.ci.l2s4.p1.openshiftapps.com/gcs/origin-ci-test/logs/periodic-ci-openshift-release-master-ci-4.11-upgrade-from-stable-4.10-e2e-gcp-ovn-upgrade/1505747388038385664/artifacts/e2e-gcp-ovn-upgrade/gather-must-gather/artifacts/event-filter.html)
* Tip: wait several seconds for the html page to finish rendering so you can use the text entry boxes to search

* events.json (same as events except as json)
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as event-filter.html.

* events (same as events.json except not json)
* generated via `oc get events --all-namespaces` (see [source code](https://github.com/openshift/release/blob/f5017d5136a740a4186477b02bed70047ade200b/ci-operator/step-registry/gather/extra/gather-extra-commands.sh#L62))
* located in the prow job stored artifacts at `.../gahter-extra/artifacts/oc_cmds/events`
* [Example](https://gcsweb-ci.apps.ci.l2s4.p1.openshiftapps.com/gcs/origin-ci-test/logs/periodic-ci-openshift-release-master-ci-4.11-upgrade-from-stable-4.10-e2e-gcp-ovn-upgrade/1505747388038385664/artifacts/e2e-gcp-ovn-upgrade/gather-extra/artifacts/oc_cmds/events)
Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't know this one existed.


* We talked about events related to [Devan's PR](https://github.com/openshift/origin/pull/26862) which we can document
more later
* These events are Monitor events (received by a Watcher)
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought these were the e2e-events above but now I'm not so sure. :)

* e2e-events_(date)-(number).json
* located in the prow job stored artifacts at `.../<test_name>/openshift-e2e-test/artifacts/junit`; there are two of them
* The smaller one contains ...
* The bigger one contains ...
Copy link
Contributor

Choose a reason for hiding this comment

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

My understanding was you get two files if you invoke openshift-tests twice, as we do for upgrade jobs.

@openshift-bot
Copy link

Inactive enhancement proposals go stale after 28d of inactivity.

See https://github.com/openshift/enhancements#life-cycle for details.

Mark the proposal as fresh by commenting /remove-lifecycle stale.
Stale proposals rot after an additional 7d of inactivity and eventually close.
Exclude this proposal from closing by commenting /lifecycle frozen.

If this proposal is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 21, 2022

* event-filter.html
* included in the output of a `oc adm must-gather`
* contains the events from all namespaces plus events that exist in the kube-apiserver at the time `oc adm must-gather` was run
Copy link
Contributor

Choose a reason for hiding this comment

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

not all events, just the events in namespaces gathered by must-gather. so namespaces not listed as relatedResources for clusteroperators will be missing.

* [Example](https://gcsweb-ci.apps.ci.l2s4.p1.openshiftapps.com/gcs/origin-ci-test/logs/periodic-ci-openshift-release-master-ci-4.11-upgrade-from-stable-4.10-e2e-gcp-ovn-upgrade/1505747388038385664/artifacts/e2e-gcp-ovn-upgrade/gather-extra/artifacts/events.json)

* events (same as `gather-extra/artifacts/events.json` except not json)
* generated via `oc get events --all-namespaces` (see [source code](https://github.com/openshift/release/blob/f5017d5136a740a4186477b02bed70047ade200b/ci-operator/step-registry/gather/extra/gather-extra-commands.sh#L62))
Copy link
Contributor

Choose a reason for hiding this comment

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

this one is all the events present in the apiserver at the end.

* [Example](https://gcsweb-ci.apps.ci.l2s4.p1.openshiftapps.com/gcs/origin-ci-test/logs/periodic-ci-openshift-release-master-ci-4.11-upgrade-from-stable-4.10-e2e-gcp-ovn-upgrade/1505747388038385664/artifacts/e2e-gcp-ovn-upgrade/gather-extra/artifacts/oc_cmds/events)

* resource-events_(date)-(number).zip
* located in the prow job stored artifacts at `.../<test_name>/openshift-e2e-test/artifacts/junit`; there are two of them (not sure why?)
Copy link
Contributor

Choose a reason for hiding this comment

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

two different openshift-tests invocations.

-rw-rw-r-- 1 dperique dperique 86468 Dec 31 1979 events.json
```

* e2e-events_(date)-(number).json
Copy link
Contributor

Choose a reason for hiding this comment

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

there are monitor events, not API events. the monitor is part of the openshift-tests invocation. They do not have the same info as the API events.

Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be worth the bother of renaming these? I believe this is fairly confusing for anyone who encounters them.

Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be worth the bother of renaming these? I believe this is fairly confusing for anyone who encounters them.

I'd merge it. I'd also merge a PR to write the raw events separate from the computed ones.

* located in the prow job stored artifacts at `.../gahter-extra/artifacts/oc_cmds/events`
* [Example](https://gcsweb-ci.apps.ci.l2s4.p1.openshiftapps.com/gcs/origin-ci-test/logs/periodic-ci-openshift-release-master-ci-4.11-upgrade-from-stable-4.10-e2e-gcp-ovn-upgrade/1505747388038385664/artifacts/e2e-gcp-ovn-upgrade/gather-extra/artifacts/oc_cmds/events)

* resource-events_(date)-(number).zip
Copy link
Contributor

Choose a reason for hiding this comment

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

these contain kube-apiserver events.


* core/events.yaml
* located in the must-gather.tar at `.../namespaces/(aNamespace)/core/events.yaml`; there is apparently one per namespace.
* ??? (I could not find where this is produced)
Copy link
Contributor

Choose a reason for hiding this comment

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

this is created by oc adm inspect, which is called by must-gather.

To aid in debugging, the Openshift CI (prow) produces various files related to events. The files
reside in the gather-must-gather and gather-extra subdirectories in the artifacts storage area.
You will see the "Artifacts" link in the upper right of a prow job (for example, see
[this prow job](https://prow.ci.openshift.org/view/gs/origin-ci-test/logs/periodic-ci-openshift-release-master-ci-4.11-upgrade-from-stable-4.10-e2e-gcp-ovn-upgrade/1505747388038385664).
Copy link
Member

@wking wking Apr 29, 2022

Choose a reason for hiding this comment

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

nit: we eventually garbage-collect these artifacts. Might be worth explaining how to get to a recent run, like going through https://prow.ci.openshift.org/?job=periodic*e2e-aws&state=success ?


* event-filter.html
* included in the output of a `oc adm must-gather`
* contains events from namespaces gathered by `oc adm must-gather` plus events that exist in the kube-apiserver at the time `oc adm must-gather` was run.
Copy link
Member

@wking wking Apr 29, 2022

Choose a reason for hiding this comment

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

how do "events that exist in the kube-apiserver" differ from the ones must-gather collected? Ah, because must-gather is only walking relatedResources.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is that true? I'd have figured events falls into a category of things must-gather would grab globally without need of related resources.

Namespaces not listed as relatedResources for clusteroperators will be missing.
* located in the prow job stored artifacts at `.../gather-must-gather/artifacts/` and contained in the must-gather.tar
file in that same location
* [Example](https://gcsweb-ci.apps.ci.l2s4.p1.openshiftapps.com/gcs/origin-ci-test/logs/periodic-ci-openshift-release-master-ci-4.11-upgrade-from-stable-4.10-e2e-gcp-ovn-upgrade/1505747388038385664/artifacts/e2e-gcp-ovn-upgrade/gather-must-gather/artifacts/event-filter.html)
Copy link
Member

Choose a reason for hiding this comment

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

before we get down to individual step content like this, it's probably worth talking about the .../{job-name}/{run-id}/artifacts/{job-slug}/{step-name}/artifacts/ structure to get artifacts from each step. Once we have established that pattern, we can say things like "in gather-must-gather assets" without having to steps to get there or linking to things that will be garbage collected a few months from now.

* Tip: wait several seconds for the html page to finish rendering so you can use the text entry boxes to search

* events.json (same as `oc_cmds/events` mentioned below except as json)
* generated via `oc get events --all-namespaces -o json” (see [source code](https://github.com/openshift/release/blob/f5017d5136a740a4186477b02bed70047ade200b/ci-operator/step-registry/gather/extra/gather-extra-commands.sh#L61))
Copy link
Member

Choose a reason for hiding this comment

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

nit: unbalanced quoting aroudn the oc ... command here.

```
./default:
total 332
-rw-rw-r-- 1 dperique dperique 339013 Dec 31 1979 events.json <-- why the ancient date?
Copy link
Member

@wking wking Apr 29, 2022

Choose a reason for hiding this comment

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

that's the Unix epoc, and is just showing the timestamp property was left unset.

@openshift-bot
Copy link

Stale enhancement proposals rot after 7d of inactivity.

See https://github.com/openshift/enhancements#life-cycle for details.

Mark the proposal as fresh by commenting /remove-lifecycle rotten.
Rotten proposals close after an additional 7d of inactivity.
Exclude this proposal from closing by commenting /lifecycle frozen.

If this proposal is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

@openshift-ci openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 10, 2022
@DennisPeriquet
Copy link
Contributor Author

/remove-lifecycle stale

@openshift-bot
Copy link

Rotten enhancement proposals close after 7d of inactivity.

See https://github.com/openshift/enhancements#life-cycle for details.

Reopen the proposal by commenting /reopen.
Mark the proposal as fresh by commenting /remove-lifecycle rotten.
Exclude this proposal from closing again by commenting /lifecycle frozen.

/close

@openshift-ci openshift-ci bot closed this May 17, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented May 17, 2022

@openshift-bot: Closed this PR.

In response to this:

Rotten enhancement proposals close after 7d of inactivity.

See https://github.com/openshift/enhancements#life-cycle for details.

Reopen the proposal by commenting /reopen.
Mark the proposal as fresh by commenting /remove-lifecycle rotten.
Exclude this proposal from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@DennisPeriquet
Copy link
Contributor Author

/reopen

@openshift-ci openshift-ci bot reopened this May 17, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented May 17, 2022

@DennisPeriquet: Reopened this PR.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@deads2k
Copy link
Contributor

deads2k commented May 18, 2022

/lgtm

@DennisPeriquet DennisPeriquet changed the title WIP: Document the various event files produced by CI Document the various event files produced by CI May 18, 2022
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 18, 2022
@openshift-ci openshift-ci bot added lgtm Indicates that a PR is ready to be merged. and removed lgtm Indicates that a PR is ready to be merged. labels May 18, 2022
@deads2k
Copy link
Contributor

deads2k commented May 18, 2022

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 18, 2022
@DennisPeriquet
Copy link
Contributor Author

/remove-lifecycle rotten

@openshift-ci openshift-ci bot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label May 18, 2022
@openshift-bot
Copy link

Inactive enhancement proposals go stale after 28d of inactivity.

See https://github.com/openshift/enhancements#life-cycle for details.

Mark the proposal as fresh by commenting /remove-lifecycle stale.
Stale proposals rot after an additional 7d of inactivity and eventually close.
Exclude this proposal from closing by commenting /lifecycle frozen.

If this proposal is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 15, 2022
@DennisPeriquet
Copy link
Contributor Author

/lifecycle frozen

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jun 16, 2022

@DennisPeriquet: The lifecycle/frozen label cannot be applied to Pull Requests.

In response to this:

/lifecycle frozen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@stbenjam
Copy link
Member

/approve

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jun 21, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: stbenjam

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 21, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jun 21, 2022

@DennisPeriquet: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@openshift-ci openshift-ci bot merged commit c3b66bd into openshift:master Jun 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants