Diagnostic

This page provides access to an overview of OKA’s current health and the latest logs available. It is reserved to superusers.

Status

This tab provides various information regarding requirements and service status to ensure OKA is functioning properly without major issues. Green or red dots next to each element indicate whether everything is working as it should. Additional warnings may sometimes be displayed in orange text.

status

  • Version: Check that OKA version is correct and matches the installed package.

  • System: Check that the system specifications (OS type, memory, CPU cores, and disk space) meet the software requirements.

  • Requirement: Check that all requirements are properly installed and configured.

  • Service: Check the status of essential services and ensure that they are running as expected.

  • Permission: Check that the necessary permissions are set correctly.

  • Elasticsearch Index Blocks: Check that no Elasticsearch index used by OKA has a block (index.blocks.* setting) that prevents OKA from reading or writing data. Each index is reported as blocked (red, with the blocking settings), not yet created (orange), or without blocks (green).

When a section has many messages, they are collapsed: click show N items to expand them.

Debug bundle

The Download Debug Bundle button, at the bottom of the Status tab, downloads a .tar.gz archive to attach to a support request on the UCit helpdesk. It contains:

  • the results of the diagnostic checks above;

  • all OKA log files, with their folder structure. Very large files are replaced by their last 100 lines, and a marker file tells which files were shortened;

  • an overview of the clusters: number of clusters, number of jobs and date range per cluster;

  • Elasticsearch information: indices, index settings and blocks, cluster statistics and settings, node settings and JVM;

  • the OKA configuration (oka.yaml).

Passwords, secret keys, API tokens and the Celery broker URL are replaced with [REDACTED] in the archive. If one part cannot be collected, the archive still contains the others, with an error entry for the missing part.

debug_bundle

Logs

The logs provide detailed information about the system’s operations and any issues encountered. Using the datatable functionalities you can easily filter and navigate through the logs.

logs

  • Date: The timestamp indicating when the log entry was created.

  • Process ID: The unique identifier for the process that generated the log entry.

  • Log Level: The severity level of the log entry (e.g., DEBUG, ERROR).

  • Username: The user account under which the process was running.

  • Path Information: The API endpoint or system path associated with the log entry.

  • Cluster: The cluster associated with the log entry.

  • Message: The detailed message describing the log event, including any error messages or status updates.