13.1 Debugging Services
The OLIVE Platform provides two primary approaches to debugging and monitoring the OLIVE Platform, depending on the level of access available to the user:
- API-level debugging using the debug flag for request-specific diagnostics
- Cluster-level observability using Kubernetes-native logging, tracing, and monitoring tools
Request-Level Debugging
For users interacting with the platform exclusively through the API, debugging can be enabled on a per-request basis.
Debug Mode
When making an API request, a debug flag can be enabled. When this flag is set to true, the platform includes additional diagnostic information in the response and in any subsequent poll responses.
Debug mode may include:
- Execution traces
- Detailed logs
- Intermediate processing steps
- Additional metadata useful for troubleshooting failures or unexpected behavior
This option is particularly useful when cluster-level access is not available and when investigating issues related to a specific request or workflow.
Diagnostics Availability
By default, request-level diagnostics are only supported for development deployments (no authentication).
For deployments that require authentication, diagnostics must be explicitly enabled in the shared service deployment values.yaml for data-orchestrator:
data-orchestrator:
express:
env:
GLOBAL_DIAGNOSTICS_ENABLED: "true"
Enabling diagnostics is not recommended for production deployments that contain customer data.
Refer to the API documentation for details on how to enable the debug flag, see the Technical documentation for OLIVE
Cluster-Level Observability
If you have access to the Kubernetes cluster where the OLIVE Platform is deployed, more advanced monitoring and debugging capabilities are available.
The OLIVE Platform is a standard Kubernetes-based application and is fully compatible with commonly used Kubernetes observability tools.
More information on the available monitoring and observability tooling can be found in the OLIVE Administrator and Operator handbook, and in OLIVE Platform Architecture
For workflows we provide an additional debugging method, see documentation here: Troubleshooting & Debugging
To start from a symptom rather than a tool, see Troubleshooting Connectivity.