Generar datos sintéticos de OpenTelemetry con otelgen

Usa otelgen para enviar logs, trazas y métricas sintéticos a un collector de OpenTelemetry de ClickStack

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).

Managed ClickStack

1. ​

   Prerrequisitos

   Esta guía asume que has completado la guía de primeros pasos de Managed ClickStack y que tienes un colector de OpenTelemetry en ejecución con los endpoints OTLP gRPC (4317) y HTTP (4318) accesibles desde la máquina en la que ejecutas otelgen. Si aseguraste el colector con un OTLP_AUTH_TOKEN, ten ese valor a mano.

2. ​

   Instalar otelgen

   Instálalo con Homebrew:

   brew install krzko/tap/otelgen
   

   O instálalo con Go:

   go install github.com/krzko/otelgen@latest
   
3. ​

   Establecer variables de entorno

   Exporta el endpoint del colector y, si el colector 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 colector. Si el colector se ejecuta en la misma máquina, será localhost:4317.

   Colector sin protección

   El ClickStack OpenTelemetry collector no requiere autenticación de forma predeterminada. Si no has seguido Asegurar el colector para establecer un OTLP_AUTH_TOKEN, omite OTLP_AUTH_TOKEN aquí y elimina la opción --header de los comandos siguientes.

4. ​

   Generar trazas

   Envía una ráfaga corta de trazas 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 indica el número de trazas por segundo y --duration la duración de la ejecución en segundos. --insecure desactiva TLS en la conexión gRPC, lo cual es necesario cuando apuntas otelgen al puerto OTLP en plaintext del colector.

5. ​

   Generar logs

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

   Generar métricas

   Los subcomandos de métricas no respetan --duration. Ejecuta el comando y presiona 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.

7. ​

   Verificar en ClickStack

   Abre la UI de ClickStack desde la consola de ClickHouse Cloud. En la vista Búsqueda, cambia la fuente 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.

ClickStack Open Source

1. ​

   Requisitos previos

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

2. ​

   Instalar otelgen

   Instálelo con Homebrew:

   brew install krzko/tap/otelgen
   

   O instálelo con Go:

   go install github.com/krzko/otelgen@latest
   
3. ​

   Establecer variables de entorno

   Exporte el endpoint del colector y la API key de ingesta:

   export OTEL_ENDPOINT=localhost:4317
   export CLICKSTACK_API_KEY=<your_ingestion_api_key>
   
4. ​

   Generar traces

   Envíe una breve ráfaga de traces con múltiples spans:

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

   --rate indica los traces por segundo y --duration, la duración de la ejecución en segundos. --insecure habilita gRPC en plaintext contra el colector local.

5. ​

   Generar logs

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

   Generar metrics

   Los subcomandos de metrics no respetan --duration. Ejecute el comando y presione Ctrl+C después de unos segundos para detenerlo.

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

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

7. ​

   Verificar en ClickStack

   Visite http://localhost:8080 para abrir la UI de ClickStack. En la vista Búsqueda, cambie la fuente entre Logs y Traces para confirmar que aparecen eventos nuevos. Establezca el intervalo de tiempo en Last 15 minutes. Abra Chart Explorer, seleccione Metrics y cree un chart con uno de los nombres de metric generados por otelgen (por ejemplo, otelgen.metrics.sum) para verificar la ingestión de métricas.