Pular para o conteúdo principal
Versão Next

Configuração dos Parâmetros Globais do Pool de Conexões

Sintaxe do Comando
Terminal input
    pgsmart pool config [Flags]

Flags

  • -a, --agent= <agent>. => Alias, hostname ou IP do servidor onde o PgSmart Agent desejado está instalado.
  • -h, --help. => Ajuda
Configuração Não-Interativa

A execução não interativa está desabilitada para esta operação.

Configuração Interativa
Terminal input
    pgsmart pool config

Consulta Parâmetros Globais

  1. Selecione o Agente do PgSmart desejado ou Registrar um novo Agente.

    1.1. Selecione Configurações Globais no menu de opções.

    • Os parâmetros globais de pool default e aqueles configurados pelo usuário serão exibidos.

    • Para localizar um parâmetro na lista, digite seu nome completo, parcial ou qualquer conjunto de caracteres relacionados ao valor ou à seção desejada. A busca não diferencia maiúsculas de minúsculas (case insensitive).

    • Para visualizar detalhes do parâmetro, clique <ENTER> no parâmetro desejado.

      nota
      • Os parâmetros globais são agrupados por seção, que diz respeito ao lugar onde o parâmetro está dentro do arquivo de configuração.

      • Cada parâmetro é identificado conforme sua origem, ou seja, o local de onde o valor foi definido:

        global: parâmetros configurados manualmente pelo usuário.
        default: parâmetros que mantêm os valores padrão, sem intervenção do usuário.
        user: parâmetros definidos por usuários autorizados no Pool de Conexões.
        pool: parâmetros específicos de cada pool de conexões.

      • Exemplos:

        • Parâmetro global (aplica-se a todos os pools de conexão e grupos de usuário).

              ─── [ pgbouncer ] ───
          client_idle_timeout = (disabled):
              ─── [ pgbouncer ] ───
          (default) autodb_idle_timeout = 3600s
      alerta
      • parâmetros na cor azul são obrigatórios e essenciais para o funcionamento do serviço.
      • parâmetros em vermelho estão inconsistentes no arquivo de configuração e devem ser corrigidos.
      nota
      • Os parâmetros do pool de conexões são descritos com base em suas principais características, que ajudam a entender seu comportamento e restrições.

      • Cada parâmetro é documentado de forma completa para garantir que o usuário saiba como configurá-lo corretamente com as seguintes informações (desde que aplicáveis):

        • Nome: Nome do parâmetro.

        • Tipo: Define o tipo de dado aceito (ex.: integer, boolean, string, size, list, list_kv).

        • Valor Corrente: Valor atualmente configurado.

        • Origem do Valor: Fonte que definiu o valor (ex.: default, global).

        • Valor Padrão: Valor assumido se nenhum outro for configurado.

        • Grupo: Categoria funcional do parâmetro (ex.: Configurações de Autenticação, Timeouts, Configurações TLS, etc. ).

        • Seções: Contextos onde o parâmetro pode ser usado (pgbouncer).

        • Valores possíveis: Lista de valores aceitáveis.

        • Obrigatório?: Informa se o parâmetro é mandatório.

        • Requer Reinicialização?: Se mudanças exigem reinicializar o serviço.

        • Somente Leitura?: Indica se o valor pode ou não ser alterado depois da configuração inicial.

        • Descrição: Explicação resumida da função do parâmetro.

        • Descrição Complementar: Informações adicionais, exemplos ou observações importantes.

      Figura 1 - Configuração de Parâmetros Globais de pool - Consulta
      Figura 1 - Configuração de Parâmetros Globais de pool - Consulta
      Figura 2 - Configuração de Parâmetros Globais de pool - Consulta parâmetro por filtro
      Figura 2 - Configuração de Parâmetros Globais de pool - Consulta parâmetro por filtro

Edição Parâmetros Globais

  1. Selecione o Agente do PgSmart desejado ou Registrar um novo Agente.

    1.1. Selecione Configurações Globais no menu de opções.

    • Os parâmetros globais de pool default e aqueles configurados pelo usuário serão exibidos.

    1.2. Selecione o parâmetro desejado e clique <Enter>

    • Os detalhes do parâmetro selecionado serão exibidos.

    1.3. Selecione Editar

    1.4. Ajuste a configuração do parâmetro, conforme solicitado (esta operação varia segundo o tipo de cada parãmetro).

    1.8. Confirme a operação.

    1.9. Confirme a reinicialização, se for solicitado.

    nota
    • A configuração dos parâmetros varia, segundo seu tipo.
      • booleano desabilita/habilita o parâmetro.
        Ex: client_idle_timeout valor padrão: disabled. valores: enabled/disabled.
      • string valor digitado.
        Ex: auth_query valor padrão: 'SELECT usename, passwd FROM pg_shadow WHERE usename=$1'.
      • integer número dentro de determinado intervalo ou não.
        Ex: default_pool_size
      • lista lista de valores separados por virgula.
        Ex: ignore_startup_parameters
      • size valor dentro de um intervalo em B, B, MB, GB, TB, PB (varia para cada parâmetro).
        =Ex: max_packet_size. Unidade: B, kB, MB, GB, TB, PB.
      • time valor de tempo dentro de um intervalo em ms, s, min, h, d, w.
        =Ex: autodb_idle_timeout
      • enum valor a ser selecionado em uma lista.
        Ex: client_tls_protocolsValores Possíveis: all, secure, legacy, tlsv1.0, tlsv1.1, tls_v1.2, tlsv1.3
      • path identifica um caminho.
        Ex: auth_file. valor corrente: /etc/pgbouncer/userlist.txt.
    alerta
    • Para modificar uma configuração já existente, use a funcionalidade Editar Parâmetro
    Figura 3 - Configuração de Parâmetros de pool - Edição de novo Parâmetro
    Figura 3 - Configuração de Parâmetros de pool - Edição de novo Parâmetro

Remoção Parâmetros Globais

  1. Selecione o Agente do PgSmart desejado ou Registrar um novo Agente.

    1.1. Selecione Configurações Globais no menu de opções.

    Os parâmetros globais de pool default e aqueles configurados pelo usuário serão exibidos.

    1.2. Digite <ENTER> no parâmetro desejado, para visualizar seus detalhes.

    Serão apresentados os detalhes do parâmetro selecionado.

    1.3. Selecione Remover.

    1.4. Confirme a operação.

    1.5. Confirme a reinicialização, se for solicitado.

    Figura 4 - Configuração de Parâmetros de pool - Remoção
    Figura 4 - Configuração de Parâmetros de pool - Remoção
    nota

    Ao remover a configuração do parâmetro, ele retornará à sua configuração default

Notas Finais
nota
  • Conforme o parâmetro modificado, pode ser necessário o RELOAD ou então o RESTART da instância. O PgSmart irá informar qual ação é necessária para efetivar a mudança do parâmetro.

  • Caso o Reload ou Restart não seja confirmado, a configuração permanecerá no arquivo até que a ação necessária seja realizada.