Como modificar parâmetros globais no arquivo config.xml de um cluster ApsaraDB for ClickHouse - ApsaraDB for ClickHouse: Central de Documentação do Alibaba Cloud

Contexto

Um cluster ApsaraDB for ClickHouse utiliza valores padrão de parâmetros configurados nos arquivos config.xml e user.xml. Modifique esses parâmetros para otimizar sua instância:

Arquivo de configuração user.xml: modifique os parâmetros executando o comando SET GLOBAL. As alterações entram em vigor imediatamente, sem necessidade de reinicialização. Para mais informações, consulte Modify user.xml parameters.
Arquivo de configuração config.xml: modifique os parâmetros diretamente no console.

Observações de uso

Em clusters da Community-Compatible Edition, a configuração de parâmetros no XML Mode e a visualização do histórico de alterações estão disponíveis apenas se o cluster tiver sido criado após 1º de dezembro de 2021.
Clusters da Enterprise Edition não suportam configuração de parâmetros no XML Mode.
O XML Mode não permite excluir parâmetros. Os parâmetros configuráveis nesse modo são os mesmos disponíveis no Default Mode.
Se você modificar parâmetros que exigem reinicialização para entrar em vigor, o cluster reiniciará automaticamente após a conclusão das alterações. Antes de enviar os parâmetros, certifique-se de que a reinicialização não afetará seus negócios.

Impactos no cluster

Quando o cluster estiver com o status Changing Configurations ou Restarting, apenas a visualização das informações estará disponível. Operações como upgrade de tipo de instância, scale-out ou scale-in ficam bloqueadas.
Se você alterar parâmetros que exigem reinicialização, o cluster reiniciará automaticamente ao final das modificações. Execute essa operação fora dos horários de pico para evitar interrupções no service.

Modificar parâmetros

O procedimento para modificar parâmetros varia conforme a edição do cluster.

Importante

Se precisar modificar os parâmetros prometheus.port ou text_log, consulte Important parameters.

Enterprise edition

Faça login no console do ApsaraDB for ClickHouse.
No canto superior esquerdo da página, selecione a região do cluster desejado.
Na página Clusters, clique em na aba Enterprise Edition Clusters e, em seguida, clique em no ID do cluster alvo.
No painel de navegação à esquerda, clique em Parameter Management.
Na coluna Parameter Value, clique em no ícone de modificação para editar o valor. Insira um valor dentro do intervalo válido e clique em OK.
Após modificar os parâmetros desejados, clique em Submit Parameters no canto superior direito da página.
Na caixa de diálogo Save Settings, revise os valores dos parâmetros antes e depois da alteração, confirme as mudanças, informe o motivo da modificação e clique em OK.

Importante
Ao enviar parâmetros que exigem reinicialização, o cluster ClickHouse reiniciará automaticamente após a conclusão das modificações. Antes de prosseguir, garanta que a reinicialização não impactará seus negócios.

Após o envio dos parâmetros, o sistema valida os valores informados. Se algum valor for inválido, uma mensagem de erro será exibida. O ErrorCode 102 indica que o valor inserido é inválido. Retorne à etapa anterior, insira um valor dentro do intervalo válido e envie os parâmetros novamente.

Community-compatible edition

Faça login no console do ApsaraDB for ClickHouse.
No canto superior esquerdo da página, selecione a região do cluster desejado.
Na página Clusters, clique em na aba Clusters of Community-compatible Edition e, em seguida, clique em no ID do cluster alvo.
No painel de navegação à esquerda, clique em Parameter Configuration.
Clique em na aba Settings. Selecione Default Mode ou XML Mode para modificar os parâmetros.

Importante
No console do ApsaraDB for ClickHouse, o valor do parâmetro prometheus.port deve estar no intervalo de 2182 a 3000.
- Default Mode: na coluna Parameter Value, clique em no ícone de modificação para entrar no modo de edição. Insira um valor dentro do intervalo válido e clique em OK.
- XML Mode: no canto superior direito da página, clique em Modify para alterar os parâmetros desejados no arquivo.
Após modificar os parâmetros desejados, clique em Submit Parameters no canto superior direito da página.
Na caixa de diálogo Save Settings, revise os valores dos parâmetros antes e depois da alteração, confirme as mudanças, informe o motivo da modificação e clique em Submit Parameters.
Importante
- Ao enviar parâmetros que exigem reinicialização, o cluster ClickHouse reiniciará automaticamente após a conclusão das modificações. Antes de prosseguir, certifique-se de que a reinicialização não afetará seus negócios.
- No XML Mode, caso um valor de parâmetro seja inválido, uma mensagem de erro será exibida. O ErrorCode 102 indica que o valor inserido é inválido. Retorne à etapa anterior, insira um valor dentro do intervalo válido e envie os parâmetros novamente.

Reverter modificações

Nota

É possível reverter apenas modificações ainda não enviadas.
Para clusters da Enterprise Edition e para clusters da Community-Compatible Edition no XML Mode, reverta todas as alterações de parâmetros simultaneamente.

Para reverter modificações não enviadas, execute uma das seguintes operações:

Reverter uma única modificação de parâmetro: clique em no ícone ao lado do valor do parâmetro. O ApsaraDB for ClickHouse reverterá a modificação não enviada desse parâmetro para seu valor anterior.
Reverter todas as modificações de parâmetros: clique em Cancel no canto superior direito da lista de parâmetros. O ApsaraDB for ClickHouse reverterá todas as alterações não enviadas para seus valores anteriores.

Visualizar histórico de alterações

Enterprise edition

Faça login no console do ApsaraDB for ClickHouse.
No canto superior esquerdo da página, selecione a região do cluster desejado.
Na página Clusters, clique em na aba Enterprise Edition Clusters e, em seguida, clique em no ID do cluster alvo.
No painel de navegação à esquerda, clique em Parameter Management.
Clique em na aba Change History para visualizar o histórico de alterações de uma das seguintes formas:
- Clique em Last 30 Days ou Last 7 Days para ver as alterações do período correspondente.
- Especifique um intervalo de tempo para visualizar os registros de modificação desse período.

Community-compatible edition

Faça login no console do ApsaraDB for ClickHouse.
No canto superior esquerdo da página, selecione a região do cluster desejado.
Na página Clusters, clique em na aba Clusters of Community-compatible Edition e, em seguida, clique em no ID do cluster alvo.
No painel de navegação à esquerda, clique em Parameter Configuration.
Clique em na aba Change History para visualizar o histórico de alterações de uma das seguintes formas:
- Clique em Last 30 Days ou Last 7 Days para ver as alterações do período correspondente.
- Especifique um intervalo de tempo e clique em Query para visualizar os registros de modificação desse período.

Parâmetros importantes

No console do ApsaraDB for ClickHouse, o valor do parâmetro prometheus.port é restrito a um número de porta no intervalo de 2182 a 3000.

Em algumas versões de cluster, o text_log não está habilitado ou o valor de text_log.level é muito baixo. Para visualizar logs de texto, defina o parâmetro text_log.level com um valor adequado às suas necessidades:

Valor	Descrição	Casos de uso
trace	Nível de log mais detalhado. Registra todas as operações e eventos.	Rastreamento da execução do programa durante desenvolvimento e depuração.
debug	Inclui informações detalhadas úteis durante o desenvolvimento, mas menos verboso que trace. Geralmente registra chamadas de função e estados de variáveis.	Depuração de programas.
information	Registra operações normais e eventos de status, como início de service e conclusão de tarefas. Normalmente indica que o sistema opera sem erros.	N/A
warning	Indica problemas potenciais ou erros não fatais. O sistema continua em execução, mas algumas condições podem exigir atenção.	Monitoramento do sistema, análise de problemas potenciais e otimização.
error	Indica que o sistema encontrou erros que afetam alguns recursos ou operações. O sistema pode continuar rodando, mas esses erros devem ser tratados.	Monitoramento do sistema e análise de erros para solução de problemas.