Data gather

You can collect the data and logs of the application to create a backup of all the definitions, traces, and messages. This collection of data permits you to manage, monitor, and troubleshoot the application.

Collecting data

You can run the data-gather file to gather the data and a zip file is created with the following folders.

  • Definitions: The folder contains definitions of all items in the database.
  • Logs: The folder contains the following log files.
    • Messages.log: The file contains critical messages.
    • Trace.log: The file contains critical messages and traces that describe information about the flow and time taken by each request through various microservices in the application.
    • Metrics: Numerical representation of data about a specific aspect of the application.
From the GitHub repository you can download the data-gather file according to your operating system:
On Windows operating systems
Download the data-gather.ps1 file.
On Linux operating systems
Download the data-gather.sh file.
After downloading the file, run the following steps to gather the data:
  1. Connect to the required cluster and namespace.
    Note: Ensure that the context within the Orchestration CLI config.yaml file is the same context that points to the cluster from which you want to collect data. This check avoids collecting inconsistent or misleading data.
  2. Navigate to the file location where you have downloaded the data-gather file.
  3. Open the command line interface.
  4. Run the following command:
    On Windows operating systems
    ./data-gather.ps1 uno-namespace C:\path\to\OCLI\executable\ocli.exe
    On Linux operating systems
    ./data-gather.sh uno-namespace /path/to/OCLI/executable/ocli
    Where:
    uno-namespace
    The Kubernetes namespace where all the microservices of the HCL Universal Orchestrator are deployed.
    C:\path\to\OCLI\executable\ocli.exe or /path/to/OCLI/executable/ocli
    The location of the Orchestration CLI executable file.
    A file that contains messages, logs, and metrics are created in zip format at the same location as the script file.