You can create and use vRealize Automation logs and log bundles in vRealize Automation.

Alternatively, you can automatically forward logs to vRealize Log Insight. For information about how to forward logs to vRealize Log Insight, see How do I configure log forwarding to vRealize Log Insight.

Information about how to use the vracli command line utility is available by using the --help argument in the vracli command line. For example: vracli log-bundle --help.

Log bundle commands

You can create a simple log bundle or an aggregated (cold storage) log of all services. While both log bundles contains all the logs for your services, the cold storage bundle contains a copy of an aggregated stream of back-versions of the service logs, which can supply additional troubleshooting value. The cold storage agent constantly aggregates logs from the services and stores them on the local file system. A simple log bundle is typically all that is needed for troubleshooting.

You can also change the default timeout value for collecting logs from each node.

In a clustered environment, you only need to run the vracli log-bundle command on one node.

  • Display the log bundle command help:

    vracli log-bundle --help

  • Create a simple log bundle.

    vracli log-bundle

  • Create a cold storage log bundle:

    vracli log-bundle --include-cold-storage

  • Change the timeout value for collecting logs from each node. For example, if your environment contains large log files, slow networking, high CPU usage, and so on you might need to set the timeout to greater than the 1000 second default value.

    vracli log-bundle --collector-timeout $CUSTOM_TIMEOUT_IN_SECONDS

Log bundle structures

vRealize Automation services are containerized in Kubernetes pods. The generated log bundle is a tar.xz archive that uses a log-bundle-{{TIMESTAMP}}.tar.xz name format, where TIMESTAMP is an epoch timestamp in seconds. A normal log bundle contains logs from all the nodes in the environment. If the log bundle cannot be generated for whatever reason, a fallback bundle is created instead. The fallback bundle contains logs for the current node only. There are slight differences in the structure of the 2 log bundles types.

  • Normal log bundles
    Normal log bundles are organized into the following categories:
    • Host logs and configuration

      The configuration for each host and its host-specific logs are collected in one directory per cluster node (host). The directory name matches the node host name. The directory contents match the host file system. The number of directories matches the number of cluster nodes.

      Cold storage logs are located in a structured JSON log as /hostname/services-logs/all/aggregated.log.

    • Pod logs
      Services are containerized in Kubernetes pods. Service logs are located in the pods directory, which contains a single directory per namespace with a file name that matches the namespace name. There is typically one instance of each pod per cluster node. The pod directory contains a log file for each of its container applications.

      For example, vRealize Orchestrator Control Center logs reside in a vco-controlcenter-app.log file in each of the /pods/prelude/vco-app-hash/ directories.

    • Environment file

      The environment file contains information about the current resource usage per nodes and per pods. It also contains cluster information and descriptions for all the available Kubernetes entities.

  • Fallback log bundles
    If you receive an error messages while waiting for the vracli command to finish, a fallback bundle is generated. If you receive this error, you should run the vracli log-bundle command on each host or node in the cluster to collect as much information as possible.
    • Fallback container logs

      Fallback logs are located in the /fallback-containers directory. You can identify which container in which pod generated the logs by examining the log file name:

      pod-name-some-hash-container-name-other-hash.log

    • Fallback cold storage

      If you are collecting cold storage logs with the bundle, the fallback logs from the current host are located in the /fallback-cold-storage directory.