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

Add runbooks for API response times alarms #3001

Merged
merged 4 commits into from
Sep 21, 2023

Conversation

krysal
Copy link
Member

@krysal krysal commented Sep 8, 2023

Fixes

Related to #2501 by @sarayourfriend

Description

Adds the run books for the general API response time alarms.

Testing Instructions

Look for the preview in the comments and check that the instructions make sense.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@krysal krysal requested a review from a team as a code owner September 8, 2023 20:06
@krysal krysal requested review from obulat and dhruvkb September 8, 2023 20:06
@github-actions github-actions bot added the 🧱 stack: documentation Related to Sphinx documentation label Sep 8, 2023
@openverse-bot openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Sep 8, 2023
@krysal krysal added 🟧 priority: high Stalls work on the project or its dependents 🌟 goal: addition Addition of new feature 📄 aspect: text Concerns the textual material in the repository and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Sep 8, 2023
@krysal krysal force-pushed the add/api_time_resp_alarms_runbooks branch 3 times, most recently from bc09b1a to 327e443 Compare September 8, 2023 20:40
@krysal krysal mentioned this pull request Sep 8, 2023
1 task
@krysal krysal force-pushed the add/api_time_resp_alarms_runbooks branch from 327e443 to f69a7f8 Compare September 8, 2023 22:24
@krysal krysal changed the title Add runbooks for API response times Add runbooks for API response times alarms Sep 9, 2023
@krysal krysal force-pushed the add/api_time_resp_alarms_runbooks branch from f69a7f8 to 08407a9 Compare September 11, 2023 17:30
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

Looks like both of these runbooks are largely identical in content (as they should be, they're both for response times and likely to co-occur frequently). Can they both be combined into a single runbook instead?

That's an infra change, which might delay things, so I'm approving this to unblock. LGTM!

@krysal krysal force-pushed the add/api_time_resp_alarms_runbooks branch 2 times, most recently from 6adedf9 to 051b2d9 Compare September 15, 2023 13:49
@openverse-bot
Copy link
Collaborator

Based on the high urgency of this PR, the following reviewers are being gently reminded to review this PR:

@obulat
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was ready for review 6 day(s) ago. PRs labelled with high urgency are expected to be reviewed within 2 weekday(s)2.

@krysal, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

The links should be updated, and probably the heading.

@krysal krysal force-pushed the add/api_time_resp_alarms_runbooks branch from b05c01f to 76adc28 Compare September 20, 2023 16:40
@krysal krysal requested a review from obulat September 20, 2023 16:42
@krysal
Copy link
Member Author

krysal commented Sep 20, 2023

@obulat I added the runbooks for the anomaly response alarms (WordPress/openverse-infrastructure#622), I'll await your review on this.

@krysal krysal force-pushed the add/api_time_resp_alarms_runbooks branch from f57cfe7 to 8f53e8c Compare September 21, 2023 20:07
@krysal krysal merged commit de7e142 into main Sep 21, 2023
@krysal krysal deleted the add/api_time_resp_alarms_runbooks branch September 21, 2023 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants