Surveillance de ClickHouse

Le capteur « ClickHouse » est automatiquement déployé et installé une fois que vous avez installé l'agent « Instana ».

ClickHouse est un système de gestion de bases de données orienté colonnes et open source. Instana peut détecter et surveiller automatiquement les processus du serveur d' ClickHouse.

Pour plus d'informations, consultez le site ClickHouse.

Informations de support

Modifier en ligne

Pour vous assurer que le capteur d' ClickHouse s est compatible avec votre configuration actuelle, consultez les sections d'informations d'assistance suivantes :

Versions prises en charge et politique d'assistance

Modifier en ligne

Le capteur prend en charge les versions 24.6 et antérieures de Clickhouse.

Le tableau suivant présente la dernière version prise en charge et la politique d'assistance :


Technologie	Politique de support	Dernière version technologique	Dernière version prise en charge
Clickhouse	45 jours	26.3.13.31	26.3.10.60

Pour plus d'informations sur la politique d'assistance, consultez la section « Stratégie d'assistance pour les capteurs ».

Capteur (collecte de données)

Modifier en ligne

Configuration suivie

Modifier en ligne

L'agent « Instana » détecte automatiquement le fichier de configuration « ClickHouse » (config.xml), soit à son emplacement par défaut /etc/clickhouse-server/config.xml , soit en analysant --config-file l'argument qui a été transmis lors du lancement du clickhouse-server processus. Cependant, l'agent ne prend actuellement pas en charge (c'est-à-dire qu'il n'analyse pas automatiquement) les modifications de paramètres spécifiées dans les fichiers de configuration auxiliaires situés dans les conf.drépertoiresconfig.d / adjacents au fichier de configuration principal (voir la section « Fichiers de configuration » de la documentation d' ClickHouse ). De même, la configuration ZooKeeper n'est pas automatiquement prise en compte pour le moment.

Les valeurs de configuration suivantes sont automatiquement suivies en analysant le fichier de configuration 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

Métriques

Modifier en ligne

Les métriques suivantes sont collectées :

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

Configuration

Modifier en ligne

L'agent « Instana » détecte automatiquement le fichier de configuration « ClickHouse » (config.xml), comme décrit dans la section précédente. L'agent peut déterminer la plupart des valeurs de configuration dont il a besoin pour se connecter à ClickHouse en analysant ce fichier de configuration.

L'agent « Instana » accède à ClickHouse via son interface HTTP. Dans une installation ClickHouse de type Vanilla, cette interface est accessible sans données d'identification. Dans ce cas, le capteur Instana ClickHouse n'a besoin d'aucune configuration particulière.

Si, d'autre part, vous avez configuré l'accès HTTP ClickHouse pour exiger des données d'identification, vous devez fournir ces données d'identification à l'agent Instana. Pour ce faire, vous pouvez les configurer dans le fichier de configuration de l'agent <agent_install_dir>/etc/instana/configuration.yaml.

Voici toutes les valeurs de configuration possibles pour la surveillance de 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'

Remarque : si l'intervalle d'interrogation n'est pas spécifié, la valeur par défaut est de 5 secondes.

enabled: la variable active ou désactive le détecteur pour la surveillance ClickHouse . Entrez true pour activer le détecteur ou false pour le désactiver.
user: le nom d'utilisateur permettant d'accéder à l'interface ClickHouse'sHTTP,
password: le mot de passe permettant d'accéder à l'interface ClickHouse'sHTTP,
protocol: 'http' ou 'https',
host : nom d'hôte ou adresse IP du serveur ClickHouse
httpPort : port du serveur ClickHouse
tracingEnabled: la variable active ou désactive le traçage. Entrez true pour activer la fonction de trace pour la collecte des métriques de trace ou false pour la désactiver.
profilingEnabled: la variable active ou désactive le profilage. Entrez true pour activer le profilage pour la collecte des données de profil ou false pour le désactiver.
clusterName: nom du cluster à surveiller.
monitorTables: La liste des tables pour lesquelles des métriques approfondies sont requises.

La valeur de configuration de httpPort doit être un entier, sinon elle sera ignorée. En d'autres termes, si elle ne peut pas être analysée en tant que nombre, le port standard sera utilisé.