Select a documentation version: <button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">18.4.0</button>

- [Current (18.4.0)](https://docs.cloud.google.com/alloydb/omni/containers/current/docs/manage-dump-files.md.txt)
- [18.4.0](https://docs.cloud.google.com/alloydb/omni/containers/18.4.0/docs/manage-dump-files.md.txt)
- [18.3.0](https://docs.cloud.google.com/alloydb/omni/containers/18.3.0/docs/manage-dump-files.md.txt)
- [18.1.0](https://docs.cloud.google.com/alloydb/omni/containers/18.1.0/docs/manage-dump-files.md.txt)
- [17.10.0](https://docs.cloud.google.com/alloydb/omni/containers/17.10.0/docs/manage-dump-files.md.txt)
- [17.9.0](https://docs.cloud.google.com/alloydb/omni/containers/17.9.0/docs/manage-dump-files.md.txt)
- [17.7.0](https://docs.cloud.google.com/alloydb/omni/containers/17.7.0/docs/manage-dump-files.md.txt)
- [17.5.0](https://docs.cloud.google.com/alloydb/omni/containers/17.5.0/docs/manage-dump-files.md.txt)
- [16.14.0](https://docs.cloud.google.com/alloydb/omni/containers/16.14.0/docs/manage-dump-files.md.txt)
- [16.13.0](https://docs.cloud.google.com/alloydb/omni/containers/16.13.0/docs/manage-dump-files.md.txt)
- [16.11.0](https://docs.cloud.google.com/alloydb/omni/containers/16.11.0/docs/manage-dump-files.md.txt)
- [16.9.0](https://docs.cloud.google.com/alloydb/omni/containers/16.9.0/docs/manage-dump-files.md.txt)
- [16.8.0](https://docs.cloud.google.com/alloydb/omni/containers/16.8.0/docs/manage-dump-files.md.txt)
- [16.3.0](https://docs.cloud.google.com/alloydb/omni/containers/16.3.0/docs/manage-dump-files.md.txt)
- [15.18.0](https://docs.cloud.google.com/alloydb/omni/containers/15.18.0/docs/manage-dump-files.md.txt)
- [15.17.0](https://docs.cloud.google.com/alloydb/omni/containers/15.17.0/docs/manage-dump-files.md.txt)
- [15.15.0](https://docs.cloud.google.com/alloydb/omni/containers/15.15.0/docs/manage-dump-files.md.txt)
- [15.13.0](https://docs.cloud.google.com/alloydb/omni/containers/15.13.0/docs/manage-dump-files.md.txt)
- [15.12.0](https://docs.cloud.google.com/alloydb/omni/containers/15.12.0/docs/manage-dump-files.md.txt)
- [15.7.1](https://docs.cloud.google.com/alloydb/omni/containers/15.7.1/docs/manage-dump-files.md.txt)
- [15.7.0](https://docs.cloud.google.com/alloydb/omni/containers/15.7.0/docs/manage-dump-files.md.txt)
- [15.5.5](https://docs.cloud.google.com/alloydb/omni/containers/15.5.5/docs/manage-dump-files.md.txt)
- [15.5.4](https://docs.cloud.google.com/alloydb/omni/containers/15.5.4/docs/manage-dump-files.md.txt)
- [15.5.2](https://docs.cloud.google.com/alloydb/omni/containers/15.5.2/docs/manage-dump-files.md.txt)

<br />

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

<br />

## Before you begin

Extract the `alloydb-sysdump` utility that is included in the AlloyDB Omni Docker image you [installed](https://docs.cloud.google.com/alloydb/omni/containers/current/docs/install.md.txt):

<br />

### Docker

```
docker run --rm --entrypoint /bin/bash $IMAGE -c 

"cat /usr/lib/postgresql/PG_VERSION/bin/alloydb-sysdump" 

> /tmp/alloydb-sysdump

chmod +x /tmp/alloydb-sysdump
```

### Podman

```
podman run --rm --entrypoint /bin/bash $IMAGE -c 

"cat /usr/lib/postgresql/PG_VERSION/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
   
```

<br />

Replace the following:

- `PG_VERSION`: the PostgreSQL major version of your AlloyDB Omni installation, for example, `18`.
- `INSTALL_PATH`: the path to your AlloyDB Omni installation directory accessible from the host file system.
- `CONTAINER_NAME`: the name of the container in which AlloyDB Omni runs.
- `USERNAME`: the name of the user connecting to the database. The default value is `alloydbadmin`.
- `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`.

  <br />

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

  To learn more about the command arguments, run:


  ```
  /tmp/alloydb-sysdump --help
  ```

  <br />

## 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](https://docs.cloud.google.com/support/docs/manage-cases#creating_cases) 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.