Platform log files

VMmanager saves information about the operation of services in log files. The data from log files can be used to diagnose the platform operation.

Log files list

Main log files

The main log files of VMmanager services are stored in the vm_box container in the /var/log/ directory. Usually the name of the log file is the same as the service name. For example, the log file of the vmwatch service is called vmwatch.log.

Platform installation

The platform installation log is saved in the file /opt/ispsystem/vm/install.log.

Various services

Log files on the cluster node

Working with logs

Copy log file from a container

To copy a log file from the container to the current directory, run the command:

docker cp <container_name>:<path_to_log> ./

docker cp vm_auth_back_1:/var/log/licupdate.log ./

View log files in a container

1. Enter the required container: 

   docker exec -it <container_name> sh

   BASH
    Comments to the command

   <container_name> — container name

   Example command

   docker exec -it vm_box sh

   BASH

2. View the log file using standard Linux utilities. For example, cat, tail, less, etc.

   Example command

   less /var/log/host.log

   BASH
   

   To view the logs of a specific task:

   1. In the platform interface go to the Tasks → select the task → copy the request_id value.

   2. Run the command:

      grep <request_id> /var/log/*

      CODE
       Comments to the command

      <request_id> — request_id value

3. Exit the container:

   exit

   BASH

Viewing log files via stdout

Separate log files are not created for some services. Logs of these services are written to stdout. To view such logs, run the command: 

docker logs <container_name> --tail <lines> --since <period>

docker logs vm_box --tail 100 --since 60m

Collecting platform logs

To collect all the log files of the platform in one directory:

1. Connect to the server with the platform via SSH.

2. Create the bash script logs_collect.sh with the following content:

   #!/bin/bash
   
   rm /home/logs -fr
   
   DOCKER_CONTAINER_NAMES=`docker ps --format '{{.Names}}'`
   
   SERVICES=($DOCKER_CONTAINER_NAMES)
   cd /home
   mkdir -p logs
   cd logs
   for service in ${SERVICES[@]}
   do
    echo -e "----\033[0;31mCopying logs from $service\033[0m----\n"
    mkdir -p $service
    docker cp $service:/var/log/. $service/.
    docker logs $service > $service/${service}_stdout.log 2>&1
   done
   
   cp -r /opt/ispsystem/*/install.log install.log
   
   ARCHIVE_NAME="logs_$(date +'%Y_%m_%d_%H_%M_%S').tar.gz"
   
   tar -cvzf /home/$ARCHIVE_NAME -C /home/logs .

   BASH

3. Run the script: 

   bash logs_collect.sh

   BASH

The log files will be saved in the /home/logs/ directory, the log archive will be saved in the /home/ directory.

Logging to journald

By default, logging in the journald system service is disabled in the platform. To enable logging:

1. Connect to a server with the platform via SSH.

2. Create the patch file /opt/ispsystem/vm/journald.yaml with the contents:

   version: "3.5"
   services:
     auth_back4:
       volumes:
       - /var/run/systemd/journal/:/var/run/systemd/journal/
     ldap:
       volumes:
       - /var/run/systemd/journal/:/var/run/systemd/journal/
     vm_box:
       volumes:
       - /opt/ispsystem/vm/backup:/opt/ispsystem/vm/backup
       - /opt/ispsystem/license:/opt/ispsystem/license
       - /opt/ispsystem/vm/socket/:/opt/ispsystem/vm/vmbox/
       - /var/run/systemd/journal/:/var/run/systemd/journal/

   CODE

3. Apply the patch:

   vm add-patch -p journald -f /opt/ispsystem/vm/journald.yaml

   BASH

Useful tips

Related topics:

• VMmanager structure