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 list of Platform Product-owned integrations to prevent silent failures #92926

Closed
6 tasks done
Tracked by #78234
jennb33 opened this issue Sep 16, 2024 · 9 comments
Closed
6 tasks done
Tracked by #78234
Assignees
Labels
2024 endpoint Used to identify endpoints that will be kept in the endpoint-library board in zenhub. engineering Engineering topics platform-product-team zero-silent-failures Work related to eliminating silent failures ZSF:Documentation Tickets related to discovery, documenting flows ZSF:Monitoring Add monitoring and tracking for silent errors (ie. Datadog)

Comments

@jennb33
Copy link
Contributor

jennb33 commented Sep 16, 2024

User Story

As the managers and developers of the VA Platform,
We need create a list of the list of integrations and endpoints that are managed within the VA system,
So that we know what integrations and endpoints will have to be watched for silent failures.

Issue Description

After the work for endpoints discovery is complete, we need to compile the list of integrations and endpoints that we need to monitor so that silent failures are eliminated.

Tasks

  • Create list of the integrations that are the responsibility of the Platform team and send to Clint for review with Jeff.
  • Create list of the endpoints that are the responsibility of the Platform team and send to Clint for review with Jeff.
  • Document all findings as above and link documentation either here or in comments
  • Create an artifact detailing any orphaned items identified during the ZSF discovery

Success Metrics

The Platform Product team will be aware of the integrations and endpoints that are to be monitored to ensure against any silent failures.

Acceptance Criteria

  • We will have a list of integrations and endpoints to monitor and ensure that there are no silent failures.
  • Forward artifact detailing any orphaned item to @LindseySaari and @little-oddball

Notes

Please review this guidance document for background and how-to discovery. This document was supplied by Matt Dingee.

Reference this document for past endpoint-specific work from the eMIS migration.


Validation

Assignee to add steps to this section. List the actions that need to be taken to confirm this issue is complete. Include any necessary links or context. State the expected outcome.

@jennb33 jennb33 added needs-grooming Use this to designate any issues that need grooming from the team engineering Engineering topics needs-refinement Identifies tickets that need to be refined endpoint Used to identify endpoints that will be kept in the endpoint-library board in zenhub. 2024 labels Sep 16, 2024
@jennb33 jennb33 assigned rmtolmach and unassigned LindseySaari Sep 17, 2024
@jennb33 jennb33 changed the title Create list of Platform Product endpoints to prevent silent failures Create list of Platform Product-owned integrations to prevent silent failures Sep 18, 2024
@jennb33 jennb33 removed needs-grooming Use this to designate any issues that need grooming from the team needs-refinement Identifies tickets that need to be refined labels Sep 18, 2024
@rmtolmach
Copy link
Contributor

See vets-api CODEOWNERS for files exclusively owned by backend-review-group.

@jennb33 jennb33 assigned rjohnson2011 and unassigned rmtolmach Sep 24, 2024
@jennb33
Copy link
Contributor Author

jennb33 commented Sep 26, 2024

@rjohnson2011
Copy link
Contributor

Assembled a list of endpoints and associated teams via CODEOWNERS. Cross-checking this data via Atlas and adding services as well.

@rjohnson2011
Copy link
Contributor

Finalizing report with data from Atlas, expecting to put have this available for review within the next day.

@rjohnson2011
Copy link
Contributor

Here is the spreadsheet with Platform endpoints and integrations -> https://docs.google.com/spreadsheets/d/1qqbkVT-lRpjxG58h3LKu3NczqJC2W7b7fYa93A6W_6A/edit?gid=1328380492#gid=1328380492

@rjohnson2011
Copy link
Contributor

In review, received feedback that some of the endpoints designated as "Platform Owned" in Atlas are not. We only want "backend-review-group" only teams for this list of endpoints. Taking another pass on this list.

@rjohnson2011
Copy link
Contributor

@rjohnson2011
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2024 endpoint Used to identify endpoints that will be kept in the endpoint-library board in zenhub. engineering Engineering topics platform-product-team zero-silent-failures Work related to eliminating silent failures ZSF:Documentation Tickets related to discovery, documenting flows ZSF:Monitoring Add monitoring and tracking for silent errors (ie. Datadog)
Projects
None yet
Development

No branches or pull requests

6 participants