Premiers pas avec ClickStack Open Source

Exécutez ClickStack Open Source localement, envoyez un événement de test via son OpenTelemetry Collector et vérifiez que l’événement est disponible dans l’interface utilisateur de ClickStack.

Avec ClickStack Open Source, vous exécutez et gérez le backend ClickHouse, l’interface utilisateur de ClickStack et le pipeline d’ingestion. L’image tout-en-un regroupe ces composants et MongoDB dans un unique conteneur Docker pour l’évaluation et les tests locaux.

Les étapes ci-dessous utilisent l’image tout-en-un authentifiée. Si vous souhaitez disposer d’une interface utilisateur locale sans créer de compte, suivez plutôt le guide du mode local avec Docker.

Installez Docker et vérifiez que les ports suivants sont disponibles :

• 8080 pour l’interface utilisateur de ClickStack
• 4317 pour OTLP via gRPC
• 4318 pour OTLP via HTTP
• 8123 pour l’interface HTTP de ClickHouse

Pour les charges de travail soutenues ou en production, consultez les options de déploiement open source et Passer en production.

Démarrer ClickStack

Exécutez l’image tout-en-un :

docker run \
  --name clickstack \
  -p 8123:8123 \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  clickhouse/clickstack-all-in-one:latest

Le conteneur s’exécute au premier plan. Laissez ce terminal ouvert et utilisez un second terminal pour exécuter les autres commandes de ce guide.

Conserver les données et les paramètres

Pour conserver les paramètres de ClickStack, les données et les logs ClickHouse après la suppression du conteneur, exécutez plutôt la commande suivante :

docker run \
  --name clickstack \
  -p 8123:8123 \
  -p 8080:8080 \
  -p 4317:4317 \
  -p 4318:4318 \
  -v "$(pwd)/.volumes/db:/data/db" \
  -v "$(pwd)/.volumes/ch_data:/var/lib/clickhouse" \
  -v "$(pwd)/.volumes/ch_logs:/var/log/clickhouse-server" \
  clickhouse/clickstack-all-in-one:latest

$(pwd) correspond à votre répertoire courant. Cette commande stocke les fichiers persistants dans un répertoire .volumes à cet emplacement.

Ouvrir ClickStack

Une fois ClickStack démarré, ouvrez http://localhost:8080 et créez un compte.

ClickStack se connecte automatiquement à l’instance ClickHouse incluse et crée des sources de données pour les logs, les traces, les métriques et les sessions.

Copier l’API key d’ingestion

Dans la section Prise en main du menu de gauche, sélectionnez Ajouter des données, puis copiez l’API key d’ingestion. La télémétrie envoyée à l’OpenTelemetry Collector inclus doit inclure cette clé dans l’en-tête authorization.

Envoyer des données de test

Dans le second terminal, exportez l’API key d’ingestion :

export CLICKSTACK_API_KEY=<your_ingestion_api_key>

Envoyez un log OTLP avec l’horodatage actuel :

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

curl -i "http://localhost:4318/v1/logs" \
  -H "Content-Type: application/json" \
  -H "authorization: ${CLICKSTACK_API_KEY}" \
  --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

Une requête réussie renvoie HTTP/1.1 200 OK.

Confirmer l’ingestion

Ouvrez la vue Recherche dans ClickStack et recherchez ClickStack ingestion test.

Le résultat doit inclure l’événement de test associé au nom de service clickstack-docs-test.

Vous disposez désormais d’une instance ClickStack locale, d’un endpoint d’ingestion fonctionnel et d’un événement de test que vous pouvez examiner dans ClickStack.

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

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

Logs, traces et métriques d’exemple

Chargez les données de la démo publique et diagnostiquez un incident.

Logs et métriques locaux

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

Pour explorer des données préchargées sans installer Docker, utilisez la démo ClickStack hébergée.

Utilisez un générateur pour tester l’ingestion sans application ni jeu de données existants :

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

Consultez les recommandations relatives au déploiement et à la production avant d'utiliser ClickStack pour des workloads durables :