Premiers pas avec Managed ClickStack

Déployez Managed ClickStack sur ClickHouse Cloud, envoyez un événement de test via votre pipeline d’ingestion et vérifiez que l’événement est disponible dans la ClickStack UI. ClickHouse Cloud exploite le backend ClickHouse tandis que vous conservez le contrôle du pipeline d’ingestion et du schéma. Managed ClickStack fournit :

Mise à l’échelle automatique de la capacité de calcul, indépendante du stockage
Rétention peu coûteuse et pratiquement illimitée, basée sur le stockage objet
Isolation indépendante des charges de travail de lecture et d’écriture avec des warehouses
Authentification intégrée
Sauvegardes automatisées
Fonctionnalités de sécurité et de conformité
Mises à niveau transparentes

Avant de commencer

Vous pouvez également envoyer des données directement vers ClickHouse à l’aide d’une intégration prise en charge et de votre propre schéma.

Créer un service ClickHouse Cloud

Effectuez l’étape Créer un service ClickHouse du quickstart ClickHouse Cloud. Avant de poursuivre, vérifiez que le service est en cours d’exécution.

Cette page présente le parcours OpenTelemetry. Utilisez le sélecteur en haut du guide pour basculer entre OpenTelemetry (recommandé) et Vector.

Préparez votre environnement d’ingestion

Pour démarrer un nouvel OpenTelemetry Collector, installez Docker. Pour Kubernetes, déployez le collector avec Helm.
Pour utiliser un collector existant, exécutez-le en tant que gateway et assurez-vous que sa distribution inclut l’exportateur ClickHouse. Vous ajouterez la configuration requise dans ce guide.

Configurer Managed ClickStack

Choisissez une source d’ingestion et configurez le collecteur

Depuis votre service ClickHouse Cloud, lancez ClickStack. Sur la page Premiers pas de ClickStack, sélectionnez Commencer l’ingestion.Sur la page Choisir une source d’ingestion, sélectionnez OpenTelemetry.

OpenTelemetry recommandéOpenTelemetry fournit des schémas préconfigurés pour les journaux, les traces, les métriques et les sessions.

Démarrer un nouveau collecteur
Utiliser un collecteur existant

ClickStack génère la commande du collecteur avec les identifiants administrateur default. Nous recommandons d’utiliser des identifiants d’ingestion dédiés afin de séparer l’accès à l’ingestion des tâches d’administration et d’éviter de dépendre du mot de passe administrateur.

Créer des identifiants d’ingestion dédiés (recommandé)

Dans ClickHouse Cloud, ouvrez la console SQL de votre service et exécutez :

CREATE USER `clickstack-ingest` IDENTIFIED WITH sha256_password BY '<password>';
GRANT SELECT, INSERT, CREATE DATABASE, CREATE TABLE, CREATE VIEW ON default.* TO `clickstack-ingest`;

Dans la commande générée, remplacez CLICKHOUSE_USER="default" par CLICKHOUSE_USER="clickstack-ingest" et définissez CLICKHOUSE_PASSWORD sur le mot de passe de l’utilisateur dédié.

Pour continuer avec les identifiants administrateur default, copiez la commande depuis l’onglet Démarrer le collecteur. ClickStack préremplit le point de terminaison de service. Remplacez l’espace réservé du mot de passe par celui de votre service. Si vous ne l’avez plus, récupérez ou réinitialisez vos informations de connexion.La commande se présente comme suit :

docker run -e CLICKHOUSE_ENDPOINT="https://<host>:8443" \
    -e CLICKHOUSE_USER="default" \
    -e CLICKHOUSE_PASSWORD="<your_password_here>" \
    -p 4317:4317 -p 4318:4318 \
    clickhouse/clickstack-otel-collector:latest

Remplacez <host> et <your_password_here> par les valeurs correspondant à votre service ClickHouse Cloud, puis exécutez la commande.Le collecteur s’exécute au premier plan. Laissez ce terminal ouvert et utilisez un second terminal pour les commandes restantes de ce guide.

Cette commande expose les ports OTLP sans authentification et est destinée à une évaluation locale. Avant d’envoyer du trafic de production, sécurisez le collecteur.

Sélectionnez Configurer un collecteur existant, puis adaptez la configuration de votre collecteur.Exécutez le collecteur comme passerelle entre vos applications et ClickHouse Cloud. La configuration ci-dessous ajoute les exporters ClickHouse et les pipelines de signaux requis.L’exemple utilise les identifiants default générés par ClickStack. Pour utiliser des identifiants d’ingestion dédiés, suivez la procédure facultative de l’onglet Démarrer un nouveau collecteur. Dans les deux blocs d’exporter ClickHouse, remplacez username: default par username: clickstack-ingest et définissez password sur le mot de passe de l’utilisateur dédié.Fusionnez les composants suivants avec votre configuration existante plutôt que de remplacer des receivers, processeurs, exporters ou extensions non concernés.

Composants de collecteur requisVotre distribution de collecteur doit inclure l’exporter ClickHouse et le connecteur de routage. La distribution OpenTelemetry Collector Contrib inclut ces deux composants.

L’exemple ajoute des receivers OTLP, le traitement par lots et la limitation de mémoire, le routage de Session Replay et des exporters ClickHouse.Remplacez les placeholders endpoint et password par les identifiants générés par ClickStack :

receivers:
  otlp/hyperdx:
    protocols:
      grpc:
        include_metadata: true
        endpoint: "0.0.0.0:4317"
      http:
        cors:
          allowed_origins: ["*"]
          allowed_headers: ["*"]
        include_metadata: true
        endpoint: "0.0.0.0:4318"
processors:
  batch:
  memory_limiter:
    # 80% of maximum memory up to 2G, adjust for low memory environments
    limit_mib: 1500
    # 25% of limit up to 2G, adjust for low memory environments
    spike_limit_mib: 512
    check_interval: 5s
connectors:
  routing/logs:
    default_pipelines: [logs/out-default]
    error_mode: ignore
    table:
      - context: log
        statement: route() where IsMatch(attributes["rr-web.event"], ".*")
        pipelines: [logs/out-rrweb]
exporters:
  clickhouse/rrweb:
    database: default
    endpoint: <clickhouse_cloud_endpoint>
    password: <your_password_here>
    username: default
    ttl: 720h
    logs_table_name: hyperdx_sessions
    timeout: 5s
    retry_on_failure:
      enabled: true
      initial_interval: 5s
      max_interval: 30s
      max_elapsed_time: 300s
  clickhouse:
    database: default
    endpoint: <clickhouse_cloud_endpoint>
    password: <your_password_here>
    username: default
    ttl: 720h
    timeout: 5s
    retry_on_failure:
      enabled: true
      initial_interval: 5s
      max_interval: 30s
      max_elapsed_time: 300s

service:
  pipelines:
    traces:
      receivers: [otlp/hyperdx]
      processors: [memory_limiter, batch]
      exporters: [clickhouse]
    metrics:
      receivers: [otlp/hyperdx]
      processors: [memory_limiter, batch]
      exporters: [clickhouse]
    logs/in:
      receivers: [otlp/hyperdx]
      exporters: [routing/logs]
    logs/out-default:
      receivers: [routing/logs]
      processors: [memory_limiter, batch]
      exporters: [clickhouse]
    logs/out-rrweb:
      receivers: [routing/logs]
      processors: [memory_limiter, batch]
      exporters: [clickhouse/rrweb]

Réutilisez votre receiver OTLP existant et conservez ses paramètres d’authentification et TLS. Si votre configuration utilise déjà les ID de composants ou de pipelines de l’exemple, fusionnez-les ou renommez-les au lieu de créer des ID en double. L’exécution de deux receivers sur les ports 4317 et 4318 provoque un conflit de ports.Après avoir fusionné la configuration, rechargez ou redémarrez le collecteur selon votre processus de déploiement habituel.Pour plus de détails sur la configuration des collecteurs OpenTelemetry, consultez Ingestion avec OpenTelemetry.

Envoyer des données de test

Envoyez un log de test avec l’horodatage actuel :

NOW_NANO="$(date +%s)000000000"

curl -i "http://localhost:4318/v1/logs" \
  -H "Content-Type: application/json" \
  --data-binary @- <<EOF
{
  "resourceLogs": [{
    "resource": {
      "attributes": [{
        "key": "service.name",
        "value": {"stringValue": "clickstack-docs-test"}
      }]
    },
    "scopeLogs": [{
      "scope": {"name": "clickstack-docs-test"},
      "logRecords": [{
        "timeUnixNano": "${NOW_NANO}",
        "severityText": "INFO",
        "body": {"stringValue": "ClickStack ingestion test"}
      }]
    }]
  }]
}
EOF

Si vous utilisez un collector existant, remplacez http://localhost:4318 par son endpoint HTTP OTLP. Si le receiver nécessite une authentification, ajoutez le header obligatoire à la commande curl.Une requête réussie renvoie HTTP/1.1 200 OK.

Commencez à explorer et vérifiez l’ingestion

Une fois que ClickStack a détecté les sources de données OpenTelemetry, sélectionnez Start exploring pour ouvrir la vue Search. Recherchez ClickStack ingestion test.Le résultat doit inclure l’événement de test dont le nom de service est clickstack-docs-test.

Vous disposez désormais d’un service Managed ClickStack, d’un pipeline d’ingestion fonctionnel et d’un événement de test que vous pouvez inspecter dans ClickStack.

Étapes suivantes

Si un autre guide nécessite votre endpoint ClickHouse Cloud ou votre mot de passe, récupérez ou réinitialisez vos informations de connexion avant de poursuivre.

Envoyer les données de vos applications et de votre infrastructure

Choisissez le guide correspondant aux données que vous souhaitez envoyer à ClickStack :

Instrumenter une application

Envoyez les traces et les logs de votre application à l’aide d’un SDK OpenTelemetry pris en charge.

Collecter les logs de l’hôte

Transférez les logs de l’hôte depuis un OpenTelemetry Collector exécuté en tant qu’agent.

Surveiller Kubernetes

Collectez les logs, les métriques et les traces d’un cluster Kubernetes.

Explorer d’autres intégrations

Consultez les guides dédiés à d’autres applications et sources de télémétrie.

Explorer des données d’exemple

Utilisez un jeu de données d’exemple pour explorer ClickStack avec des données de télémétrie plus riches :

Logs, traces et métriques d’exemple

Chargez les données de la démo publique et diagnostiquez un problème. Ce guide suppose que vous avez lancé un nouvel OpenTelemetry Collector local. Si vous avez configuré un collector existant, adaptez les paramètres d’endpoint et d’authentification à votre déploiement.

Logs et métriques locaux

Collectez des fichiers locaux et des métriques système sur macOS ou Linux.

Générer des données synthétiques

Utilisez un générateur pour tester l’ingestion sans disposer d’une application ou d’un jeu de données existant :

Générer des données avec otelgen

Envoyez une courte rafale de logs, traces et métriques OTLP synthétiques.

Générer des données avec telemetrygen

Générez des signaux OpenTelemetry configurables pour plusieurs services.

Consultez toutes les données d’exemple et démos ClickStack.

Préparer la mise en production

Consultez les recommandations relatives à la production et au dimensionnement avant d’utiliser ClickStack pour des charges de travail soutenues :

Passer en production

Consultez les recommandations relatives aux identifiants d’ingestion, à la sécurité, à la rétention et à l’exploitation.

Estimer les ressources

Dimensionnez les ressources de calcul en fonction du volume d’ingestion prévu.

Pour les tâches de déploiement, consultez le guide de déploiement de Managed ClickStack.

Premiers pas

Fonctionnalités

Administrer ClickStack

Guides

Partenaires d’intégration

Avant de commencer

Créer un service ClickHouse Cloud

Préparez votre environnement d’ingestion

Configurer Managed ClickStack

Choisissez une source d’ingestion et configurez le collecteur

Envoyer des données de test

Commencez à explorer et vérifiez l’ingestion

Étapes suivantes

Envoyer les données de vos applications et de votre infrastructure

Instrumenter une application

Collecter les logs de l’hôte

Surveiller Kubernetes

Explorer d’autres intégrations

Explorer des données d’exemple

Logs, traces et métriques d’exemple

Logs et métriques locaux

Générer des données synthétiques

Générer des données avec otelgen

Générer des données avec telemetrygen

Préparer la mise en production

Passer en production

Estimer les ressources

​Avant de commencer

​Créer un service ClickHouse Cloud

​Préparez votre environnement d’ingestion

​Configurer Managed ClickStack

Choisissez une source d’ingestion et configurez le collecteur

Envoyer des données de test

Commencez à explorer et vérifiez l’ingestion

​Étapes suivantes

​Envoyer les données de vos applications et de votre infrastructure

Instrumenter une application

Collecter les logs de l’hôte

Surveiller Kubernetes

Explorer d’autres intégrations

​Explorer des données d’exemple

Logs, traces et métriques d’exemple

Logs et métriques locaux

​Générer des données synthétiques

Générer des données avec otelgen

Générer des données avec telemetrygen

​Préparer la mise en production

Passer en production

Estimer les ressources

Avant de commencer

Créer un service ClickHouse Cloud

Préparez votre environnement d’ingestion

Configurer Managed ClickStack

Étapes suivantes

Envoyer les données de vos applications et de votre infrastructure

Explorer des données d’exemple

Générer des données synthétiques

Préparer la mise en production