domino_admin_toolkit.checks.test_domino_usage_report module

domino_admin_toolkit.checks.test_domino_usage_report.test_resource_usage(usage_report_data, runner)
Return type:

None

Description: Queries the Resource Usage Report endpoint (7-day lookback) and asserts each

job type’s (Notebook, Apps, Batch) run-success rate. Failed and Error are the only unsuccessful statuses — Running and Stopped are normal, non-failing states (Stopped is the expected terminal state for most workspaces).

Failure Conditions:

  • Success percent is below 80% for a job type with Count >= 20 runs in the past 7 days (FAIL).

  • Success percent is 80%-<95%, or a type would otherwise FAIL but has Count < 20 runs (WARN — too little data to be confident it’s a real problem, not just noise).

  • Zero-volume types (Count == 0) are excluded from the assertion entirely.

Troubleshooting Steps:

  1. Check the usage_report.csv file generated in the current working directory, or the per-type table in this check’s output, for which type(s) triggered and their success/count (e.g. “Batch 0.68 (25/37)”).

  2. Review failed/errored jobs of the named type(s) in the Domino Admin UI.

  3. Check pod logs for jobs that failed to start or complete.

  4. An ERROR here means the usage-report endpoint itself failed (timeout/non-200/ malformed CSV/missing columns) — this is a technical collection failure, not a reliability finding. Check nucleus-frontend logs for the reported reason and confirm the endpoint is reachable (admin/generateUsageReport).

Resolution Steps:

  1. Investigate specific job failures in the Admin console for the named type(s).

  2. Check cluster resource availability if jobs are failing to start.

  3. Review application logs for jobs with Error status.

  4. For a collection-failure ERROR, treat it as a nucleus-frontend availability issue — see the Frontend (Nucleus) Runbook (Confluence, ENG space) for escalation steps.

Required Permissions: Platform admin access to view usage reports.

See also:

  • test_domino_deployment.py — overall Domino deployment health; if that’s already failing, a usage-report ERROR is likely explained by the same root cause.

  • test_domino_service_health.py — service-level health; check this before assuming the usage-report endpoint failure is specific to this check.

  • test_domino_api_endpoints.py — broader Domino API reachability.

  • Workspaces Runbook (Confluence, ENG space) — troubleshooting Notebook/workspace launch and lifecycle issues once a specific type is identified as the trigger.

  • Frontend (Nucleus) Runbook (Confluence, ENG space) — nucleus-frontend availability and troubleshooting, relevant to any ERROR result from this check.

domino_admin_toolkit.checks.test_domino_usage_report.usage_report_data(domino_api_client)

Collect usage report data from Domino API.