إنشاء بيانات OpenTelemetry اصطناعية باستخدام otelgen

استخدم otelgen لإرسال سجلات وتتبعّات ومقاييس اصطناعية إلى ClickStack OpenTelemetry collector

otelgen هي أداة CLI صغيرة مكتوبة بلغة Go تُنشئ سجلات وتتبعّات ومقاييس اصطناعية بتنسيق OTLP. استخدمها للتأكد من أن ClickStack OpenTelemetry collector الحالي يستقبل البيانات وأن الأحداث تظهر في ClickStack UI.

يفترض هذا الدليل أن الـ collector يعمل بالفعل مع OTLP endpoints على 4317 ‏(gRPC) و4318 ‏(HTTP).

ClickStack المُدار

1. ​

   المتطلبات الأساسية

   يفترض هذا الدليل أنك أكملت دليل البدء الخاص بـ Managed ClickStack، وأن لديك OpenTelemetry Collector قيد التشغيل مع نقاط نهاية OTLP gRPC (4317) وHTTP (4318) بحيث يمكن الوصول إليهما من الجهاز الذي تشغّل عليه otelgen. وإذا كنت قد أمّنت الـ collector باستخدام OTLP_AUTH_TOKEN، فاحتفظ بهذه القيمة في متناولك.

2. ​

   تثبيت otelgen

   ثبّته باستخدام Homebrew:

   brew install krzko/tap/otelgen
   

   أو ثبّته باستخدام Go:

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

   تعيين متغيرات البيئة

   صدّر نقطة نهاية الـ collector، ورمز المصادقة إذا كان الـ collector مؤمّنًا:

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

   استخدم المضيف والمنفذ الخاصين بالـ collector. وإذا كان الـ collector يعمل على الجهاز نفسه، فستكون القيمة localhost:4317.

   collector غير مؤمّن

   يكون ClickStack OpenTelemetry collector بدون مصادقة افتراضيًا. إذا لم تتبع تأمين الـ collector لتعيين OTLP_AUTH_TOKEN، فتجاوز OTLP_AUTH_TOKEN هنا واحذف الخيار --header من الأوامر أدناه.

4. ​

   إنشاء traces

   أرسل دفعة قصيرة من traces متعددة الـ span:

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

   يشير --rate إلى عدد الـ traces في الثانية، وتشير --duration إلى مدة التشغيل بالثواني. ويعطّل --insecure استخدام TLS لاتصال gRPC، وهو مطلوب عند توجيه otelgen إلى منفذ OTLP غير المشفّر الخاص بالـ collector.

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

   لا تراعي الأوامر الفرعية الخاصة بـ metrics الخيار --duration. شغّل الأمر ثم اضغط Ctrl+C بعد بضع ثوانٍ لإيقافه.

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

   يدعم otelgen أيضًا الأوامر الفرعية gauge وhistogram وup-down-counter وexponential-histogram ضمن metrics.

7. ​

   التحقق في ClickStack

   افتح ClickStack UI من ClickHouse Cloud console. في عرض Search، بدّل المصدر بين Logs وTraces للتأكد من ظهور أحداث جديدة. اضبط النطاق الزمني على Last 15 minutes. ثم افتح Chart Explorer، وحدد Metrics، وأنشئ مخططًا لأحد أسماء المقاييس التي ينتجها otelgen (مثل otelgen.metrics.sum) للتحقق من استيعاب المقاييس.

ClickStack مفتوح المصدر

1. ​

   المتطلبات الأساسية

   يفترض هذا الدليل أنك بدأت تشغيل Open Source ClickStack باستخدام إرشادات الصورة الشاملة، وأن نقاط نهاية OTLP (4317 لـ gRPC و4318 لـ HTTP) متاحة للوصول. كما تحتاج إلى مفتاح API للإدخال من واجهة HyperDX ضمن Team Settings > API Keys.

2. ​

   تثبيت otelgen

   ثبّت باستخدام Homebrew:

   brew install krzko/tap/otelgen
   

   أو ثبّته باستخدام Go:

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

   تعيين متغيرات البيئة

   صدّر نقطة نهاية المجمّع ومفتاح API للإدخال:

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

   إنشاء التتبعات

   أرسل دفعة قصيرة من التتبعات متعددة الـspan:

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

   يشير --rate إلى عدد التتبعات في الثانية، ويشير --duration إلى مدة التشغيل بالثواني. ويؤدي --insecure إلى تفعيل اتصال gRPC غير مشفّر مع المجمّع المحلي.

5. ​

   إنشاء السجلات

   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 أيضًا الأوامر الفرعية gauge وhistogram وup-down-counter وexponential-histogram ضمن metrics.

7. ​

   التحقق في ClickStack

   زُر http://localhost:8080 لفتح واجهة ClickStack. في عرض Search، بدّل المصدر بين Logs وTraces للتأكد من ظهور أحداث جديدة. اضبط النطاق الزمني على Last 15 minutes. ثم افتح Chart Explorer، وحدد Metrics، وأنشئ مخططًا لأحد أسماء المقاييس التي ينتجها otelgen (على سبيل المثال otelgen.metrics.sum) للتحقق من إدخال المقاييس.