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

Sentry ADR #3206

Merged
merged 51 commits into from
Oct 2, 2024
Merged

Sentry ADR #3206

merged 51 commits into from
Oct 2, 2024

Conversation

raftmsohani
Copy link

Summary of Changes

Provide a brief summary of changes
Pull request closes #_

How to Test

List the steps to test the PR
These steps are generic, please adjust as necessary.

cd tdrs-frontend && docker-compose -f docker-compose.yml -f docker-compose.local.yml up -d
cd tdrs-backend && docker-compose -f docker-compose.yml -f docker-compose.local.yml up -d 
  1. Open http://localhost:3000/ and sign in.
  2. Proceed with functional tests as described herein.
  3. Test steps should be captured in the demo GIF(s) and/or screenshots below.

Demo GIF(s) and screenshots for testing procedure

Deliverables

More details on how deliverables herein are assessed included here.

Deliverable 1: Accepted Features

Checklist of ACs:

  • [insert ACs here]
  • lfrohlich and/or adpennington confirmed that ACs are met.

Deliverable 2: Tested Code

  • Are all areas of code introduced in this PR meaningfully tested?
    • If this PR introduces backend code changes, are they meaningfully tested?
    • If this PR introduces frontend code changes, are they meaningfully tested?
  • Are code coverage minimums met?
    • Frontend coverage: [insert coverage %] (see CodeCov Report comment in PR)
    • Backend coverage: [insert coverage %] (see CodeCov Report comment in PR)

Deliverable 3: Properly Styled Code

  • Are backend code style checks passing on CircleCI?
  • Are frontend code style checks passing on CircleCI?
  • Are code maintainability principles being followed?

Deliverable 4: Accessible

  • Does this PR complete the epic?
  • Are links included to any other gov-approved PRs associated with epic?
  • Does PR include documentation for Raft's a11y review?
  • Did automated and manual testing with iamjolly and ttran-hub using Accessibility Insights reveal any errors introduced in this PR?

Deliverable 5: Deployed

  • Was the code successfully deployed via automated CircleCI process to development on Cloud.gov?

Deliverable 6: Documented

  • Does this PR provide background for why coding decisions were made?
  • If this PR introduces backend code, is that code easy to understand and sufficiently documented, both inline and overall?
  • If this PR introduces frontend code, is that code easy to understand and sufficiently documented, both inline and overall?
  • If this PR introduces dependencies, are their licenses documented?
  • Can reviewer explain and take ownership of these elements presented in this code review?

Deliverable 7: Secure

  • Does the OWASP Scan pass on CircleCI?
  • Do manual code review and manual testing detect any new security issues?
  • If new issues detected, is investigation and/or remediation plan documented?

Deliverable 8: User Research

Research product(s) clearly articulate(s):

  • the purpose of the research
  • methods used to conduct the research
  • who participated in the research
  • what was tested and how
  • impact of research on TDP
  • (if applicable) final design mockups produced for TDP development

elipe17 and others added 30 commits September 4, 2024 13:19
- Added extra console logging
- changed log level on frequent exception
- Update all files done logic
- Add new test for sequential execution
- change order
- Update test to create fields with correct type
@raftmsohani raftmsohani self-assigned this Oct 1, 2024
Copy link

codecov bot commented Oct 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.66%. Comparing base (6f2105f) to head (cf56075).
Report is 243 commits behind head on doc/3199-monitoring-adr.

Additional details and impacted files

Impacted file tree graph

@@                     Coverage Diff                     @@
##           doc/3199-monitoring-adr    #3206      +/-   ##
===========================================================
+ Coverage                    91.40%   92.66%   +1.25%     
===========================================================
  Files                          289       47     -242     
  Lines                         7997     1009    -6988     
  Branches                       746      169     -577     
===========================================================
- Hits                          7310      935    -6375     
+ Misses                         581       42     -539     
+ Partials                       106       32      -74     
Flag Coverage Δ
dev-backend ?
dev-frontend 92.66% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 242 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e5f110c...cf56075. Read the comment docs.

@andrew-jameson andrew-jameson changed the base branch from develop to doc/3199-monitoring-adr October 2, 2024 17:05
@andrew-jameson andrew-jameson merged commit 16d6e54 into doc/3199-monitoring-adr Oct 2, 2024
15 checks passed
@andrew-jameson andrew-jameson deleted the sentry-adr branch October 2, 2024 17:22
andrew-jameson added a commit that referenced this pull request Oct 28, 2024
* first steps on ADR

* First pass on monitoring ADR

* Sentry ADR (#3206)

* - Updated method to batch delete records in elastic to avoid pulling whole queryset into memory

* - Instantiate document once

* - Updated clean and reparse to not load entire queryset into memory
- Added extra console logging
- changed log level on frequent exception

* - Update names of functions
- Add tests

* - Update sequential function to return boolean to allow testing
- Update all files done logic
- Add new test for sequential execution

* - new indices

* - linting

* - Added tests for most exception paths

* -linting

* - Adding refresh

* - testing not duplicating container

* - revert test change
- change order

* - remove param

* - Add missing tests

* - adding test

* - Add remaining tests

* - Add more debug logging

* - running only failing test

* - more debugging

* - backend only

* - remove test_reparse only

* - Reset settings after parsing

* - update file

* - Update factories to use the correct types for fields
- Update test to create fields with correct type

* - paremetrize test

* - revert debugging changes

* - Add tests for more coverage

* - linting

* - UPdate logic for setting reparse to finished
- add tests for meta model methods

* - linting

* - add basic tests for db backup

* - remove mock

* - add main routine test for backup

* - linting

* - Added comment for posterity

* - Update reparse to not fail/exit when elastic throws index update. instead aggregate errors and log a warning message for the user.

* - update terraform for testing

* - Update terraform based on cloud.gov response
- Give Prod at least 500GB

* Sentry ADR

---------

Co-authored-by: Eric Lipe <[email protected]>
Co-authored-by: Eric Lipe <[email protected]>
Co-authored-by: Alex P. <[email protected]>

* Incorporating Sentry, split into two buckets.

* Updated boundary diagram

* New env diagram

* Verbiage update to markdown

* Latest diagram revision

* Apply suggestions from code review

Co-authored-by: Alex P.  <[email protected]>

* - small grammar and wording changes

* Update docs/Technical-Documentation/Architecture-Decision-Record/022-app-monitoring.md

Co-authored-by: Alex P.  <[email protected]>

* Updated diagram for better repr around ATO boundary

---------

Co-authored-by: andrew-jameson <[email protected]>
Co-authored-by: raftmsohani <[email protected]>
Co-authored-by: Eric Lipe <[email protected]>
Co-authored-by: Eric Lipe <[email protected]>
Co-authored-by: Alex P. <[email protected]>
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.

4 participants