Gathering diagnostics for components

IBM® watsonx.data is composed of multiple internal components, each providing specific functionality within the platform. This topic covers the collection of logs and other diagnostic artifacts from these components.

Supported components

The following components are supported by the Diagnostics tool:
  • Metadata Service (MDS)
  • Query History Monitoring and Management (QHMM)
  • Validator
  • Common Policy Gateway (CPG)
  • Common Event Service (CES)
  • Console
  • Access Management System (AMS)
  • Data Access Service (DAS)
  • Query optimizer

Diagnostic types

The following diagnostic types are supported for each components:
  • Logs: System and application level logs relevant to query execution, errors, and job lifecycle.
  • Configuration snapshot: Export of current configuration settings (YAMLs, environment variables, runtime flags) to verify runtime behavior and audit changes.

Accessing and viewing the diagnostic types

For the components, to collect diagnostic artifacts such as logs and configuration snapshots, follow this path: Start from the Software Hub homepage, navigate to Support and select Diagnostics, the Gather diagnostics page is displayed. Choose New diagnostics job and select watsonx.data.

In the New diagnostics job window, the two time filters (global and granular) of the diagnostic tool allows users to specify a time range for collecting diagnostic artifacts. While the time filter is available across all components and engines, only Validator component utilizes the time filter.

Components Logs Configuration snapshot
MDS

Metadata Service (MDS) Rest Logs

Metadata Service (MDS) Thrift Logs

 Not applicable
QHMM Query History Monitoring and Metrics (QHMM) Logs Not applicable
Validator Validator Component Logs Not applicable
CPG Common Policy Gateway (CPG) Logs Not applicable
CES

Common Event Service (CES) Admin Logs

Common Event Service (CES) Kafka Logs

 Not applicable
Console

Console API Logs

Console UI Logs

IBM Software Hub

admin-console-homepage-discover-section.yaml

admin-console-homepage-tasks-section.yaml

ibm-lhconsole-config-cm.yaml
AMS Access Management Service (AMS) Logs

IBM Software Hub

ibm-lhconsole-config-cm.yaml
DAS Data Access Service (DAS) Logs Not applicable
Ingestion Ingest API Logs Not applicable
Query optimizer Query optimizer Logs Not applicable