メインコンテンツまでスキップ
メインコンテンツまでスキップ

System Tables Overview

システムテーブルの概要

システムテーブルは以下に関する情報を提供します:

  • サーバーの状態、プロセス、および環境。
  • サーバーの内部プロセス。
  • ClickHouseバイナリがビルドされた際に使用されたオプション。

システムテーブル:

  • system データベースに存在。
  • データの読み取りのみが可能。
  • 削除や変更はできませんが、切り離すことは可能です。

ほとんどのシステムテーブルは、そのデータをRAMに格納します。ClickHouseサーバーは、起動時にこのようなシステムテーブルを作成します。

他のシステムテーブルとは異なり、システムログテーブル metric_logquery_logquery_thread_logtrace_logpart_logcrash_logtext_log、および backup_log は、 MergeTree テーブルエンジンによって提供され、デフォルトではファイルシステムにデータを保存します。ファイルシステムからテーブルを削除すると、ClickHouseサーバーは次回データを書き込む際に再び空のテーブルを作成します。新しいリリースでシステムテーブルのスキーマが変更された場合、ClickHouseは現在のテーブルの名前を変更し、新しいテーブルを作成します。

システムログテーブルは、 /etc/clickhouse-server/config.d/ 内にテーブルと同じ名前の設定ファイルを作成するか、 /etc/clickhouse-server/config.xml に対応する要素を設定することでカスタマイズできます。カスタマイズ可能な要素は以下の通りです:

  • database: システムログテーブルが属するデータベース。このオプションは現在非推奨です。すべてのシステムログテーブルはデータベース system にあります。
  • table: データを挿入するテーブル。
  • partition_by: PARTITION BY 式を指定します。
  • ttl: テーブルの TTL 式を指定します。
  • flush_interval_milliseconds: ディスクにデータをフラッシュする間隔。
  • engine: パラメータを持つ完全なエンジン式(ENGINE = で始まる)を提供します。このオプションは partition_by および ttl と競合します。これらを同時に設定すると、サーバーは例外を発生させて終了します。

例:

デフォルトでは、テーブルの成長は無制限です。テーブルのサイズを制御するために、古いログレコードを削除するための TTL 設定を使用できます。また、MergeTreeエンジンテーブルのパーティショニング機能も利用できます。

システムメトリクスのソース

システムメトリクスを収集するために、ClickHouseサーバーは以下を使用します:

  • CAP_NET_ADMIN の権限。
  • procfs(Linuxのみ)。

procfs

ClickHouseサーバーが CAP_NET_ADMIN の権限を持っていない場合、代わりに ProcfsMetricsProvider を使用しようとします。ProcfsMetricsProvider は、クエリごとのシステムメトリクス(CPUおよびI/Oのため)を収集することを可能にします。

procfsがサポートされ、有効化されているシステムでは、ClickHouseサーバーは以下のメトリクスを収集します:

  • OSCPUVirtualTimeMicroseconds
  • OSCPUWaitMicroseconds
  • OSIOWaitMicroseconds
  • OSReadChars
  • OSWriteChars
  • OSReadBytes
  • OSWriteBytes
注記

OSIOWaitMicrosecondsは、Linuxカーネル5.14.x以降でデフォルトで無効です。sudo sysctl kernel.task_delayacct=1を使用するか、/etc/sysctl.d/kernel.task_delayacct = 1 を設定した.confファイルを作成することで有効化できます。

ClickHouse Cloudにおけるシステムテーブル

ClickHouse Cloudでは、システムテーブルは、セルフマネージドのデプロイメントと同様に、サービスの状態とパフォーマンスに関する重要な洞察を提供します。一部のシステムテーブルはクラスタ全体のレベルで操作され、特に分散メタデータを管理するKeeperノードからデータを派生させるテーブルはそうです。これらのテーブルは、クラスタの集合的な状態を反映し、個々のノードでクエリした際に一貫性が保たれるべきです。たとえば、partsは、クエリ元のノードに関係なく一貫性があるべきです:

逆に、他のシステムテーブルはノード固有であり、例えば、メモリ内で動作するか、MergeTreeテーブルエンジンを使用してデータを持続させます。これは通常、ログやメトリクスといったデータに典型的です。この持続性により、歴史的データが分析のために利用可能であり続けます。しかし、これらのノード固有のテーブルは各ノードに固有のものであります。

一般的に、システムテーブルがノード固有かどうかを判断する際に適用できる以下のルールがあります:

  • _log サフィックスを持つシステムテーブル。
  • メトリクスを公開するシステムテーブル(例: metrics, asynchronous_metrics, events)。
  • 進行中のプロセスを公開するシステムテーブル(例: processes, merges)。

さらに、システムテーブルの新バージョンは、アップグレードやスキーマの変更によって作成されることがあります。これらのバージョンは数値サフィックスを用いて命名されます。

例えば、ノードによって実行された各クエリの行を含む system.query_log テーブルを考えてみます:

複数バージョンのクエリ

merge 関数を使用して、これらのテーブルを横断してクエリを実行することができます。例えば、以下のクエリは各 query_log テーブルに対してターゲットノードに発行された最新のクエリを特定します:

数字サフィックスに頼らないでください

テーブルの数字サフィックスはデータの順序を示唆することができますが、それに頼るべきではありません。このため、特定の日付範囲を対象とする際には、常にマージテーブル機能と日付フィルタを組み合わせて使用してください。

重要なことに、これらのテーブルは依然として 各ノードにローカル です。

ノード間のクエリ

クラスタ全体を包括的に表示するために、ユーザーは clusterAllReplicas 関数を merge 関数と組み合わせて活用することができます。clusterAllReplicas 関数は、"default" クラスター内のすべてのレプリカ間でシステムテーブルをクエリすることを可能にし、ノード固有のデータを統合された結果に集約します。merge 関数と組み合わせることで、クラスター内の特定のテーブルのすべてのシステムデータを対象とすることができます。

このアプローチは、クラスタ全体の操作を監視し、デバッグする際に特に価値があります。ユーザーはClickHouse Cloudデプロイメントの健全性とパフォーマンスを効果的に分析することができます。

注記

ClickHouse Cloudは冗長性とフェイルオーバーのために複数のレプリカのクラスターを提供します。これにより、動的なオートスケーリングやゼロダウンタイムのアップグレードなどの機能が可能になります。特定の時点において、新しいノードがクラスターに追加されるプロセス中またはクラスターから削除されていることがあります。これらのノードをスキップするには、clusterAllReplicasを使用したクエリに SETTINGS skip_unavailable_shards = 1 を追加してください。以下のようになります。

例えば、分析にしばしば不可欠な query_log テーブルをクエリする際の違いを考えてみましょう。

ノード間およびバージョン間のクエリ

システムテーブルのバージョニングのため、これでもクラスタ内の全データを表すものではありません。上記をmerge 関数と組み合わせることで、特定の日付範囲について正確な結果が得られます: