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

Create Incidents on Rule Failure #947

Closed
wants to merge 16 commits into from
Closed

Conversation

jmedway614
Copy link
Contributor

Fixes FER-

Short description of the changes made

This creates an incident based on a rule failure. An example of the report can be seen here:
Screenshot 2024-06-02 at 7 06 44 PM

I wasn't able to specifically assign to someone "on call". I could only see a specific ID I had to add. I also only tested it in "test" mode.

let me know if you like the messages and title of the incident. Happy to change if desired.

What was the motivation & context behind this PR?

How has this PR been tested?

Remove this, otherwise it will alert all that this template has not been filled out

@jmedway614 jmedway614 requested a review from dsinghvi as a code owner June 2, 2024 23:09
Copy link

vercel bot commented Jun 2, 2024

@jmedway614 is attempting to deploy a commit to the fern Team on Vercel.

To accomplish this, @jmedway614 needs to request access to the Team.

Afterwards, an owner of the Team is required to accept their membership request.

If you're already a member of the respective Vercel Team, make sure that your Personal Vercel Account is connected to your GitHub account.

Copy link

github-actions bot commented Jun 2, 2024

Copy link

github-actions bot commented Jun 2, 2024

@dsinghvi
Copy link
Member

dsinghvi commented Jun 2, 2024

@jmedway614 Couple thoughts:

  1. can we track which URLs are failing to load (otherwise itll be too hard for the on-call engineer to isolate)
  2. what happens if there are multiple failing URLs? would be better to create 1 incident for all the failures instead of n incidents

@@ -30,11 +31,17 @@ void yargs(hideBin(process.argv))
for (const result of results) {
if (result.success) {
console.log(`:white_check_mark: Rule ${result.name} passed`);
break;
Copy link
Member

Choose a reason for hiding this comment

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

it would be great to add a mode to the CLI that determines whether or not to trigger the incident (i.e. for local testing)

Copy link
Member

Choose a reason for hiding this comment

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

--createIncident ?

Copy link

vercel bot commented Jun 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
fern-dev ✅ Ready (Inspect) Visit Preview Jun 7, 2024 0:01am
3 Ignored Deployments
Name Status Preview Updated (UTC)
fern-prod ⬜️ Ignored (Inspect) Jun 7, 2024 0:01am
fontawesome-cdn ⬜️ Ignored (Inspect) Jun 7, 2024 0:01am
private-docs ⬜️ Ignored (Inspect) Jun 7, 2024 0:01am

Copy link

github-actions bot commented Jun 3, 2024

Copy link

github-actions bot commented Jun 3, 2024

Copy link

github-actions bot commented Jun 3, 2024

Copy link

github-actions bot commented Jun 3, 2024

Copy link

github-actions bot commented Jun 3, 2024

@jmedway614
Copy link
Contributor Author

jmedway614 commented Jun 3, 2024

ok I added generateIncident, included all failed rules in the ticket, and migrated it to only 1 incident. One note is the way it's currently setup we are using "idempotencyKey" to avoid deduping. In testing it seems to regenerate if the ticket is resolved but we should double check that happens in "standard" mode.

I also tried to refactor the test a little to take advantage of asynchronous calls.

Copy link

github-actions bot commented Jun 3, 2024

Copy link

github-actions bot commented Jun 6, 2024

Copy link

github-actions bot commented Jun 6, 2024

Copy link

github-actions bot commented Jun 6, 2024

Copy link

github-actions bot commented Jun 6, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants