Interface DiagnosticsService

public interface DiagnosticsService
Service for executing and exporting runtime diagnostics.

  • Method Details

    • runtime

      MagicRuntime runtime()
      Returns the runtime bound to this service.
      Returns:
      runtime container

    • registry

      DiagnosticRegistry registry()
      Returns the backing registry.
      Returns:
      diagnostic registry

    • runAll

      DiagnosticReport runAll(DiagnosticRunRequest request)
      Runs all checks.
      Parameters:
      request - run request
      Returns:
      collected report

    • runSuite

      DiagnosticReport runSuite(String suite, DiagnosticRunRequest request)
      Runs all checks in a suite.
      Parameters:
      suite - suite identifier
      request - run request
      Returns:
      collected report

    • runChecks

      DiagnosticReport runChecks(Collection<String> ids, DiagnosticRunRequest request)
      Runs selected checks by id.
      Parameters:
      ids - check ids
      request - run request
      Returns:
      collected report

    • exportJson

      default Path exportJson(DiagnosticReport report)
      Exports a report to JSON using the default runtime path.
      Parameters:
      report - report to export
      Returns:
      written path

    • exportJson

      Path exportJson(DiagnosticReport report, Path path)
      Exports a report to JSON.
      Parameters:
      report - report to export
      path - destination path
      Returns:
      written path