New Relic Table Check

[asteel-gsa]

Requires:
GSA-TTS/fac-backup-utility#8 to be merged prior to this
GSA-TTS/fac-backup-utility#9 to be merged. The current formatting is wrong, so I stored it in a json object which should hopefully add it to one line in new relic. 🤞

• Adds 4 new widgets to New Relic Log Review Dashboard
  
• Adds a new widget that captures Submissions and the latest Backup event within a 2 hour window
  
• Version bump fac-backup-util v0.1.6 v0.1.7 v0.1.8
• Run table check on demand with workflow_dispatch
• Run table check every 12 hours with cron
• Run table check after every deploy with workflow_call
• While fac-backup-utility #7 adds CHECKTABLESPASS and CHECKTABLESFAIL we will not be using CHECKTABLESFAIL for the NR dashboard, as DBMISSINGTABLES keyword will also output a list of tables that exist in the database, but not in the manifest of fac-backup-util
• Adds a row check to each table in the database based on the manifest in fac-backup-util
• raw json about row counts
  
  

Deployment: Preview

Partial implementation of #3953

PR Checklist: Submitter

• Link to an issue if possible. If there’s no issue, describe what your branch does. Even if there is an issue, a brief description in the PR is still useful.
• List any special steps reviewers have to follow to test the PR. For example, adding a local environment variable, creating a local test file, etc.
• For extra credit, submit a screen recording like this one.
• Make sure you’ve merged main into your branch shortly before creating the PR. (You should also be merging main into your branch regularly during development.)
• Make sure you’ve accounted for any migrations. When you’re about to create the PR, bring up the application locally and then run git status | grep migrations. If there are any results, you probably need to add them to the branch for the PR. Your PR should have only one new migration file for each of the component apps, except in rare circumstances; you may need to delete some and re-run python manage.py makemigrations to reduce the number to one. (Also, unless in exceptional circumstances, your PR should not delete any migration files.)
• Make sure that whatever feature you’re adding has tests that cover the feature. This includes test coverage to make sure that the previous workflow still works, if applicable.
• Make sure the full-submission.cy.js Cypress test passes, if applicable.
• Do manual testing locally. Our tests are not good enough yet to allow us to skip this step. If that’s not applicable for some reason, check this box.
• Verify that no Git surgery was necessary, or, if it was necessary at any point, repeat the testing after it’s finished.
• Once a PR is merged, keep an eye on it until it’s deployed to dev, and do enough testing on dev to verify that it deployed successfully, the feature works as expected, and the happy path for the broad feature area (such as submission) still works.
• Ensure that prior to merging, the working branch is up to date with main and the terraform plan is what you expect.

PR Checklist: Reviewer

• Pull the branch to your local environment and run make docker-clean; make docker-first-run && docker compose up; then run docker compose exec web /bin/bash -c "python manage.py test"
• Manually test out the changes locally, or check this box to verify that it wasn’t applicable in this case.
• Check that the PR has appropriate tests. Look out for changes in HTML/JS/JSON Schema logic that may need to be captured in Python tests even though the logic isn’t in Python.
• Verify that no Git surgery is necessary at any point (such as during a merge party), or, if it was, repeat the testing after it’s finished.

The larger the PR, the stricter we should be about these points.

Pre Merge Checklist: Merger

• Ensure that prior to approving, the terraform plan is what we expect it to be. -/+ resource "null_resource" "cors_header" should be destroying and recreating its self and ~ resource "cloudfoundry_app" "clamav_api" might be updating its sha256 for the fac-file-scanner and fac-av-${ENV} by default.
• Ensure that the branch is up to date with main.
• Ensure that a terraform plan has been recently generated for the pull request.

[github-actions]

Terraform plan for dev

Plan: 1 to add, 1 to change, 1 to destroy.

Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
!~  update in-place
-/+ destroy and then create replacement

Terraform will perform the following actions:

  # module.dev.module.cors.null_resource.cors_header must be replaced
-/+ resource "null_resource" "cors_header" {
!~      id       = "*******************" -> (known after apply)
!~      triggers = { # forces replacement
!~          "always_run" = "2024-10-10T19:46:55Z" -> (known after apply)
        }
    }

  # module.dev.module.newrelic.newrelic_one_dashboard.log_review_dashboard will be updated in-place
!~  resource "newrelic_one_dashboard" "log_review_dashboard" {
        id          = "MzkxOTA3NnxWSVp8REFTSEJPQVJEfGRhOjYzNjMwMjQ"
        name        = "FAC Log Review (dev)"
#        (4 unchanged attributes hidden)

!~      page {
            name        = "FAC Log Review"
#            (2 unchanged attributes hidden)

+           widget_billboard {
+               column         = 9
+               height         = 3
+               legend_enabled = true
+               row            = 8
+               title          = "dev Table Check Count - Pass"
+               width          = 3

+               nrql_query {
+                   query = "SELECT count(*) FROM Log WHERE `tags.space_name` = 'dev' AND allColumnSearch('CHECKTABLESPASS', insensitive: true) SINCE 7 days ago"
                }
            }
+           widget_billboard {
+               column         = 9
+               height         = 3
+               legend_enabled = true
+               row            = 9
+               title          = "dev Table Check Count - Fail"
+               width          = 3

+               nrql_query {
+                   query = "SELECT count(*) FROM Log WHERE `tags.space_name` = 'dev' AND allColumnSearch('DBMISSINGTABLES', insensitive: true) SINCE 7 days ago"
                }
            }

+           widget_log_table {
+               column         = 1
+               height         = 3
+               legend_enabled = true
+               row            = 8
+               title          = "dev Check Tables Logs"
+               width          = 8

+               nrql_query {
+                   query = "SELECT `message` FROM Log WHERE `tags.space_name` = 'dev' AND allColumnSearch('CHECKTABLESPASS', insensitive: true) SINCE 7 days ago"
                }
            }
+           widget_log_table {
+               column         = 1
+               height         = 3
+               legend_enabled = true
+               row            = 9
+               title          = "dev Missing Tables Logs"
+               width          = 8

+               nrql_query {
+                   query = "SELECT `message` FROM Log WHERE `tags.space_name` = 'dev' AND allColumnSearch('DBMISSINGTABLES', insensitive: true) SINCE 7 days ago"
                }
            }

+           widget_table {
+               column              = 1
+               height              = 3
+               legend_enabled      = true
+               linked_entity_guids = (known after apply)
+               row                 = 10
+               title               = "dev Backups and Submissions"
+               width               = 8

+               nrql_query {
+                   query = "SELECT `message` FROM Log WHERE allColumnSearch('POST', insensitive: true) AND allColumnSearch('/submission/', insensitive: true) AND `newrelic.source` = 'logs.APM' AND entity.name ='dev' SINCE 2 hours ago"
                }
+               nrql_query {
+                   query = "SELECT `message`,`timestamp` FROM Log WHERE allColumnSearch('STARTUP_CHECK', insensitive: true) AND `message` LIKE '%db_to_s3%' AND `message` LIKE '%PASS%' AND tags.space_name ='dev' SINCE 2 hours ago"
                }
            }
+           widget_table {
+               column              = 1
+               height              = 3
+               legend_enabled      = true
+               linked_entity_guids = (known after apply)
+               row                 = 11
+               title               = "dev Backup and Row Count"
+               width               = 8

+               nrql_query {
+                   query = "SELECT `message` FROM Log WHERE `tags.space_name` = 'dev' AND allColumnSearch('\"TABLEROWCOUNT\"', insensitive: true) SINCE 2 hours ago"
                }
+               nrql_query {
+                   query = "SELECT `message`,`timestamp` FROM Log WHERE allColumnSearch('STARTUP_CHECK', insensitive: true) AND `message` LIKE '%db_to_s3%' AND `message` LIKE '%PASS%' AND tags.space_name ='dev' SINCE 2 hours ago"
                }
            }
+           widget_table {
+               column              = 1
+               height              = 3
+               legend_enabled      = true
+               linked_entity_guids = (known after apply)
+               row                 = 12
+               title               = "dev Row Count"
+               width               = 8

+               nrql_query {
+                   query = "SELECT `message` FROM Log WHERE `tags.space_name` = 'dev' AND allColumnSearch('\"TABLEROWCOUNT\"', insensitive: true) SINCE 7 days ago"
                }
            }

#            (13 unchanged blocks hidden)
        }
    }

Plan: 1 to add, 1 to change, 1 to destroy.

Warning: Argument is deprecated

  with module.dev-backups-bucket.cloudfoundry_service_instance.bucket,
  on /tmp/terraform-data-dir/modules/dev-backups-bucket/s3/main.tf line 14, in resource "cloudfoundry_service_instance" "bucket":
  14:   recursive_delete = var.recursive_delete

Since CF API v3, recursive delete is always done on the cloudcontroller side.
This will be removed in future releases

(and 6 more similar warnings elsewhere)

❌ Plan not applied in Deploy to Development and Management Environment #839 (Plan has changed)

[github-actions]

Terraform plan for meta

No changes. Your infrastructure matches the configuration.

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration
and found no differences, so no changes are needed.

Warning: Argument is deprecated

  with module.s3-backups.cloudfoundry_service_instance.bucket,
  on /tmp/terraform-data-dir/modules/s3-backups/s3/main.tf line 14, in resource "cloudfoundry_service_instance" "bucket":
  14:   recursive_delete = var.recursive_delete

Since CF API v3, recursive delete is always done on the cloudcontroller side.
This will be removed in future releases

✅ Plan applied in Deploy to Development and Management Environment #839

[github-actions]

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
18661	17004	91%	0%	🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: 5cf469a by action🐍

[jadudm]

Nice addition/use of our tooling.