Generar datos sintéticos de OpenTelemetry con otelgen

otelgen es una pequeña CLI escrita en Go que genera logs, trazas y métricas sintéticos mediante OTLP. Úsala para confirmar que un collector de OpenTelemetry de ClickStack existente está aceptando datos y que los eventos aparecen en la UI de ClickStack.

Esta guía asume que el collector ya está en ejecución con endpoints OTLP en 4317 (gRPC) y 4318 (HTTP).

Requisitos previos

Esta guía parte de que ya completaste la guía de primeros pasos para Managed ClickStack y de que tienes un collector de OpenTelemetry en ejecución, con los endpoints OTLP gRPC (4317) y HTTP (4318) accesibles desde la máquina donde ejecutas otelgen. Si protegiste el collector con un OTLP_AUTH_TOKEN, ten ese valor a mano.

Instalar otelgen

Instálalo con Homebrew:

brew install krzko/tap/otelgen

O instálalo con Go:

go install github.com/krzko/otelgen@latest

Establecer variables de entorno

Exporta el endpoint del collector y, si está protegido, el token de autenticación:

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

Usa el host y el puerto de tu collector. Si el collector se está ejecutando en la misma máquina, será localhost:4317.

Generar traces

Envía una breve ráfaga de traces con varios spans:

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

--rate es la cantidad de traces por segundo y --duration es la duración de la ejecución, en segundos. --insecure desactiva TLS en la conexión gRPC, lo cual es necesario cuando otelgen apunta al puerto OTLP en texto plano del collector.

Generar logs

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

Generar métricas

Los subcomandos de métricas no respetan --duration. Ejecuta el comando y pulsa Ctrl+C al cabo de unos segundos para detenerlo.

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

otelgen también admite los subcomandos gauge, histogram, up-down-counter y exponential-histogram dentro de metrics.

Verificar en ClickStack

Abre la UI de ClickStack desde la consola de ClickHouse Cloud. En la vista Búsqueda, cambia la source entre Logs y Traces para confirmar que aparecen eventos nuevos. Establece el intervalo de tiempo en Last 15 minutes. Abre Chart Explorer, selecciona Metrics y crea un gráfico con uno de los nombres de métricas generados por otelgen (por ejemplo, otelgen.metrics.sum) para verificar la ingestión de métricas.

Requisitos previos

Esta guía asume que has iniciado Open Source ClickStack siguiendo las instrucciones para la imagen todo en uno y que se puede acceder a los endpoints de OTLP (4317 gRPC y 4318 HTTP). También necesitas la API key de ingesta desde la UI de HyperDX, en configuración del equipo > API Keys.

Instalar otelgen

Instálalo con Homebrew:

brew install krzko/tap/otelgen

O instálalo con Go:

go install github.com/krzko/otelgen@latest

Establecer variables de entorno

Exporta el endpoint del collector y la API key de ingesta:

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

Generar trazas

Envía una breve ráfaga de trazas con varios spans:

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

--rate indica las trazas por segundo y --duration la duración de la ejecución en segundos. --insecure habilita gRPC en texto sin cifrar contra el collector local.