How to modify global parameters in the config.xml file of an ApsaraDB for ClickHouse cluster - ApsaraDB for ClickHouse

Modifiez les paramètres globaux du fichier config.xml d'un cluster ApsaraDB for ClickHouse pour optimiser les performances de l'instance.

Contexte

Un cluster ApsaraDB for ClickHouse utilise les valeurs par défaut configurées dans les fichiers config.xml et user.xml. Modifiez ces paramètres pour optimiser votre instance :

Fichier de configuration user.xml : modifiez les paramètres en exécutant la commande SET GLOBAL. Les modifications prennent effet immédiatement sans redémarrage. Pour plus d'informations, reportez-vous à la rubrique Modifier les paramètres user.xml.
Fichier de configuration config.xml : modifiez les paramètres depuis la console.

Notes d'utilisation

Pour les clusters de l'édition compatible avec la communauté, vous ne pouvez configurer les paramètres en mode XML et afficher l'historique des modifications que si le cluster a été créé après le 1er décembre 2021.
Les clusters de l'édition Enterprise ne prennent pas en charge la configuration des paramètres en mode XML.
Le mode XML ne permet pas de supprimer des paramètres. Les paramètres configurables en mode XML sont identiques à ceux du mode par défaut.
Si vous modifiez des paramètres nécessitant un redémarrage pour prendre effet, le cluster redémarre automatiquement une fois les modifications terminées. Avant de soumettre les paramètres, assurez-vous que le redémarrage du cluster n'affectera pas vos activités.

Impacts sur le cluster

Lorsque le cluster est dans l'état Changing Configurations ou Restarting, vous pouvez uniquement consulter les informations du cluster. Vous ne pouvez pas effectuer d'opérations telles que la mise à niveau du type d'instance, le scale-out ou le scale-in.
Si vous modifiez des paramètres nécessitant un redémarrage pour prendre effet, le cluster redémarre automatiquement une fois les modifications terminées. Effectuez cette opération pendant les heures creuses afin d'éviter toute interruption de service.

Modification des paramètres

La procédure de modification des paramètres varie selon l'édition du cluster.

Important

Si vous devez modifier les paramètres prometheus.port ou text_log, reportez-vous à la section Paramètres importants.

Édition Enterprise

Connectez-vous à la console ApsaraDB for ClickHouse.
Dans le coin supérieur gauche de la page, sélectionnez la région de votre cluster cible.
Sur la page Clusters, cliquez sur l'onglet Enterprise Edition Clusters, puis cliquez sur l'ID du cluster cible.
Dans le volet de navigation de gauche, cliquez sur Parameter Management.
Dans la colonne Parameter Value, cliquez sur l'icône de modification pour modifier la valeur. Saisissez une valeur comprise dans la plage valide, puis cliquez sur OK.
Une fois les paramètres souhaités modifiés, cliquez sur Submit Parameters dans le coin supérieur droit de la page.
Dans la boîte de dialogue Save Settings, examinez les valeurs des paramètres avant et après la modification, confirmez les changements, indiquez un motif pour la modification, puis cliquez sur OK.

Important
Si vous soumettez des paramètres nécessitant un redémarrage pour prendre effet, le cluster ClickHouse redémarre automatiquement une fois les modifications terminées. Avant de poursuivre, assurez-vous que le redémarrage n'affectera pas vos activités.

Après avoir soumis les paramètres, le système valide leurs valeurs. Si une valeur de paramètre est invalide, un message d'erreur s'affiche. Le code d'erreur 102 indique que la valeur saisie est invalide. Revenez à l'étape précédente, saisissez une valeur comprise dans la plage valide, puis soumettez à nouveau les paramètres.

Édition compatible avec la communauté

Connectez-vous à la console ApsaraDB for ClickHouse.
Dans le coin supérieur gauche de la page, sélectionnez la région de votre cluster cible.
Sur la page Clusters, cliquez sur l'onglet Clusters of Community-compatible Edition, puis cliquez sur l'ID du cluster cible.
Dans le volet de navigation de gauche, cliquez sur Parameter Configuration.
Cliquez sur l'onglet Settings. Sélectionnez le mode Default Mode ou XML Mode pour modifier les paramètres.

Important
Dans la console ApsaraDB for ClickHouse, la valeur du paramètre prometheus.port doit être comprise entre 2182 et 3000.
- Mode par défaut : dans la colonne Parameter Value, cliquez sur l'icône de modification pour passer en mode édition. Saisissez une valeur comprise dans la plage valide, puis cliquez sur OK.
- Mode XML : dans le coin supérieur droit de la page, cliquez sur Modify pour modifier les paramètres souhaités dans le fichier.
Une fois les paramètres souhaités modifiés, cliquez sur Submit Parameters dans le coin supérieur droit de la page.
Dans la boîte de dialogue Save Settings, examinez les valeurs des paramètres avant et après la modification, confirmez les changements, indiquez un motif pour la modification, puis cliquez sur Submit Parameters.
Important
- Si vous soumettez des paramètres nécessitant un redémarrage pour prendre effet, le cluster ClickHouse redémarre automatiquement une fois les modifications terminées. Avant de poursuivre, assurez-vous que le redémarrage n'affectera pas vos activités.
- En mode XML, si une valeur de paramètre est invalide, un message d'erreur s'affiche. Le code d'erreur 102 indique que la valeur saisie est invalide. Revenez à l'étape précédente, saisissez une valeur comprise dans la plage valide, puis soumettez à nouveau les paramètres.
|
**Code d'erreur**
|
**Description**
| | --- | --- | |
101
|
Une erreur inconnue s'est produite. Pour plus d'informations, consultez le message d'erreur.
| |
102
|
La valeur saisie est invalide. Saisissez une valeur comprise dans la plage indiquée dans **Modifiable Parameter Values**.
|

Annulation des modifications

Remarque

Vous pouvez uniquement annuler les modifications non soumises.
Pour les clusters de l'édition Enterprise et pour les clusters de l'édition compatible avec la communauté en mode Modifiable Parameter Values, vous ne pouvez annuler toutes les modifications de paramètres qu'en une seule fois.

Pour annuler des modifications non soumises, effectuez l'une des opérations suivantes :

Annuler la modification d'un seul paramètre : cliquez sur l'icône située à côté de la valeur du paramètre. ApsaraDB for ClickHouse annule la modification non soumise de ce paramètre et rétablit sa valeur précédente.
Annuler toutes les modifications de paramètres : cliquez sur XML Mode dans le coin supérieur droit de la liste des paramètres. ApsaraDB for ClickHouse annule toutes les modifications non soumises et rétablit les valeurs précédentes.

Consultation de l'historique des modifications

Édition Enterprise

Connectez-vous à la console ApsaraDB for ClickHouse.
Dans le coin supérieur gauche de la page, sélectionnez la région de votre cluster cible.
Sur la page Cancel, cliquez sur l'onglet Enterprise Edition Clusters, puis cliquez sur l'ID du cluster cible.
Dans le volet de navigation de gauche, cliquez sur Parameter Management.
Cliquez sur l'onglet Change History pour consulter l'historique des modifications de l'une des manières suivantes :
- Cliquez sur Last 30 Days ou Last 7 Days pour afficher les modifications de la période correspondante.
- Spécifiez une plage horaire pour afficher les enregistrements de modification de cette période.

Édition compatible avec la communauté

Connectez-vous à la console ApsaraDB for ClickHouse.
Dans le coin supérieur gauche de la page, sélectionnez la région de votre cluster cible.
Sur la page Clusters, cliquez sur l'onglet Clusters, puis cliquez sur l'ID du cluster cible.
Dans le volet de navigation de gauche, cliquez sur Clusters of Community-compatible Edition.
Cliquez sur l'onglet Parameter Configuration pour consulter l'historique des modifications de l'une des manières suivantes :
- Cliquez sur Change History ou Last 30 Days pour afficher les modifications de la période correspondante.
- Spécifiez une plage horaire et cliquez sur Last 7 Days pour afficher les enregistrements de modification de cette période.

Paramètres importants

Dans la console ApsaraDB for ClickHouse, la valeur du paramètre prometheus.port est limitée à un numéro de port compris entre 2182 et 3000.
Dans certaines versions de cluster, text_log n'est pas activé ou la valeur de text_log.level est trop faible. Pour afficher les journaux texte, définissez le paramètre text_log.level sur une valeur appropriée selon vos besoins :
|
**Valeur**
|
**Description**
|
**Cas d'utilisation**
| | --- | --- | --- | |
trace
|
Niveau de journalisation le plus détaillé. Il enregistre toutes les opérations et événements.
|
Suivi de l'exécution du programme lors du développement et du débogage.
| |
debug
|
Comprend des informations détaillées utiles lors du développement, mais moins verbeuses que trace. Il enregistre généralement les appels de fonction et les états des variables.
|
Débogage d'un programme.
| |
information
|
Enregistre les opérations normales et les événements de statut, tels que le démarrage d'un service et l'achèvement d'une tâche. Cela indique généralement que le système fonctionne normalement sans erreur.
|
S.O.
| |
warning
|
Indique des problèmes potentiels ou des erreurs non fatales. Le système continue de fonctionner, mais certaines conditions peuvent nécessiter une attention particulière.
|
Surveillance du système, analyse des problèmes potentiels et optimisation du système.
| |
error
|
Indique que le système a rencontré des erreurs affectant certaines fonctionnalités ou opérations. Le système peut toujours fonctionner, mais vous devez corriger ces erreurs.
|
Surveillance du système et analyse des erreurs pour résoudre les problèmes.
|