ClickHouse のモニター

オンラインで編集する

「 Instana 」エージェントをインストールすると、「 ClickHouse 」センサーが自動的に展開およびインストールされます。

ClickHouse オープンソースのカラム指向データベース管理システムです。 Instana ClickHouse サーバーのプロセスを自動的に検出して監視できます。

詳細については、 ClickHouse をご覧ください。

サポート情報

オンラインで編集する

ClickHouse センサーが現在の環境と互換性があるかどうかを確認するには、以下のサポート情報セクションをご確認ください：

対応バージョンとサポート方針

オンラインで編集する

このセンサーは、Clickhouse 24.6 およびそれ以前のバージョンをサポートしています。

以下の表は、最新のサポート対象バージョンとサポート方針を示しています：


テクノロジー	サポート・ポリシー	最新バージョン	サポートされる最新バージョン
Clickhouse	45 日間	26.3.16.16	26.3.10.60

サポートポリシーに関する詳細については、「センサーのサポート戦略」を参照してください。

センサー (データ収集)

オンラインで編集する

追跡対象の構成

オンラインで編集する

Instana エージェントは、デフォルトの場所 /etc/clickhouse-server/config.xml で、または clickhouse-server プロセスの開始時に渡される --config-file 引数を調べることにより、ClickHouse 構成ファイル (config.xml) を自動的に検出します。ただし、現在のところ、このエージェントは、メインの設定ファイルと同じディレクトリにある conf.d/config.d ディレクトリ内の補助設定ファイルで指定された設定のオーバーライドに対応していません（ ClickHouse のドキュメントの「設定ファイル」のセクションを参照してください）。 ZooKeeper 構成も、現在は自動的には考慮されません。

以下の構成値は、ClickHouse 構成ファイルを解析することによって自動的に追跡されます。

http_port
tcp_port
https_port
tcp_ssl_port
version
log
error_log
interserver_http_port
listen_hosts
max_connections
keep_alive_timeout
max_concurrent_queries
uncompressed_cache_size
mark_cache_size
path
tmp_path
user_config_file_name
default_profile
default_database
timezone
umask
builtin_dictionaries_reload_interval
max_session_timeout
default_session_timeout

メトリック

オンラインで編集する

以下のメトリックが収集されます。

Merge
ReplicatedFetch
ReplicatedSend
ReplicatedChecks
BackgroundPoolTask
DiskSpaceReservedForMerge
DistributedSend
QueryPreempted
TCPConnection
HTTPConnection
InterserverConnection
OpenFileForRead
OpenFileForWrite
Read
Write
SendExternalTables
QueryThread
ReadonlyReplica
LeaderReplica
MemoryTracking
MemoryTrackingInBackgroundProcessingPool
MemoryTrackingForMerges
LeaderElection
EphemeralNode
ZooKeeperWatch
DelayedInserts
ContextLockWait
StorageBufferRows
StorageBufferBytes
DictCacheRequests
Revision
RWLockWaitingReaders
RWLockWaitingWriters
RWLockActiveReaders
RWLockActiveWriters

構成

オンラインで編集する

前のセクションで説明したように、 Instana エージェントは自動的に ClickHouse 設定ファイル（config.xml）を検出します。エージェントは、この構成ファイルを解析することにより、ClickHouse に接続するために必要な大部分の構成値を把握できます。

Instana エージェントは、 HTTP インターフェースを介して ClickHouse にアクセスします。 vanilla ClickHouse インストール済み環境では、資格情報なしにこのインターフェースにアクセスできます。この場合、Instana ClickHouse センサーに特別な構成は必要ありません。

一方、資格情報を要求するように ClickHouse HTTP アクセスを構成した場合は、その資格情報を Instana エージェントに提供する必要があります。これを行うには、エージェントの構成ファイル <agent_install_dir>/etc/instana/configuration.yamlでそれらを構成します。

以下に、ClickHouse のモニターに使用可能なすべての構成値を示します。

# Clickhouse
com.instana.plugin.clickhouse:
  enabled: false
  user: default    # the username used to access ClickHouse's HTTP interface
  password: root   # the password used to access ClickHouse's HTTP interface
  protocol: http   # 'http' or 'https'
  host: localhost  # the host name or IP of the ClickHouse server
  httpPort: 8123   # the port of the ClickHouse server
  tracingEnabled: false
  profilingEnabled: false
  clusterName: saas
  poll_rate: 5 #Values are in seconds. Default Value 5 Sec.
  monitorTables:    # more in-depth metrics for these tables
    - 'database.table1'
    - 'database.table2'
    - 'database.table3'

注：ポーリング間隔が指定されていない場合、デフォルトでは5秒になります。

enabled: この変数は、 ClickHouse モニターのセンサーを有効または無効にします。センサーを有効にするには true を入力し、無効にするには false を入力します。
user: ClickHouse の HTTP インターフェースにアクセスするためのユーザー名。
password: ClickHouse の HTTP インターフェースにアクセスするためのパスワード。
protocol: 'http' または 'https'のいずれか
host: ClickHouse サーバーのホスト名または IP アドレス。
httpPort: ClickHouse サーバーのポート。
tracingEnabled: この変数は、トレースを有効または無効にします。トレース・メトリックを収集するためのトレースを有効にするには true を入力し、無効にするには false を入力します。
profilingEnabled: この変数は、プロファイル作成を有効または無効にします。プロファイル・データを収集するためのプロファイル作成を有効にするには true を入力し、無効にするには false を入力します。
clusterName: モニター対象のクラスターの名前。
monitorTables: 詳細なメトリックが必要なテーブルのリスト。

httpPort の構成値は整数値でなければなりません。そうでない場合は、無視されます。つまり、数値に解析できない場合は、標準ポートが使用されます。