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

Monitor More Endpoints #4730

Merged
merged 9 commits into from
Feb 28, 2025
Merged

Monitor More Endpoints #4730

merged 9 commits into from
Feb 28, 2025

Conversation

jperson1
Copy link
Contributor

@jperson1 jperson1 commented Feb 27, 2025

Monitor More Endpoints

Issue: #4619

Changes:

Add more audit endpoints to newrelic monitoring.

Restructures the endpoints template for more control over the monitored endpoint and request method. Endpoints are in tabs grouped by purpose.

  • Homepage
  • Audit submissions homepage
  • All excel uploads (not downloads)
  • PDF Uploads (not downloads)
  • Cross val (just the actual validation from POST)
  • Single summary report downloads (not multiple from search)

How to test:

See the updated dashboard deployed to Preview here.

To verify it works, visit the Preview site here and complete some actions. Verify those actions show up on the dashboard.

The branch deployed to Preview is a copy of the SOT branch with my changes on top, so that the deploy can go through. It's the same changes though.

Screenshots:

At a glance:
image

One tab:
image

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.

Restructure endpoints template for more control over endpoint and method

* Homepage
* Audit submissions homepage
* All excel uploads (not downloads)
* PDF Uploads (not downloads)
* Cross val (just the actual validation from POST)
* Single summary report downloads (not multiple from search)
Copy link
Contributor

This pull request is not up to date with main. Please merge main into this brach or rebase this branch onto main. This PR should not be approved until all status checks pass. If you see this message, please rerun all status checks before merging.

Copy link
Contributor

github-actions bot commented Feb 27, 2025

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.

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

Copy link
Contributor

github-actions bot commented Feb 27, 2025

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" = "2025-02-28T16:50:27Z" -> (known after apply)
        }
    }

  # module.dev.module.newrelic.newrelic_one_dashboard_json.fac_monitoring will be updated in-place
!~  resource "newrelic_one_dashboard_json" "fac_monitoring" {
        id         = "MzkxOTA3NnxWSVp8REFTSEJPQVJEfGRhOjc5NjI5ODA"
!~      json       = jsonencode(
!~          {
                name        = "FAC Monitoring - Dev"
!~              pages       = [
                    {
                        description = null
                        name        = "At A Glance"
                        widgets     = [
                            {
                                layout            = {
                                    column = 1
                                    height = 3
                                    row    = 2
                                    width  = 2
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    nrqlQueries = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM SyntheticCheck SELECT percentage(count(result), WHERE result = 'SUCCESS') AS 'Uptime' WHERE monitorName = 'Fac Ping Dev' SINCE 1 hour ago"
                                        },
                                    ]
                                }
                                title             = "Uptime (last hour)"
                                visualization     = {
                                    id = "viz.billboard"
                                }
                            },
                            {
                                layout            = {
                                    column = 3
                                    height = 3
                                    row    = 1
                                    width  = 2
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    dataFormatters     = [
                                        {
                                            name      = "Uptime (%)"
                                            precision = "4"
                                            type      = "decimal"
                                        },
                                    ]
                                    linkedEntityGuids  = []
                                    nrqlQueries        = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM SyntheticCheck SELECT percentage(count(result), WHERE result = 'SUCCESS') WHERE monitorName = 'Fac Ping Dev' SINCE 7 days ago"
                                        },
                                    ]
                                    thresholds         = [
                                        {
                                            alertSeverity = "WARNING"
                                            value         = 0.99
                                        },
                                        {
                                            alertSeverity = "CRITICAL"
                                            value         = 0.95
                                        },
                                    ]
                                    vizcoConfiguration = {
                                        billboard      = {
                                            thresholds = [
                                                {
                                                    limit = 0.99
                                                    type  = "warning"
                                                },
                                                {
                                                    limit = 0.95
                                                    type  = "critical"
                                                },
                                            ]
                                        }
                                        dataFormatters = [
                                            {
                                                name      = "Uptime (%)"
                                                precision = "4"
                                                type      = "decimal"
                                            },
                                        ]
                                    }
                                }
                                title             = "Uptime Target: Above 95%"
                                visualization     = {
                                    id = "viz.billboard"
                                }
                            },
                            {
                                layout            = {
                                    column = 5
                                    height = 3
                                    row    = 1
                                    width  = 6
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    nrqlQueries = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM SyntheticCheck SELECT percentage(count(result), WHERE result = 'SUCCESS') WHERE monitorName = 'Fac Ping Dev' SINCE 14 days AGO TIMESERIES"
                                        },
                                    ]
                                }
                                title             = "Uptime"
                                visualization     = {
                                    id = "viz.line"
                                }
                            },
                            {
                                layout            = {
                                    column = 1
                                    height = 3
                                    row    = 4
                                    width  = 2
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    nrqlQueries = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM Transaction SELECT count(*) AS 'Transactions' WHERE appName = 'gsa-fac-dev' SINCE 1 hour ago"
                                        },
                                    ]
                                }
                                title             = "Transactions (last hour)"
                                visualization     = {
                                    id = "viz.billboard"
                                }
                            },
                            {
                                layout            = {
                                    column = 3
                                    height = 3
                                    row    = 4
                                    width  = 2
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    dataFormatters     = [
                                        {
                                            name      = "Transactions Per Hour"
                                            precision = "0"
                                            type      = "decimal"
                                        },
                                    ]
                                    linkedEntityGuids  = []
                                    nrqlQueries        = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM Transaction SELECT rate(count(*), 1 hour) AS 'Transactions (per hour)' WHERE appName ='gsa-fac-dev' SINCE 7 days ago"
                                        },
                                    ]
                                    thresholds         = [
                                        {
                                            alertSeverity = "WARNING"
                                            value         = 300
                                        },
                                        {
                                            alertSeverity = "CRITICAL"
                                            value         = 100
                                        },
                                    ]
                                    vizcoConfiguration = {
                                        billboard      = {
                                            thresholds = [
                                                {
                                                    limit = 300
                                                    type  = "warning"
                                                },
                                                {
                                                    limit = 100
                                                    type  = "critical"
                                                },
                                            ]
                                        }
                                        dataFormatters = [
                                            {
                                                name      = "Transactions Per Hour"
                                                precision = "0"
                                                type      = "decimal"
                                            },
                                        ]
                                    }
                                }
                                title             = "Transactions Target: 100 (average per hour/last week)"
                                visualization     = {
                                    id = "viz.billboard"
                                }
                            },
                            {
                                layout            = {
                                    column = 5
                                    height = 3
                                    row    = 4
                                    width  = 6
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    nrqlQueries = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM Transaction SELECT count(*) AS 'Transactions' WHERE appName = 'gsa-fac-dev' SINCE 14 days ago TIMESERIES"
                                        },
                                    ]
                                }
                                title             = "Transactions"
                                visualization     = {
                                    id = "viz.line"
                                }
                            },
                            {
                                layout            = {
                                    column = 1
                                    height = 3
                                    row    = 7
                                    width  = 2
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    nrqlQueries = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' SINCE 1 hour ago"
                                        },
                                    ]
                                }
                                title             = "Errors (last hour)"
                                visualization     = {
                                    id = "viz.billboard"
                                }
                            },
                            {
                                layout            = {
                                    column = 3
                                    height = 3
                                    row    = 7
                                    width  = 2
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    dataFormatters     = [
                                        {
                                            name      = "Success Rate (%)"
                                            precision = "4"
                                            type      = "decimal"
                                        },
                                    ]
                                    linkedEntityGuids  = []
                                    nrqlQueries        = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM Transaction SELECT 100 - percentage(count(*), WHERE error is true) AS 'Success Rate' WHERE appName ='gsa-fac-dev' SINCE 7 days ago "
                                        },
                                    ]
                                    thresholds         = [
                                        {
                                            alertSeverity = "WARNING"
                                            value         = 0.985
                                        },
                                        {
                                            alertSeverity = "CRITICAL"
                                            value         = 0.975
                                        },
                                    ]
                                    vizcoConfiguration = {
                                        billboard      = {
                                            thresholds = [
                                                {
                                                    limit = 0.985
                                                    type  = "warning"
                                                },
                                                {
                                                    limit = 0.975
                                                    type  = "critical"
                                                },
                                            ]
                                        }
                                        dataFormatters = [
                                            {
                                                name      = "Success Rate (%)"
                                                precision = "4"
                                                type      = "decimal"
                                            },
                                        ]
                                    }
                                }
                                title             = "Success Rate Target: Above 97.5%"
                                visualization     = {
                                    id = "viz.billboard"
                                }
                            },
                            {
                                layout            = {
                                    column = 5
                                    height = 3
                                    row    = 7
                                    width  = 6
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    nrqlQueries = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' WHERE (appName = 'gsa-fac-dev') SINCE 14 days ago TIMESERIES"
                                        },
                                    ]
                                }
                                title             = "Errors"
                                visualization     = {
                                    id = "viz.line"
                                }
                            },
                            {
                                layout            = {
                                    column = 1
                                    height = 3
                                    row    = 10
                                    width  = 2
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    dataFormatters  = [
                                        {
                                            name = "p95"
                                            type = "decimal"
                                        },
                                        {
                                            name = "p50"
                                            type = "decimal"
                                        },
                                        {
                                            name = "Average"
                                            type = "decimal"
                                        },
                                    ]
                                    facet           = {
                                        showOtherSeries = false
                                    }
                                    nrqlQueries     = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average', percentile(convert(duration, 's', 'ms'), 50) AS 'p50', percentile(convert(duration, 's', 'ms'), 95) AS 'p95'  WHERE appName = 'gsa-fac-dev' SINCE 1 hour ago"
                                        },
                                    ]
                                    platformOptions = {
                                        ignoreTimeRange = false
                                    }
                                }
                                title             = "Latency (last hour)"
                                visualization     = {
                                    id = "viz.billboard"
                                }
                            },
                            {
                                layout            = {
                                    column = 3
                                    height = 3
                                    row    = 10
                                    width  = 2
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    dataFormatters     = [
                                        {
                                            name      = "Average Latency (ms)"
                                            precision = "0"
                                            type      = "decimal"
                                        },
                                    ]
                                    linkedEntityGuids  = []
                                    nrqlQueries        = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average' WHERE (appName = 'gsa-fac-dev') SINCE 7 days ago "
                                        },
                                    ]
                                    thresholds         = [
                                        {
                                            alertSeverity = "CRITICAL"
                                            value         = 1000
                                        },
                                        {
                                            alertSeverity = "WARNING"
                                            value         = 800
                                        },
                                    ]
                                    vizcoConfiguration = {
                                        billboard      = {
                                            thresholds = [
                                                {
                                                    limit = 1000
                                                    type  = "critical"
                                                },
                                                {
                                                    limit = 800
                                                    type  = "warning"
                                                },
                                            ]
                                        }
                                        dataFormatters = [
                                            {
                                                name      = "Average Latency (ms)"
                                                precision = "0"
                                                type      = "decimal"
                                            },
                                        ]
                                    }
                                }
                                title             = "Average Latency Target (last week): 1000ms"
                                visualization     = {
                                    id = "viz.billboard"
                                }
                            },
                            {
                                layout            = {
                                    column = 5
                                    height = 3
                                    row    = 10
                                    width  = 6
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    facet           = {
                                        showOtherSeries = false
                                    }
                                    legend          = {
                                        enabled = true
                                    }
                                    nrqlQueries     = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM Transaction SELECT average(duration) AS 'Average', percentile(duration, 50) AS 'p50', percentile(duration, 95) AS 'p95' WHERE appName = 'gsa-fac-dev' SINCE 14 days ago TIMESERIES"
                                        },
                                    ]
                                    platformOptions = {
                                        ignoreTimeRange = false
                                    }
                                    thresholds      = {
                                        isLabelVisible = true
                                    }
                                    units           = {
                                        unit = "MS"
                                    }
                                    yAxisLeft       = {
                                        zero = true
                                    }
                                    yAxisRight      = {
                                        zero = true
                                    }
                                }
                                title             = "Latency"
                                visualization     = {
                                    id = "viz.line"
                                }
                            },
                            {
                                layout            = {
                                    column = 1
                                    height = 1
                                    row    = 13
                                    width  = 10
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    text = "# Host Metrics"
                                }
                                title             = ""
                                visualization     = {
                                    id = "viz.markdown"
                                }
                            },
                            {
                                layout            = {
                                    column = 1
                                    height = 3
                                    row    = 14
                                    width  = 5
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    nrqlQueries = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "FROM Metric SELECT average(apm.service.cpu.usertime.utilization) * 100 as cpuUsage WHERE appName = 'gsa-fac-dev' FACET `host` LIMIT 20 SINCE 7 days ago TIMESERIES"
                                        },
                                    ]
                                }
                                title             = "Per-host CPU usage"
                                visualization     = {
                                    id = "viz.line"
                                }
                            },
                            {
                                layout            = {
                                    column = 6
                                    height = 3
                                    row    = 14
                                    width  = 5
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    nrqlQueries = [
                                        {
                                            accountIds = [
                                                3919076,
                                            ]
                                            query      = "SELECT (average(apm.service.memory.physical) * rate(count(apm.service.instance.count), 1 minute)) / 1000 AS memoryUsage FROM Metric WHERE appName = 'gsa-fac-dev' FACET `host` LIMIT 20 SINCE 7 days ago TIMESERIES"
                                        },
                                    ]
                                }
                                title             = "Per-host memory usage"
                                visualization     = {
                                    id = "viz.line"
                                }
                            },
                        ]
                    },
!~                  {
!~                      name        = "Endpoint Details" -> "Healthcheck"
!~                      widgets     = [
                            {
                                layout            = {
                                    column = 1
                                    height = 1
                                    row    = 1
                                    width  = 10
                                }
                                linkedEntityGuids = null
                                rawConfiguration  = {
                                    text = "# UEI Validation"
                                }
                                title             = ""
                                visualization     = {
                                    id = "viz.markdown"
                                }
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT count(*) AS 'Transactions (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/api/sac/ueivalidation%') SINCE 1 hour ago" -> "FROM Transaction SELECT count(*) AS 'Transactions (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'POST' AND request.uri LIKE '/api/sac/ueivalidation') SINCE 1 hour ago"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries        = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT rate(count(*), 1 hour) AS 'Transactions (per hour)' WHERE appName ='gsa-fac-dev' AND request.uri LIKE '/api/sac/ueivalidation%' SINCE 7 days ago" -> "FROM Transaction SELECT rate(count(*), 1 hour) AS 'Transactions (per hour)' WHERE appName ='gsa-fac-dev' AND request.method = 'POST' AND request.uri LIKE '/api/sac/ueivalidation' SINCE 7 days ago"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
#                                    (4 unchanged attributes hidden)
                                }
#                                (5 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries = [
!~                                      {
!~                                          query     = "FROM Transaction SELECT count(*) AS 'Transactions' WHERE appName = 'gsa-fac-dev' and request.uri LIKE '/api/sac/ueivalidation%' SINCE 14 days ago TIMESERIES" -> "FROM Transaction SELECT count(*) AS 'Transactions' WHERE appName = 'gsa-fac-dev' AND request.method = 'POST' AND  request.uri LIKE '/api/sac/ueivalidation' SINCE 14 days ago TIMESERIES"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries = [
!~                                      {
!~                                          query      = "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/api/sac/ueivalidation%') SINCE 1 hour ago" -> "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'POST' AND request.uri LIKE '/api/sac/ueivalidation') SINCE 1 hour ago"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries        = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT 100 - percentage(count(*), WHERE error is true) AS 'Success Rate' WHERE appName ='gsa-fac-dev' AND request.uri LIKE '/api/sac/ueivalidation%' SINCE 7 days ago " -> "FROM Transaction SELECT 100 - percentage(count(*), WHERE error is true) AS 'Success Rate' WHERE appName ='gsa-fac-dev' AND request.method = 'POST' AND request.uri LIKE '/api/sac/ueivalidation' SINCE 7 days ago "
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
#                                    (4 unchanged attributes hidden)
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries = [
!~                                      {
!~                                          query     = "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/api/sac/ueivalidation%') SINCE 14 days ago TIMESERIES" -> "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'POST' AND request.uri LIKE '/api/sac/ueivalidation') SINCE 14 days ago TIMESERIES"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries     = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average', percentile(convert(duration, 's', 'ms'), 50) AS 'p50', percentile(convert(duration, 's', 'ms'), 95) AS 'p95' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/api/sac/ueivalidation%') SINCE 1 hour ago" -> "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average', percentile(convert(duration, 's', 'ms'), 50) AS 'p50', percentile(convert(duration, 's', 'ms'), 95) AS 'p95' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'POST' AND request.uri LIKE '/api/sac/ueivalidation') SINCE 1 hour ago"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
#                                    (3 unchanged attributes hidden)
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries        = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/api/sac/ueivalidation%') SINCE 7 days ago " -> "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'POST' AND request.uri LIKE '/api/sac/ueivalidation') SINCE 7 days ago "
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
#                                    (4 unchanged attributes hidden)
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries     = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average', percentile(convert(duration, 's', 'ms'), 50) AS 'p50', percentile(convert(duration, 's', 'ms'), 95) AS 'p95'  WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/api/sac/ueivalidation%') SINCE 14 days ago TIMESERIES" -> "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average', percentile(convert(duration, 's', 'ms'), 50) AS 'p50', percentile(convert(duration, 's', 'ms'), 95) AS 'p95'  WHERE (appName = 'gsa-fac-dev') AND (request.method = 'POST' AND request.uri LIKE '/api/sac/ueivalidation') SINCE 14 days ago TIMESERIES"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
#                                    (7 unchanged attributes hidden)
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  text = "# Submit Audit" -> "# Homepage"
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT count(*) AS 'Transactions (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/audit/submission%') SINCE 1 hour ago" -> "FROM Transaction SELECT count(*) AS 'Transactions (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'GET' AND request.uri LIKE '/') SINCE 1 hour ago"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries        = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT rate(count(*), 1 hour) AS 'Transactions (per hour)' WHERE appName ='gsa-fac-dev' AND request.uri LIKE '/audit/submission%' SINCE 7 days ago" -> "FROM Transaction SELECT rate(count(*), 1 hour) AS 'Transactions (per hour)' WHERE appName ='gsa-fac-dev' AND request.method = 'GET' AND request.uri LIKE '/' SINCE 7 days ago"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
!~                                  thresholds         = [
!~                                      {
!~                                          value         = 250 -> 150
#                                            (1 unchanged attribute hidden)
                                        },
                                        {
                                            alertSeverity = "CRITICAL"
                                            value         = 100
                                        },
                                    ]
!~                                  vizcoConfiguration = {
!~                                      billboard      = {
!~                                          thresholds = [
!~                                              {
!~                                                  limit = 250 -> 150
#                                                    (1 unchanged attribute hidden)
                                                },
                                                {
                                                    limit = 100
                                                    type  = "critical"
                                                },
                                            ]
                                        }
#                                        (1 unchanged attribute hidden)
                                    }
#                                    (2 unchanged attributes hidden)
                                }
#                                (5 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries = [
!~                                      {
!~                                          query     = "FROM Transaction SELECT count(*) AS 'Transactions' WHERE appName = 'gsa-fac-dev' and request.uri LIKE '/audit/submission%' SINCE 14 days ago TIMESERIES" -> "FROM Transaction SELECT count(*) AS 'Transactions' WHERE appName = 'gsa-fac-dev' AND request.method = 'GET' AND  request.uri LIKE '/' SINCE 14 days ago TIMESERIES"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries = [
!~                                      {
!~                                          query      = "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/audit/submission%') SINCE 1 hour ago" -> "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'GET' AND request.uri LIKE '/') SINCE 1 hour ago"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries        = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT 100 - percentage(count(*), WHERE error is true) AS 'Success Rate' WHERE appName ='gsa-fac-dev' AND request.uri LIKE '/audit/submission%' SINCE 7 days ago " -> "FROM Transaction SELECT 100 - percentage(count(*), WHERE error is true) AS 'Success Rate' WHERE appName ='gsa-fac-dev' AND request.method = 'GET' AND request.uri LIKE '/' SINCE 7 days ago "
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
#                                    (4 unchanged attributes hidden)
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries = [
!~                                      {
!~                                          query     = "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/audit/submission%') SINCE 14 days ago TIMESERIES" -> "FROM TransactionError SELECT count(*) AS 'Errors (last hour)' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'GET' AND request.uri LIKE '/') SINCE 14 days ago TIMESERIES"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries     = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average', percentile(convert(duration, 's', 'ms'), 50) AS 'p50', percentile(convert(duration, 's', 'ms'), 95) AS 'p95' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/audit/submission%') SINCE 1 hour ago" -> "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average', percentile(convert(duration, 's', 'ms'), 50) AS 'p50', percentile(convert(duration, 's', 'ms'), 95) AS 'p95' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'GET' AND request.uri LIKE '/') SINCE 1 hour ago"
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
#                                    (3 unchanged attributes hidden)
                                }
#                                (4 unchanged attributes hidden)
                            },
!~                          {
!~                              rawConfiguration  = {
!~                                  nrqlQueries        = [
!~                                      {
!~                                          query      = "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average' WHERE (appName = 'gsa-fac-dev') AND (request.uri LIKE '/audit/submission%') SINCE 7 days ago " -> "FROM Transaction SELECT average(convert(duration, 's', 'ms')) AS 'Average' WHERE (appName = 'gsa-fac-dev') AND (request.method = 'GET' AND request.uri LIKE '/') SINCE 7 days ago "
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
!~                                  thresholds         = [
!~                                      {
!~                                          value         = 500 -> 350
#                                            (1 unchanged attribute hidden)
                                        },
!~                                      {
!~                                          value         = 450 -> 250
#                                            (1 unchanged attribute hidden)
                                        },
                                    ]
!~                                  vizcoConfiguration = {
!~                                      billboard      = {
!~                                          thresholds = [
!~                                              {
!~                                                  limit = 500 -> 350
#                                                    (1 unchanged attribute hidden)
                                                },
!~                                              {
!~                                                  limit = 450 -> 250
#                                                    (1 unchanged attribute hidden)
                                                },
Plan is too large to fit in a PR comment. See the full plan in the workflow log.

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

Copy link
Contributor

@asteel-gsa asteel-gsa left a comment

Choose a reason for hiding this comment

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

Per convo on call. I am recommending we do the following, to create pages as to not clutter everything if we expand upon this further:

monitoring.tf

  homepage_page = templatefile("${path.module}/tftpl_manifests/homepage.json.tftpl", {
    env                  = var.cf_space_name
    new_relic_account_id = var.new_relic_account_id
    endpoint_config = [
      { name             = "Homepage"
        uri              = "/"
        method           = "GET"
        transactions_sla = { critical = 100, warning = 150 }    # Number of Transactions per hour
        success_rate_sla = { critical = 0.99, warning = 0.995 } # Success Rate Percentage
        latency_sla      = { critical = 350, warning = 250 }    # Average Latency over a week, in ms
      },
    ]
  })

  audit_submission_page = templatefile("${path.module}/tftpl_manifests/auditsubmission.json.tftpl", {
    env                  = var.cf_space_name
    new_relic_account_id = var.new_relic_account_id
    endpoint_config = [
      { name             = "Audit Submissions Homepage"
        uri              = "/audit/"
        method           = "GET"
        transactions_sla = { critical = 50, warning = 70 }      # Number of Transactions per hour
        success_rate_sla = { critical = 0.99, warning = 0.995 } # Success Rate Percentage
        latency_sla      = { critical = 1500, warning = 1200 }  # Average Latency over a week, in ms
      },
    ]
  })

[...]
etc.

L92

pages = [local.high_level_page, local.endpoint_page, local.homepage_page, local.audit_sumission_page, [.....], [etc]]

Move xyz.json.tfpl to terraform/shared/modules/newrelic/<make up a folder name>/
Reference the .tftpl files via

homepage_page = templatefile("${path.module}/<make up a folder name>/homepage.json.tftpl"

Ultimately, we want to split these new additions into their own pages, and this code should be a breadcrumb to do it. preview plan on my local generates fine as is, lmk if you need support pairing, should be a quick change to implement and will give a healthier file struct with more monitoring.

I think we can rename "name":"Endpoints Page" to "name":"Widgets Manifest" and rename the file to widgets.json.tfpl and use one template for all of them.

I'll support this if James gets stuck, as I validated this setup on my local with a tfplan, but otherwise, code works as is https://onenr.io/0qwLmXo5zR5

Copy link
Contributor

This pull request is not up to date with main. Please merge main into this brach or rebase this branch onto main. This PR should not be approved until all status checks pass. If you see this message, please rerun all status checks before merging.

Copy link
Contributor

@asteel-gsa asteel-gsa left a comment

Choose a reason for hiding this comment

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

  • Makes 1 widgets.json.tftpl file, with a passthrough variable page_name so that we can maintain 1 file, with multiple dashboards.
  • Creates new locals that group monitoring logically to enable future enhancements and additions
  • New Relic Dashboard is live in preview https://onenr.io/0kjnXEPllwo (pending no new deploy overwrites it). Deployment here
    image
  • James is now a DevOps Engineer

Copy link
Contributor

Code Coverage

Package Line Rate Branch Rate Health
. 100% 100%
api 98% 90%
audit 97% 87%
audit.cross_validation 98% 88%
audit.fixtures 84% 50%
audit.intakelib 88% 82%
audit.intakelib.checks 92% 85%
audit.intakelib.common 98% 82%
audit.intakelib.transforms 100% 95%
audit.management.commands 78% 17%
audit.migrations 100% 100%
audit.models 94% 73%
audit.templatetags 100% 100%
audit.views 72% 54%
census_historical_migration 96% 65%
census_historical_migration.migrations 100% 100%
census_historical_migration.sac_general_lib 92% 84%
census_historical_migration.transforms 95% 90%
census_historical_migration.workbooklib 68% 69%
config 77% 37%
curation 100% 100%
curation.curationlib 93% 100%
curation.migrations 100% 100%
dissemination 92% 72%
dissemination.migrations 97% 25%
dissemination.searchlib 76% 66%
dissemination.templatetags 100% 100%
djangooidc 53% 38%
djangooidc.tests 100% 94%
report_submission 93% 88%
report_submission.migrations 100% 100%
report_submission.templatetags 74% 100%
support 91% 66%
support.migrations 100% 100%
support.models 96% 50%
tools 98% 50%
users 95% 92%
users.fixtures 100% 83%
users.management 100% 100%
users.management.commands 100% 100%
users.migrations 100% 100%
Summary 91% (18501 / 20268) 77% (2277 / 2962)

@asteel-gsa asteel-gsa added this pull request to the merge queue Feb 28, 2025
Merged via the queue into main with commit afe51f5 Feb 28, 2025
18 of 21 checks passed
@asteel-gsa asteel-gsa deleted the jp/monitor-more-endpoints branch February 28, 2025 17:12
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.

2 participants