Personalizar a instalação do AlloyDB Omni

Selecione uma versão da documentação:

Nesta página, descrevemos como personalizar a instalação do AlloyDB Omni, que oferece suporte a diferentes formas de personalização. Esta página mostra algumas personalizações comuns.

Ativar e desativar a telemetria do AlloyDB Omni

A telemetria do AlloyDB Omni implementa um agente cliente leve que é executado apenas na imagem do contêiner do AlloyDB Omni. Esse agente coleta periodicamente um conjunto de métricas básicas e pseudônimas e as envia para um endpoint gerenciado pelo Google.

Como o AlloyDB Omni é um produto para download oferecido sem custos financeiros, essa telemetria fornece ao Google métricas essenciais e sem PII sobre os ambientes genéricos de adoção e implantação de instâncias em execução. Esses dados ajudam a informar o desenvolvimento de produtos e a priorização do suporte.

As métricas coletadas incluem:

  • ID de instalação exclusivo (UUID pseudônimo)
  • Versão do AlloyDB Omni e versão principal do PostgreSQL
  • Informações do sistema host, como contagem de CPU, RAM e tempo de atividade

Desativar a geração de relatórios sobre a telemetria

Para impedir que o agente de telemetria seja executado e informe métricas de uso, defina o parâmetro de configuração do PostgreSQL omni_enable_telemetry como off. É possível desativar o agente de telemetria definindo a flag de telemetria no arquivo postgresql.conf ou definindo a flag durante a execução usando ALTER SYSTEM.

Definir a flag de telemetria no arquivo postgresql.conf

Para modificar o arquivo de configuração do PostgreSQL no diretório de dados persistentes do contêiner, siga estas etapas:

  1. Localize o arquivo postgresql.conf no diretório de dados do banco de dados ($PGDATA).

  2. Desative a telemetria do AlloyDB Omni.

    omni_enable_telemetry = off

  3. Para aplicar a mudança, reinicie o contêiner do AlloyDB Omni. O agente de telemetria para de coletar e enviar métricas de uso ao Google.

Definir a flag de telemetria no tempo de execução usando ALTER SYSTEM

Para definir a flag de telemetria e manter a mudança nas reinicializações, siga estas etapas:

  1. Conecte-se à instância do AlloyDB Omni usando psql:

    psql -h HOST -U USER -d DATABASE

    Faça as seguintes substituições:

    • HOST: o nome do host ou o endereço IP da sua instância do AlloyDB Omni. Por exemplo, 127.0.0.1.
    • USER: o usuário do banco de dados que você quer usar para se conectar, por exemplo, postgres.
    • DATABASE: o banco de dados a que você quer se conectar, por exemplo, postgres.

  2. Execute este comando:

    ALTER SYSTEM SET omni_enable_telemetry = 'off';

  3. Atualize a configuração ou reinicie a instância. Em algumas configurações de contêiner, talvez seja necessário reiniciar a instância para garantir que a mudança seja totalmente captada pelo worker em segundo plano.

    SELECT pg_reload_conf();

    O agente de telemetria para de coletar e enviar métricas de uso ao Google.

Ativar relatórios de telemetria

Se você desativou a telemetria do AlloyDB Omni, é possível reativá-la definindo a flag omni_enable_telemetry como on. Para ativar o agente de telemetria, defina a flag no arquivo postgresql.conf ou em tempo de execução usando ALTER SYSTEM.

Definir a flag de telemetria no arquivo postgresql.conf

  1. Localize o arquivo postgresql.conf no diretório de dados do banco de dados ($PGDATA).

  2. Defina a seguinte linha:

    omni_enable_telemetry = on

  3. Para aplicar a mudança, reinicie o contêiner do AlloyDB Omni.

Definir a flag de telemetria no tempo de execução usando ALTER SYSTEM

  1. Conecte-se à instância do AlloyDB Omni usando psql.

  2. Execute este comando:

    ALTER SYSTEM SET omni_enable_telemetry = 'on';

  3. Para aplicar a mudança, reinicie o contêiner do AlloyDB Omni.

    docker restart CONTAINER_NAME

    Faça a seguinte substituição:

    • CONTAINER_NAME: o nome do seu contêiner do AlloyDB Omni. Por exemplo, my-omni-1.

Verificar o status da telemetria do AlloyDB Omni

É possível verificar o status do agente de telemetria do AlloyDB Omni, incluindo se ele está ativado ou em execução. Você também pode verificar a atividade do agente de telemetria.

Verificar se o agente de telemetria está ativado ou desativado

Para verificar o status da configuração de telemetria, siga estas etapas:

  1. Conecte-se à instância.
  2. Execute o comando a seguir:
SHOW omni_enable_telemetry;

A saída retorna on ou off, dependendo se você desativou ou ativou a telemetria do AlloyDB Omni.

Verificar se o agente de telemetria está em execução

Para verificar se o agente de telemetria está em execução, execute o seguinte comando no host do contêiner:

docker top CONTAINER_NAME

Faça a seguinte substituição:

  • CONTAINER_NAME: o nome do seu contêiner do AlloyDB Omni. Por exemplo, my-omni-1.

Se a telemetria estiver ativada e em execução, a saída vai conter uma linha com o texto postgres: omni telemetry worker.

Verificar a atividade do agente de telemetria

Para verificar a atividade do agente de telemetria, execute o seguinte comando no host do contêiner:

docker logs CONTAINER_NAME 2>&1 | grep telemetry

Faça a seguinte substituição:

  • CONTAINER_NAME: o nome do seu contêiner do AlloyDB Omni. Por exemplo, my-omni-1.

Se o agente de telemetria estiver em execução, os registros vão conter mensagens semelhantes a estas:

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.

Conectar-se à instância

Dependendo do seu ambiente, é possível se conectar à instância do AlloyDB Omni localmente ou remotamente.

Conectar localmente

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

Substitua a seguinte variável:

  • CONTAINER_NAME: nome do contêiner do AlloyDB Omni. Por exemplo, my-omni-1.

Conectar remotamente

/usr/lib/postgresql/18/bin/psql -U postgres -p HOST_PORT -h IP_ADDRESS_OR_FQDN

Substitua as seguintes variáveis:

  • HOST_PORT: porta TCP usada durante a instalação.
  • IP_ADDRESS_OR_FQDN: endereço IP ou nome de domínio totalmente qualificado do host em que o AlloyDB Omni está sendo executado.

Ativar extensões

A lista de extensões disponíveis no AlloyDB Omni está em Extensões de banco de dados compatíveis. Embora o PostGIS e o Orafce não estejam incluídos no AlloyDB Omni, é possível instalar os dois seguindo estas instruções:

As extensões instaladas são ativadas usando instruções padrão do PostgreSQL CREATE EXTENSION, conforme detalhado em Ativar uma extensão.