otelgen으로 합성 OpenTelemetry 데이터 생성

otelgen을 사용해 합성 로그, 트레이스, 메트릭을 ClickStack OpenTelemetry collector로 전송합니다

otelgen은 합성 OTLP 로그, 트레이스, 메트릭을 생성하는 간단한 Go CLI입니다. 이를 사용해 기존 ClickStack OpenTelemetry collector가 데이터를 수신하는지, 그리고 이벤트가 ClickStack UI에 표시되는지 확인할 수 있습니다.

이 가이드에서는 collector가 이미 실행 중이며 4317(gRPC) 및 4318(HTTP)에서 OTLP 엔드포인트를 제공한다고 가정합니다.

Managed ClickStack

1. ​

   사전 요구 사항

   이 가이드는 Managed ClickStack 시작하기 가이드를 완료했으며, otelgen을 실행하는 머신에서 OTLP gRPC (4317) 및 HTTP (4318) 엔드포인트에 연결할 수 있는 OpenTelemetry collector가 실행 중이라고 가정합니다. collector 보안 설정을 통해 OTLP_AUTH_TOKEN을 설정했다면, 해당 값을 미리 준비해 두십시오.

2. ​

   otelgen 설치

   Homebrew로 설치합니다:

   brew install krzko/tap/otelgen
   

   또는 Go로 설치합니다:

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

   환경 변수 설정

   collector 엔드포인트와, collector에 보안이 설정되어 있다면 인증 토큰을 export합니다:

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

   collector의 호스트와 포트를 사용하십시오. 같은 머신에서 collector를 실행 중이라면 localhost:4317입니다.

   보안이 설정되지 않은 collector

   ClickStack OpenTelemetry collector는 기본적으로 인증이 설정되어 있지 않습니다. OTLP_AUTH_TOKEN을 설정하기 위해 collector 보안 설정을 수행하지 않았다면, 여기서는 OTLP_AUTH_TOKEN을 생략하고 아래 명령에서 --header 플래그를 제거하십시오.

4. ​

   traces 생성

   여러 스팬으로 구성된 traces를 짧게 전송합니다:

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

   --rate는 초당 trace 수이고 --duration은 초 단위 실행 시간입니다. --insecure는 gRPC connection에서 TLS를 비활성화하며, otelgen을 collector의 plaintext OTLP 포트에 연결할 때 필요합니다.

5. ​

   logs 생성

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

   메트릭 생성

   metrics 하위 명령은 --duration을 지원하지 않습니다. 명령을 실행한 뒤 몇 초 후 Ctrl+C를 눌러 중지하십시오.

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

   otelgen은 metrics 아래에서 gauge, histogram, up-down-counter, exponential-histogram 하위 명령도 지원합니다.

7. ​

   ClickStack에서 확인

   ClickHouse Cloud 콘솔에서 ClickStack UI를 여십시오. Search 화면에서 source를 Logs와 Traces 사이에서 전환해 새 이벤트를 확인합니다. 시간 범위는 Last 15 minutes로 설정하십시오. Chart Explorer를 열고 Metrics를 선택한 다음, otelgen이 생성한 메트릭 이름 중 하나(예: otelgen.metrics.sum)를 차트로 표시해 메트릭 수집을 확인합니다.

ClickStack 오픈소스

1. ​

   사전 요구 사항

   이 가이드는 all-in-one image용 안내에 따라 Open Source ClickStack을 시작했으며, OTLP 엔드포인트(4317 gRPC 및 4318 HTTP)에 접근할 수 있다고 가정합니다. 또한 HyperDX UI의 Team Settings > API Keys에서 수집 API key가 필요합니다.

2. ​

   otelgen 설치

   Homebrew로 설치합니다:

   brew install krzko/tap/otelgen
   

   또는 Go로 설치합니다:

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

   환경 변수 설정

   collector 엔드포인트와 수집 API key를 export합니다:

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

   traces 생성

   여러 스팬으로 이루어진 traces를 짧게 전송합니다:

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

   --rate는 초당 trace 수이고 --duration은 초 단위 실행 시간입니다. --insecure는 로컬 collector에 대해 plaintext gRPC를 사용하도록 설정합니다.

5. ​

   logs 생성

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

   메트릭 생성

   metrics 하위 명령은 --duration을 지원하지 않습니다. 명령을 실행한 뒤 몇 초 후 Ctrl+C를 눌러 중지하십시오.

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

   otelgen은 metrics 아래에서 gauge, histogram, up-down-counter, exponential-histogram 하위 명령도 지원합니다.

7. ​

   ClickStack에서 확인

   http://localhost:8080에 접속해 ClickStack UI를 엽니다. Search 보기에서 Logs와 Traces 사이로 source를 전환해 새 이벤트를 확인합니다. 시간 범위를 Last 15 minutes로 설정합니다. Chart Explorer를 열고 Metrics를 선택한 다음, otelgen이 생성한 메트릭 이름 중 하나(예: otelgen.metrics.sum)를 차트로 표시해 메트릭 수집을 확인합니다.