このトピックでは、ApsaraDB for ClickHouse クラスターの config.xml 設定ファイルでグローバルパラメーターを変更する方法について説明します。
背景情報
ApsaraDB for ClickHouse クラスターにはいくつかのパラメーターがあります。これらのパラメーターのデフォルト値は、通常 config.xml ファイルと user.xml ファイルで設定されます。パラメーターを変更してインスタンスを最適化できます。これらのファイルは、異なる目的で使用されます:
user.xml 設定ファイル:
SET GLOBALコマンドを使用してパラメーター値を変更できます。これらの変更は、再起動を必要とせずに有効になります。詳細については、「user.xml パラメーターの変更」をご参照ください。config.xml 設定ファイル: コンソールでパラメーター値を変更できます。手順については、このトピックのプロシージャをご参照ください。
注意事項
XML モードでのパラメーター設定と変更履歴の表示機能は、2021 年 12 月 1 日以降に作成された Community Edition クラスターでのみサポートされます。
Enterprise Edition クラスターは、XML モードでのパラメーター設定をサポートしていません。
XML モードではパラメーターを削除できません。XML モードで設定できるパラメーターは、デフォルトモードのパラメーターと同じです。
変更されたパラメーターが有効になるために再起動が必要な場合、変更を送信するとクラスターは自動的に再起動します。パラメーターを送信する前に、クラスターの再起動がサービスに影響しないことを確認してください。
クラスターへの影響
クラスターが [設定変更中] または [再起動中] 状態の場合、クラスター情報のみを表示できます。スペックアップ、スケールアウト、スケールインなどの操作は実行できません。
変更されたパラメーターが有効になるために再起動が必要な場合、変更が送信された後にクラスターは自動的に再起動します。サービスの停止を避けるため、この操作はオフピーク時に実行することをお勧めします。
パラメーターの変更
パラメーターを変更する手順は、クラスターのエディションによって異なります。
prometheus.port または text_log パラメーターの変更については、「重要なパラメーター」をご参照ください。
Enterprise Edition
ApsaraDB for ClickHouse コンソール にログオンします。
ページの左上隅で、クラスターが配置されているリージョンを選択します。
[クラスター] ページで、[Enterprise Edition] タブをクリックし、クラスターの ID をクリックします。
左側のナビゲーションウィンドウで、[パラメーター管理] をクリックします。
[実行中のパラメーター値] 列で、編集アイコン
をクリックします。指定された有効値内で新しい値を入力し、[OK] をクリックします。パラメーターを変更した後、ページの右上隅にある [パラメーターの送信] をクリックします。
[設定の保存] ダイアログボックスで、パラメーター値の変更を確認します。次に、変更の理由を入力し、[パラメーターの送信] をクリックします。
重要送信されたパラメーターが有効になるために再起動が必要な場合、ClickHouse は自動的にクラスターを再起動します。クラスターの再起動がサービスに影響しないことを確認してください。
パラメーターを送信すると、システムは自動的にパラメーター値を検証します。パラメーター値が無効な場合、[エラー] メッセージが表示されます。[ErrorCode] が 102 の場合、値は無効です。前のステップに戻り、指定された [入力範囲] 内の値を入力して、パラメーターを再度送信します。
Community Edition
ApsaraDB for ClickHouse コンソール にログオンします。
ページの左上隅で、クラスターが配置されているリージョンを選択します。
[クラスター] ページで、[Community Edition] タブをクリックし、クラスターの ID をクリックします。
左側のナビゲーションウィンドウで、[パラメーター設定] をクリックします。
[パラメーター設定] ページで、[設定] タブをクリックします。[デフォルトモード] または [XML モード] を選択してパラメーターを変更します。
重要prometheus.port パラメーターの値の範囲は、ApsaraDB for ClickHouse コンソールで制限されています。2182 から 3000 までのポート番号のみ入力できます。
デフォルトモード: [実行中のパラメーター値] 列で、編集アイコン
をクリックします。指定された有効値内で新しい値を入力し、[OK] をクリックします。XML モード: ページの右上隅にある [編集] をクリックしてパラメーターを変更します。
(オプション) ページの右上隅で [変更されたパラメーターのみ表示] を選択すると、変更したがまだ送信していないパラメーターのみが表示されます。
パラメーターを変更した後、ページの右上隅にある [パラメーターの送信] をクリックします。
[設定の保存] ダイアログボックスで、パラメーター値の変更を確認します。次に、変更の理由を入力し、[パラメーターの送信] をクリックします。
重要送信されたパラメーターが有効になるために再起動が必要な場合、ClickHouse は自動的にクラスターを再起動します。クラスターの再起動がサービスに影響しないことを確認してください。
XML モードで、パラメーター値が無効な場合、[エラー] メッセージが表示されます。[ErrorCode] が 102 の場合、値は無効です。前のステップに戻り、指定された [入力範囲] 内の値を入力して、パラメーターを再度送信します。
変更の復元
変更を復元できるのは、変更されたがまだ送信されていないパラメーターのみです。
[XML モード] の Community Edition クラスターおよび Enterprise Edition クラスターでは、一度にすべての変更を復元することしかできません。
パラメーターを変更した後に変更を復元するには、パラメーターを送信する前に次の操作を実行します:
単一のパラメーターへの変更を復元するには、パラメーター値の横にある
アイコンをクリックします。ApsaraDB for ClickHouse は、送信されていない変更を復元し、パラメーターを以前の値に戻します。すべてのパラメーターの変更を復元するには、パラメーターリストの右上隅にある [復元] をクリックします。ApsaraDB for ClickHouse は、送信されていないすべての変更されたパラメーターを以前の値に復元します。
変更履歴の表示
Enterprise Edition
ApsaraDB for ClickHouse コンソール にログオンします。
ページの左上隅で、クラスターが配置されているリージョンを選択します。
[クラスター] ページで、[Enterprise Edition] タブをクリックし、クラスターの ID をクリックします。
左側のナビゲーションウィンドウで、[パラメーター管理] をクリックします。
[パラメーター管理] ページで、[変更履歴] タブをクリックします。次のいずれかの方法で変更履歴を表示します:
[過去 30 日間] または [過去 7 日間] をクリックして、過去 30 日間または 7 日間の変更履歴を表示します。
開始時刻と終了時刻を選択して、特定の期間の変更履歴を表示します。
Community Edition
ApsaraDB for ClickHouse コンソールにログインします。
ページの左上隅で、クラスターが配置されているリージョンを選択します。
[クラスター] ページで、[Community Edition] タをクリックし、クラスターの ID をクリックします。
左側のナビゲーションウィンドウで、[パラメーター設定] をクリックします。
[パラメーター設定] ページで、[変更履歴] タブをクリックします。次のいずれかの方法で変更履歴を表示します:
[過去 30 日間] または [過去 7 日間] をクリックして、過去 30 日間または 7 日間の変更履歴を表示します。
開始時刻と終了時刻を選択し、[クエリ] をクリックして、特定の期間の変更履歴を表示します。
重要なパラメーター
prometheus.port パラメーターの値の範囲は、ApsaraDB for ClickHouse コンソールで制限されています。2182 から 3000 までのポート番号のみ入力できます。
一部のクラスターバージョンでは、text_log がデフォルトで有効になっていないか、text_log.level が低すぎる設定になっています。テキストログを表示するには、text_log.level パラメーターを適切なレベルに設定する必要があります:
パラメーター値
説明
シナリオ
trace
最も詳細なログレベルです。すべての操作とイベントを記録します。
開発およびデバッグ中にプログラムの実行フローをトレースします。
debug
開発中に必要となる可能性のある詳細情報が含まれますが、trace レベルよりも冗長ではありません。通常、関数呼び出しや変数ステータスなどの情報を記録します。
プログラムをデバッグします。
information
サービスの開始やタスクの完了など、通常のシステム操作やステータス情報を記録するために使用されます。この情報は通常、システムがエラーなしで正常に実行されていることを示します。
該当なし
warning
潜在的な問題や致命的でないエラーを示します。システムはまだ実行中ですが、注意が必要な状況がある可能性があります。
システムを監視し、潜在的な問題を分析し、システムを最適化します。
error
システムでエラーが発生し、一部のシステム機能や操作に影響が出たことを示します。システムはまだ実行中かもしれませんが、これらのエラーには迅速に対処する必要があります。
システムを監視し、エラーを分析して問題の解決を支援します。