إعدادات التوزيعات مفتوحة المصدر
Docker
Docker Compose
.env لتعديل الإعدادات.
بدلًا من ذلك، يمكنك استبدال الإعدادات صراحةً في ملف docker-compose.yaml، على سبيل المثال.
مثال:
Helm
تخصيص القيم (اختياري)
--set، على سبيل المثال:
values.yaml. لاسترجاع القيم الافتراضية:
تطبيق ClickStack UI (HyperDX)
إعدادات مصدر البيانات
LogsTracesMetricsSessions
Team Settings -> Sources، كما هو موضح أدناه للسجلات:
يتطلب كل مصدر من هذه المصادر تحديد جدول واحد على الأقل عند الإنشاء، بالإضافة إلى مجموعة من الأعمدة التي تتيح لـ HyperDX الاستعلام عن البيانات.
إذا كنت تستخدم مخطط OpenTelemetry (OTel) الافتراضي المرفق مع ClickStack، فيمكن استنتاج هذه الأعمدة تلقائيًا لكل مصدر. أما عند تعديل المخطط أو استخدام مخطط مخصص، فيجب على المستخدمين تحديد هذه التعيينات وتحديثها.
المخطط الافتراضي لـ ClickHouse المرفق مع ClickStack هو المخطط الذي ينشئه ClickHouse exporter for the OTel collector. وتتوافق أسماء هذه الأعمدة مع مواصفة OTel الرسمية الموثقة هنا.
السجلات
التتبعات
المقاييس
الجلسات
السمات المميزة
- السمات المميزة هي أعمدة أو تعبيرات تُعرض لكل سجل أو
spanعند عرض تفاصيل السجل أوspan. - سمات التتبّع المميزة هي أعمدة أو تعبيرات يتم الاستعلام عنها من كل سجل أو
spanضمن تتبّع، وتُعرض فوق trace waterfall.
span:
يؤدي النقر على سمة إلى إتاحة خيارات لاستخدامها كقيمة بحث. وإذا تم توفير تعبير Lucene اختياري في تهيئة السمة، فسيُستخدم تعبير Lucene للبحث بدلًا من تعبير SQL.
لتمكين الترابط الكامل بين المصادر في ClickStack، يجب عليك تكوين مصادر مترابطة للسجلات والتتبعات والمقاييس والجلسات. يتيح ذلك لـ HyperDX ربط البيانات ذات الصلة وتوفير سياق غني عند عرض الأحداث.
Logs: يمكن ربطها بالتتبعات والمقاييس.Traces: يمكن ربطها بالسجلات والجلسات والمقاييس.Metrics: يمكن ربطها بالسجلات.Sessions: يمكن ربطها بالتتبعات.
إعدادات تكوين التطبيق
HyperDX في ClickHouse Cloudلا يمكن تعديل هذه الإعدادات عند إدارة HyperDX في ClickHouse Cloud.
-
HYPERDX_API_KEY- القيمة الافتراضية: None (مطلوب)
- الوصف: مفتاح المصادقة لواجهة برمجة تطبيقات HyperDX.
- إرشادات:
- مطلوب للقياس عن بُعد وتسجيل السجلات
- في بيئة التطوير المحلية، يمكن أن تكون أي قيمة غير فارغة
- في بيئة الإنتاج، استخدم مفتاحًا آمنًا وفريدًا
- يمكن الحصول عليه من صفحة إعدادات الفريق بعد إنشاء الحساب
-
HYPERDX_LOG_LEVEL- الافتراضي:
info - الوصف: يحدّد مستوى تفصيل التسجيل.
- الخيارات:
debug,info,warn,error - الإرشادات:
- استخدم
debugلاستكشاف الأخطاء وإصلاحها بالتفصيل - استخدم
infoللتشغيل العادي - استخدم
warnأوerrorفي بيئة الإنتاج لتقليل حجم السجلات
- الافتراضي:
-
HYPERDX_API_PORT- القيمة الافتراضية:
8000 - الوصف: المنفذ الخاص بخادم واجهة برمجة تطبيقات HyperDX.
- إرشادات:
- تأكد من أن هذا المنفذ متاح على المضيف لديك
- غيّره إذا كان لديك تعارض في المنافذ
- يجب أن يتطابق مع المنفذ المحدد في إعدادات عميل واجهة برمجة التطبيقات لديك
- القيمة الافتراضية:
-
HYPERDX_APP_PORT- القيمة الافتراضية:
8000 - الوصف: المنفذ الخاص بتطبيق HyperDX للواجهة الأمامية.
- إرشادات:
- تأكد من أن هذا المنفذ متاح على جهازك المضيف
- غيّره إذا كان هناك تضارب في المنافذ
- يجب أن يكون متاحًا للوصول من متصفحك
- القيمة الافتراضية:
-
HYPERDX_APP_URL- القيمة الافتراضية:
http://localhost - الوصف: عنوان URL الأساسي لتطبيق الواجهة الأمامية.
- الإرشادات:
- اضبطه على نطاقك في بيئة الإنتاج
- ضمّن البروتوكول (http/https)
- لا تُضمّن الشرطة المائلة اللاحقة
- القيمة الافتراضية:
-
MONGO_URI- القيمة الافتراضية:
mongodb://db:27017/hyperdx - الوصف: سلسلة connection خاصة بـ MongoDB.
- الإرشادات:
- استخدم القيمة الافتراضية للتطوير المحلي باستخدام Docker
- في بيئة production، استخدم سلسلة connection آمنة
- أدرِج authentication إذا كان مطلوبًا
- مثال:
mongodb://user:pass@host:port/db
- القيمة الافتراضية:
-
MINER_API_URL- الافتراضي:
http://miner:5123 - الوصف: عنوان URL لخدمة استخراج أنماط السجل.
- إرشادات:
- استخدم القيمة الافتراضية للتطوير المحلي باستخدام Docker.
- اضبطه على عنوان URL لخدمة
minerفي بيئة الإنتاج. - يجب أن تكون خدمة واجهة برمجة التطبيقات قادرة على الوصول إليه.
- الافتراضي:
-
FRONTEND_URL- الافتراضي:
http://localhost:3000 - الوصف: عنوان URL لتطبيق الواجهة الأمامية.
- الإرشادات:
- استخدم القيمة الافتراضية في بيئة التطوير المحلي
- اضبطه على نطاقك في بيئة الإنتاج
- يجب أن يكون قابلاً للوصول من خدمة واجهة برمجة التطبيقات
- الافتراضي:
-
OTEL_SERVICE_NAME- الافتراضي:
hdx-oss-api - الوصف: اسم الخدمة المستخدم لأغراض الرصد في OpenTelemetry.
- إرشادات:
- استخدم اسمًا وصفيًا لخدمة HyperDX الخاصة بك. ينطبق ذلك إذا كانت HyperDX تُجري الرصد الذاتي.
- يساعد في تمييز خدمة HyperDX ضمن بيانات الرصد
- الافتراضي:
-
NEXT_PUBLIC_OTEL_EXPORTER_OTLP_ENDPOINT- الافتراضي:
http://localhost:4318 - الوصف: نقطة نهاية جامع OpenTelemetry.
- الإرشادات:
- ذو صلة بالإعداد الذاتي لـ HyperDX.
- استخدم القيمة الافتراضية للتطوير المحلي
- اضبطه على عنوان URL الخاص بجامعك في بيئة production
- يجب أن يكون قابلاً للوصول من خدمة HyperDX الخاصة بك
- الافتراضي:
-
USAGE_STATS_ENABLED- الافتراضي:
true - الوصف: يفعّل أو يعطّل جمع إحصاءات الاستخدام.
- إرشادات:
- اضبطه على
falseلتعطيل تتبّع الاستخدام - مفيد لعمليات النشر التي تتطلّب مراعاة الخصوصية
- القيمة الافتراضية هي
trueللمساعدة في تحسين المنتج
- الافتراضي:
-
IS_OSS- الافتراضي:
true - الوصف: يحدد ما إذا كان التشغيل في وضع OSS.
- إرشادات:
- اتركه على
trueلعمليات النشر مفتوحة المصدر - اضبطه على
falseلعمليات النشر المؤسسية - يؤثر في توفر الميزات
- الافتراضي:
-
IS_LOCAL_MODE- الافتراضي:
false - الوصف: يحدد ما إذا كان التشغيل في الوضع المحلي.
- الإرشادات:
- اضبطه على
trueللتطوير المحلي - يعطّل بعض ميزات بيئة الإنتاج
- مفيد للاختبار والتطوير
- الافتراضي:
-
EXPRESS_SESSION_SECRET- الافتراضي:
hyperdx is cool 👋 - الوصف: سرّ لإدارة جلسات Express.
- إرشادات:
- غيّره في بيئة production
- استخدم سلسلة قوية وعشوائية
- حافظ على سريته وأمانه
- الافتراضي:
-
ENABLE_SWAGGER- القيمة الافتراضية:
false - الوصف: يفعّل أو يعطّل وثائق Swagger لواجهة برمجة التطبيقات.
- الإرشادات:
- اضبطه على
trueلتمكين وثائق واجهة برمجة التطبيقات - مفيد للتطوير والاختبار
- عطّله في بيئة الإنتاج
- القيمة الافتراضية:
-
BETA_CH_OTEL_JSON_SCHEMA_ENABLED- الافتراضي:
false - الوصف: يفعّل الدعم التجريبي لنوع JSON في HyperDX. راجع أيضًا
OTEL_AGENT_FEATURE_GATE_ARGلتمكين دعم JSON في OTel collector. - إرشادات:
- يفعّل ميزة تجريبية. لا يُنصح بمخططات JSON-typed schemas لأعباء عمل observability المعتادة. راجع Map vs JSON type للاطّلاع على المقارنة ومعرفة الحالات المناسبة لكلٍّ منهما.
- اضبط القيمة على
trueلتمكين دعم JSON في ClickStack UI.
- الافتراضي:
مجمّع OpenTelemetry
-
CLICKHOUSE_ENDPOINT- الافتراضي: None (مطلوب) إذا كانت الصورة مستقلة. أما إذا كانت التوزيعة All-in-one أو Docker Compose، فستُضبط هذه القيمة على ClickHouse instance المدمجة.
- الوصف: عنوان URL عبر HTTPS لـ ClickHouse instance التي ستُصدَّر إليها بيانات telemetry.
- إرشادات:
- يجب أن يكون endpoint كاملاً عبر HTTPS ويتضمن المنفذ (على سبيل المثال:
https://clickhouse.example.com:8443) - هذا الإعداد مطلوب لكي يتمكن المجمّع من إرسال البيانات إلى ClickHouse
- يجب أن يكون endpoint كاملاً عبر HTTPS ويتضمن المنفذ (على سبيل المثال:
-
CLICKHOUSE_USER- الافتراضي:
default - الوصف: اسم المستخدم المستخدم للمصادقة مع ClickHouse instance.
- إرشادات:
- تأكد من أن المستخدم لديه أذونات
INSERTوCREATE TABLE - يُنصح بإنشاء مستخدم مخصص لعملية الاستيعاب
- تأكد من أن المستخدم لديه أذونات
- الافتراضي:
-
CLICKHOUSE_PASSWORD- الافتراضي: None (مطلوب إذا كانت authentication مفعّلة)
- الوصف: كلمة المرور لمستخدم ClickHouse المحدد.
- إرشادات:
- تكون مطلوبة إذا كانت user account تحتوي على كلمة مرور معيّنة
- خزّنها بأمان باستخدام secrets في بيئات production
-
HYPERDX_LOG_LEVEL- الافتراضي:
info - الوصف: مستوى تفصيل السجل للمجمّع.
- إرشادات:
- يقبل قيماً مثل
debugوinfoوwarnوerror - استخدم
debugأثناء استكشاف الأخطاء وإصلاحها
- يقبل قيماً مثل
- الافتراضي:
-
OPAMP_SERVER_URL- الافتراضي: None (مطلوب) إذا كانت الصورة مستقلة. أما إذا كانت التوزيعة All-in-one أو Docker Compose، فتشير هذه القيمة إلى HyperDX instance المنشورة.
- الوصف: عنوان URL لخادم OpAMP المستخدم لإدارة المجمّع (مثل HyperDX instance). يكون هذا على المنفذ
4320افتراضياً. - إرشادات:
- يجب أن يشير إلى HyperDX instance الخاصة بك
- يفعّل configuration ديناميكية واستيعاباً آمناً
- إذا لم يتم تحديده، فسيُعطَّل الاستيعاب الآمن ما لم تُحدَّد قيمة
OTLP_AUTH_TOKEN.
-
OTLP_AUTH_TOKEN- الافتراضي: None. يُستخدم فقط مع الصورة المستقلة.
- الوصف: يتيح تحديد token للمصادقة الخاصة بـ OTLP. إذا تم ضبطه، فستتطلب جميع الاتصالات Bearer token هذا.
- إرشادات:
- يُنصح به عند استخدام صورة المجمّع المستقلة في بيئات production.
-
HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE- الافتراضي:
default - الوصف: قاعدة بيانات ClickHouse التي يكتب فيها المجمّع بيانات telemetry.
- إرشادات:
- اضبطه إذا كنت تستخدم اسم database مخصصاً
- تأكد من أن المستخدم المحدد لديه صلاحية الوصول إلى هذه database
- الافتراضي:
-
OTEL_AGENT_FEATURE_GATE_ARG- الافتراضي:
<empty string> - الوصف: يفعّل feature flags في المجمّع. إذا ضُبط على
--feature-gates=clickhouse.json، فسيتم تفعيل beta support لنوع JSON type في المجمّع، مما يضمن إنشاء schemas بهذا النوع. راجع أيضاًBETA_CH_OTEL_JSON_SCHEMA_ENABLEDلتمكين دعم JSON في HyperDX. - إرشادات:
- يفعّل ميزة تجريبية. إن JSON-typed schemas غير موصى بها لأعباء observability المعتادة. راجع Map vs JSON type للمقارنة ومتى يكون كل منهما مناسباً.
- اضبطه على
--feature-gates=clickhouse.jsonلإنشاء جداول جديدة باستخدام JSON type.
- الافتراضي: