This page describes how to customize your AlloyDB Omni installation, which supports different forms of customization. This page shows some common customizations.
Enable and disable AlloyDB Omni telemetry
AlloyDB Omni telemetry implements a lightweight client agent that runs only in the AlloyDB Omni container image. This agent periodically collects a set of basic, pseudonymous metrics and sends them to a Google-managed endpoint.
Because AlloyDB Omni is a downloadable product that's offered at no charge, this telemetry provides Google with essential, non-personally identifiable information (non-PII) metrics regarding the generic adoption and deployment environments of running instances. This data helps inform product development and support prioritization.
Collected metrics include the following:
- Unique installation ID (pseudonymized UUID)
- AlloyDB Omni version and PostgreSQL major version
- Host system information like CPU count, RAM, and uptime
Disable telemetry reporting
To prevent the telemetry agent from running and reporting usage metrics, set
the PostgreSQL configuration parameter omni_enable_telemetry to off. You can
disable the telemetry agent by setting the telemetry flag in the postgresql.conf
file or by setting the flag at runtime using ALTER SYSTEM.
Set the telemetry flag in the postgresql.conf file
To modify the PostgreSQL configuration file in your container's persistent data directory, follow these steps:
- Locate the
postgresql.conffile in your database's data directory ($PGDATA). Disable AlloyDB Omni telemetry.
omni_enable_telemetry = off
To apply the change, restart your AlloyDB Omni container. The telemetry agent stops collecting and sending usage metrics to Google.
Set the telemetry flag at runtime using ALTER SYSTEM
To set the telemetry flag and persist the change across restarts, follow these steps:
Connect to your AlloyDB Omni instance using
psql:psql -h HOST -U USER -d DATABASE
Make the following replacements:
HOST: the hostname or IP address of your AlloyDB Omni instance—for example,127.0.0.1.USER: the database user that you want to connect as—for example,postgres.DATABASE: the database that you want to connect to—for example,postgres.
Run the following command:
ALTER SYSTEM SET omni_enable_telemetry = 'off';
Reload the configuration or restart the instance. In some container setups, you might need to restart your instance to make sure that the change is fully picked up by the background worker.
SELECT pg_reload_conf();
The telemetry agent stops collecting and sending usage metrics to Google.
Enable telemetry reporting
If you previously disabled AlloyDB Omni telemetry, you can
re-enable it by setting the
omni_enable_telemetry flag to on. You enable the telemetry agent by
setting the flag in the postgresql.conf file or by setting the flag at
runtime using ALTER SYSTEM.
Set the telemetry flag in the postgresql.conf file
- Locate the
postgresql.conffile in your database's data directory ($PGDATA). Set the following line:
omni_enable_telemetry = on
To apply the change, restart your AlloyDB Omni container.
Set the telemetry flag at runtime using ALTER SYSTEM
- Connect to your AlloyDB Omni instance using
psql. Run the following command:
ALTER SYSTEM SET omni_enable_telemetry = 'on';
To apply the change, restart your AlloyDB Omni container.
docker restart CONTAINER_NAME
Make the following replacement:
CONTAINER_NAME: The name of your AlloyDB Omni container—for example,my-omni-1.
Check AlloyDB Omni telemetry status
You can check the status of the AlloyDB Omni telemetry agent, including whether it's enabled or running. You can also check telemetry agent activity.
Check if the telemetry agent is enabled or disabled
To check the status of the telemetry setting, follow these steps:
- Connect to your instance.
- Run the following:
SHOW omni_enable_telemetry;
The output returns on or off, depending on whether you disabled or enabled
AlloyDB Omni telemetry.
Check if the telemetry agent is running
To check whether the telemetry agent is running, run the following command in the container host:
docker top CONTAINER_NAME
Make the following replacement:
CONTAINER_NAME: The name of your AlloyDB Omni container—for example,my-omni-1.
If telemetry is enabled and running, the output contains a line with the text postgres: omni telemetry worker.
Check telemetry agent activity
To check the activity of the telemetry agent, run the following command in the container host:
docker logs CONTAINER_NAME 2>&1 | grep telemetry
Make the following replacement:
CONTAINER_NAME: The name of your AlloyDB Omni container—for example,my-omni-1.
If the telemetry agent is running, the logs contain messages similar to the following:
LOG: [telemetry_agent_worker.cc:143] Started telemetry worker LOG: [telemetry_agent_worker.cc:161] Running telemetry reporting agent telemetry_agent: Uploading telemetry data to https://cloud.google.com/log.
Connect to your instance
Depending on your environment, you can connect to your AlloyDB Omni instance either locally or remotely.
Connect locally
Docker
docker exec -it CONTAINER_NAME psql -U postgres
Docker
docker exec -it CONTAINER_NAME psql -U postgres
Podman
podman exec -it CONTAINER_NAME psql -U postgres
Podman
podman exec -it CONTAINER_NAME psql -U postgres
Replace the following variable:
CONTAINER_NAME: Name of your AlloyDB Omni container—for example,my-omni-1.
Connect remotely
/usr/lib/postgresql/16/bin/psql -U postgres -p HOST_PORT -h IP_ADDRESS_OR_FQDN
Replace the following variables:
HOST_PORT: TCP port you used during installation.IP_ADDRESS_OR_FQDN: IP address or fully-qualified domain name for the host where AlloyDB Omni is running.
Enable extensions
The list of extensions available in AlloyDB Omni is available in Supported database extensions. Although PostGIS and Orafce are not included with AlloyDB Omni, they can both be installed by following instructions:
Installed extensions are enabled using standard PostgreSQL CREATE EXTENSION
statements as detailed in
Enable an extension.