Generate and diagnose AlloyDB Omni dump files

Select a documentation version:

This page describes how to generate AlloyDB Omni system dump files and analyze the causes of unexpected issues.

Before you begin

Extract the alloydb-sysdump utility that is included in the AlloyDB Omni Docker image you installed:

Docker 

docker run --rm --entrypoint /bin/bash $IMAGE -c
"cat /usr/lib/postgresql/15/bin/alloydb-sysdump"
> /tmp/alloydb-sysdump
chmod +x /tmp/alloydb-sysdump

Podman 

podman run --rm --entrypoint /bin/bash $IMAGE -c
"cat /usr/lib/postgresql/15/bin/alloydb-sysdump"
> /tmp/alloydb-sysdump
chmod +x /tmp/alloydb-sysdump

Generate an AlloyDB Omni dump file

You can manually generate an AlloyDB Omni dump file any time. Examining the dump file helps you or Google Cloud Customer Care analyze issues with your AlloyDB Omni installation, such as deadlocks that block new connections, slow queries, slow vacuum, high usage of memory, CPU, or storage.

To generate a dump file, run the following command:

   sudo /tmp/alloydb-sysdump -D=INSTALL_PATH -U=USERNAME -p=PORT -H=HOSTNAME -c=CONTAINER_NAME

Replace the following:

  • INSTALL_PATH: the path to your AlloyDB Omni installation directory accessible from the host file system.
  • USERNAME: the name of the user connecting to the database.
  • PORT: the TCP port where AlloyDB Omni accepts connections on. The default value is 5432.
  • HOSTNAME: the hostname of the machine on which AlloyDB Omni runs. If the value begins with a slash, it is used as the directory for a Unix domain socket. The default value is localhost.

  • CONTAINER_NAME: the name of the container in which AlloyDB Omni runs.

    The command output displays the location of the system dump file.

    To learn more about the command arguments, run:

     /tmp/alloydb-sysdump --help

Review an AlloyDB Omni dump file

An AlloyDB Omni dump file is an ordinary text file that summarizes various aspects of the system's state. To review it, open it in a text editor, the less program, or any other program for viewing text files.

AlloyDB Omni saves the file in your data directory, and it names the file as alloydb_system_dump_ followed by a timestamp. For example, alloydb_system_dump_20240614_062953PM.

Create a support case for assistance

If you need assistance in interpreting a system dump file to troubleshoot a problem with AlloyDB Omni, then create a support case and attach the file to it. You must have a Google Cloud account to create a support case.

The AlloyDB team responds to the case based on its priority and the respective support service at the time of creation.