Générer des données OpenTelemetry synthétiques avec otelgen

otelgen est un petit outil CLI en Go qui génère des logs, traces et métriques OTLP synthétiques. Utilisez-le pour vérifier qu’un ClickStack OpenTelemetry collector existant accepte bien les données et que les événements s’affichent dans la ClickStack UI. Ce guide suppose que le collector est déjà en fonctionnement avec des endpoints OTLP sur 4317 (gRPC) et 4318 (HTTP).

ClickStack managé
ClickStack Open Source

Prérequis

Ce guide part du principe que vous avez terminé le guide Getting Started pour Managed ClickStack et qu’un collector OpenTelemetry est en cours d’exécution, avec des endpoints OTLP gRPC (4317) et HTTP (4318) accessibles depuis la machine sur laquelle vous exécutez otelgen. Si vous avez sécurisé le collector avec un OTLP_AUTH_TOKEN, gardez cette valeur à portée de main.

Installer otelgen

Installez-le avec Homebrew :

brew install krzko/tap/otelgen

Ou installez-le avec Go :

go install github.com/krzko/otelgen@latest

Définir les variables d’environnement

Exportez l’endpoint du collector et, si le collector est sécurisé, le jeton d’authentification :

export OTEL_ENDPOINT=<host>:4317
export OTLP_AUTH_TOKEN=<your_otlp_auth_token>

Utilisez l’hôte et le port de votre collector. Si le collector s’exécute sur la même machine, utilisez localhost:4317.

Collector non sécuriséLe ClickStack OpenTelemetry collector n’est pas authentifié par défaut. Si vous n’avez pas suivi Securing the collector pour définir un OTLP_AUTH_TOKEN, ignorez OTLP_AUTH_TOKEN ici et supprimez le flag --header des commandes ci-dessous.

Générer des traces

Envoyez une courte rafale de traces comportant plusieurs spans :

otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \
  --header "authorization=${OTLP_AUTH_TOKEN}" \
  --protocol grpc --insecure \
  --rate 2 --duration 10 \
  traces multi

--rate correspond au nombre de traces par seconde et --duration à la durée d’exécution en secondes. --insecure désactive TLS sur la connexion gRPC, ce qui est nécessaire lorsque otelgen pointe vers le port OTLP en clair du collector.

Générer des logs

otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \
  --header "authorization=${OTLP_AUTH_TOKEN}" \
  --protocol grpc --insecure \
  --rate 2 --duration 10 \
  logs multi

Générer des métriques

Les sous-commandes de métriques ne prennent pas en charge --duration. Exécutez la commande, puis appuyez sur Ctrl+C après quelques secondes pour l’arrêter.

otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \
  --header "authorization=${OTLP_AUTH_TOKEN}" \
  --protocol grpc --insecure \
  --rate 2 \
  metrics sum

otelgen prend également en charge les sous-commandes gauge, histogram, up-down-counter et exponential-histogram sous metrics.

Vérifier dans ClickStack

Ouvrez la ClickStack UI depuis la console ClickHouse Cloud. Dans la vue Search, basculez entre les sources Logs et Traces pour vérifier l’arrivée de nouveaux événements. Réglez l’intervalle de temps sur Last 15 minutes. Ouvrez le Chart Explorer, sélectionnez Metrics, puis créez un graphique à partir de l’un des noms de métrique produits par otelgen (par exemple otelgen.metrics.sum) pour vérifier l’ingestion des métriques.

Prérequis

Ce guide suppose que vous avez démarré Open Source ClickStack en suivant les instructions pour l’image tout-en-un, et que les endpoints OTLP (4317 gRPC et 4318 HTTP) sont accessibles. Vous avez également besoin de la clé API d’ingestion disponible dans l’HyperDX UI, sous Team Settings > API Keys.

Installer otelgen

Installez-le avec Homebrew :

brew install krzko/tap/otelgen

Ou installez-le avec Go :

go install github.com/krzko/otelgen@latest

Définir les variables d'environnement

Exportez l’endpoint du collector et la clé API d’ingestion :

export OTEL_ENDPOINT=localhost:4317
export CLICKSTACK_API_KEY=<your_ingestion_api_key>

Générer des traces

Envoyez une courte rafale de traces comportant plusieurs spans :

otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \
  --header "authorization=${CLICKSTACK_API_KEY}" \
  --protocol grpc --insecure \
  --rate 2 --duration 10 \
  traces multi

--rate correspond au nombre de traces par seconde et --duration à la durée d’exécution en secondes. --insecure active gRPC en clair vers le collector local.

Générer des logs

otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \
  --header "authorization=${CLICKSTACK_API_KEY}" \
  --protocol grpc --insecure \
  --rate 2 --duration 10 \
  logs multi

Générer des métriques

Les sous-commandes de métriques ne respectent pas --duration. Exécutez la commande, puis appuyez sur Ctrl+C au bout de quelques secondes pour l’arrêter.

otelgen --otel-exporter-otlp-endpoint ${OTEL_ENDPOINT} \
  --header "authorization=${CLICKSTACK_API_KEY}" \
  --protocol grpc --insecure \
  --rate 2 \
  metrics sum

otelgen prend également en charge les sous-commandes gauge, histogram, up-down-counter et exponential-histogram sous metrics.

Vérifier dans ClickStack

Rendez-vous sur http://localhost:8080 pour ouvrir la ClickStack UI. Dans la vue Search, basculez la source entre Logs et Traces pour confirmer l’arrivée de nouveaux événements. Réglez l’intervalle de temps sur Last 15 minutes. Ouvrez Chart Explorer, sélectionnez Metrics, puis créez un chart à partir de l’un des noms de métriques produits par otelgen (par exemple otelgen.metrics.sum) afin de vérifier l’ingestion des métriques.

Fonctionnalités

Guides

Générer des données OpenTelemetry synthétiques avec otelgen