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

104152 Adjust Sharepoint criteria and add logging #21101

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

digitaldrk
Copy link
Contributor

@digitaldrk digitaldrk commented Mar 5, 2025

Summary

  • This work is behind a feature toggle (flipper): YES/NO: NO
  • (Summarize the changes that have been made to the platform): We alert Silent Errors for errors that are non-Sharepoint. We've had a couple instances where our Sharepoint check was not catching all instances of errors. We also tightly log when alerting so we can easily associate the silent error message with the alert. Here's an example:
Form5655Submission id: edb5302f-7a1d-4334-b4f1-3864f9c31ccc failed -- SharePoint Submission Failed: BackendServiceException: {:status=>401, :detail=>nil, :code=>"VA900", :source=>nil}.
Form5655Submission id: 10d872f9-21bd-4fd4-a6e5-642799e43c8c failed -- VHA set completed state: [#<struct Sidekiq::Batch::Status::Failure jid="5b3d58d8484303fb4c2f340c", error_class="Common::Exceptions::BackendServiceException", error_message="BackendServiceException: {:status=>500, :detail=>\"Internal Server Error\", :source=>\"SharepointRequest\", :code=>\"SHAREPOINT_PDF_502\"}", backtrace=nil>]
  • (If bug, how to reproduce): N/A
  • (What is the solution, why is this the solution?): We don't want to alert when there is a Sharepoint error. I changed how we detect Sharepoint errors so we can catch all scenarios. We are also logging the error message explicitly so it's easy to associate the error with the silent error trigger.
  • (Which team do you work for, does your team own the maintenance of this component?): Financial Management #financial-management on Octo Slack
  • (If introducing a flipper, what is the success criteria being targeted?): N/A

Related issue(s)

  • Link to ticket created in va.gov-team repo OR screenshot of Jira ticket if your team uses Jira: Ticket
  • Link to previous change of the code/bug (if applicable)
  • Link to epic if not included in ticket

Testing done

  • New code is covered by unit tests
  • Describe what the old behavior was prior to the change
  • Describe the steps required to verify your changes are working as expected. Exclusively stating 'Specs run' is NOT acceptable as appropriate testing
  • If this work is behind a flipper:
    • Tests need to be written for both the flipper on and flipper off scenarios. Docs.
    • What is the testing plan for rolling out the feature?

Screenshots

Note: Optional

What areas of the site does it impact?

(Describe what parts of the site are impacted andifcode touched other areas)

Acceptance criteria

  • I fixed|updated|added unit tests and integration tests for each feature (if applicable).
  • No error nor warning in the console.
  • Events are being sent to the appropriate logging solution
  • Documentation has been updated (link to documentation)
  • No sensitive information (i.e. PII/credentials/internal URLs/etc.) is captured in logging, hardcoded, or specs
  • Feature/bug has a monitor built into Datadog (if applicable)
  • If app impacted requires authentication, did you login to a local build and verify all authenticated routes work as expected
  • I added a screenshot of the developed feature

Requested Feedback

(OPTIONAL)What should the reviewers know in addition to the above. Is there anything specific you wish the reviewer to assist with. Do you have any concerns with this PR, why?

@va-vfs-bot va-vfs-bot temporarily deployed to 104152_adjust_share_point_and_add_logging_for_silent_error_alert/main/main March 5, 2025 17:12 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to 104152_adjust_share_point_and_add_logging_for_silent_error_alert/main/main March 5, 2025 17:30 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to 104152_adjust_share_point_and_add_logging_for_silent_error_alert/main/main March 6, 2025 01:05 Inactive
@va-vfs-bot va-vfs-bot temporarily deployed to 104152_adjust_share_point_and_add_logging_for_silent_error_alert/main/main March 6, 2025 01:28 Inactive
@digitaldrk digitaldrk force-pushed the 104152_adjust_share_point_and_add_logging_for_silent_error_alert branch from 2dc4a0d to 6bbf05b Compare March 6, 2025 04:24
@va-vfs-bot va-vfs-bot temporarily deployed to 104152_adjust_share_point_and_add_logging_for_silent_error_alert/main/main March 6, 2025 07:04 Inactive
@digitaldrk digitaldrk force-pushed the 104152_adjust_share_point_and_add_logging_for_silent_error_alert branch from 6bbf05b to 79832bc Compare March 6, 2025 13:52
@digitaldrk digitaldrk marked this pull request as ready for review March 6, 2025 14:48
@digitaldrk digitaldrk requested review from a team as code owners March 6, 2025 14:48
Copy link
Contributor

@Dr-Pongo Dr-Pongo left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

Copy link
Contributor

@OptionSelect OptionSelect left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

Copy link
Contributor

@amponce amponce left a comment

Choose a reason for hiding this comment

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

Looks clean 🚀

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

Successfully merging this pull request may close these issues.

5 participants