Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

خيارات الإعداد

View as MarkdownEdit this pageReport an issueSet up docs MCP

خيارات الإعداد التالية متاحة لكل مكوّن من مكوّنات ClickStack:

إعدادات التوزيعات مفتوحة المصدر

Docker

إذا كنت تستخدم الكل في واحد أو HyperDX فقط أو الوضع المحلي، فيكفي تمرير الإعداد المطلوب عبر متغير بيئة، مثلًا.

docker run  -e HYPERDX_LOG_LEVEL='debug' -p 8080:8080 -p 4317:4317 -p 4318:4318 clickhouse/clickstack-all-in-one:latest

Docker Compose

إذا كنت تستخدم دليل النشر الخاص بـ Docker Compose، فيمكن استخدام ملف .env لتعديل الإعدادات.

بدلًا من ذلك، يمكنك استبدال الإعدادات صراحةً في ملف docker-compose.yaml، على سبيل المثال.

مثال:

services:
  app:
    environment:
      HYPERDX_API_KEY: ${HYPERDX_API_KEY}
      HYPERDX_LOG_LEVEL: ${HYPERDX_LOG_LEVEL}
      # ... other settings

Helm

تخصيص القيم (اختياري)

يمكنك تخصيص الإعدادات باستخدام وسيطات --set، على سبيل المثال:

helm install my-hyperdx hyperdx/hdx-oss-v2 \
  --set replicaCount=2 \
  --set resources.limits.cpu=500m \
  --set resources.limits.memory=512Mi \
  --set resources.requests.cpu=250m \
  --set resources.requests.memory=256Mi \
  --set ingress.enabled=true \
  --set ingress.annotations."kubernetes\.io/ingress\.class"=nginx \
  --set ingress.hosts[0].host=hyperdx.example.com \
  --set ingress.hosts[0].paths[0].path=/ \
  --set ingress.hosts[0].paths[0].pathType=ImplementationSpecific \
  --set env[0].name=CLICKHOUSE_USER \
  --set env[0].value=abc

بدلًا من ذلك، عدّل ملف values.yaml. لاسترجاع القيم الافتراضية:

helm show values hyperdx/hdx-oss-v2 > values.yaml

مثال على التهيئة:

replicaCount: 2
resources:
  limits:
    cpu: 500m
    memory: 512Mi
  requests:
    cpu: 250m
    memory: 256Mi
ingress:
  enabled: true
  annotations:
    kubernetes.io/ingress.class: nginx
  hosts:
    - host: hyperdx.example.com
      paths:
        - path: /
          pathType: ImplementationSpecific
  env:
    - name: CLICKHOUSE_USER
      value: abc

تطبيق ClickStack UI (HyperDX)

إعدادات مصدر البيانات

تعتمد واجهة ClickStack UI على أن يحدد المستخدم مصدرًا لكل نوع/ركيزة من أنواع بيانات Observability:

  • Logs
  • Traces
  • Metrics
  • Sessions

يمكن إجراء هذا الإعداد من داخل التطبيق عبر Team Settings -> Sources، كما هو موضح أدناه للسجلات:

إعداد مصدر HyperDX

يتطلب كل مصدر من هذه المصادر تحديد جدول واحد على الأقل عند الإنشاء، بالإضافة إلى مجموعة من الأعمدة التي تتيح لـ HyperDX الاستعلام عن البيانات.

إذا كنت تستخدم مخطط OpenTelemetry (OTel) الافتراضي المرفق مع ClickStack، فيمكن استنتاج هذه الأعمدة تلقائيًا لكل مصدر. أما عند تعديل المخطط أو استخدام مخطط مخصص، فيجب على المستخدمين تحديد هذه التعيينات وتحديثها.

الإعدادات التالية متاحة لكل مصدر:

السجلات

الإعداد الوصف مطلوب مُستنتَج في المخطط الافتراضي القيمة المُستنتَجة
الاسم اسم المصدر. نعم لا –
القسم تسمية اختيارية لتجميع المصادر في محدد المصادر. تظهر المصادر التي تنتمي إلى القسم نفسه معًا، ويطابق البحث اسم القسم بالإضافة إلى اسم المصدر. لا لا –
اتصال الخادم اسم اتصال الخادم. نعم لا Default
قاعدة البيانات اسم قاعدة بيانات ClickHouse. نعم نعم default
الجدول اسم الجدول الهدف. اضبطه على otel_logs عند استخدام المخطط الافتراضي. نعم لا
إعدادات الاستعلام إعدادات الجلسة على مستوى الاستعلام، يُحدَّد كلٌّ منها باسم الإعداد وقيمته، وتُطبَّق على كل استعلام يُنفَّذ على هذا المصدر. لا No –
مفعّل يظل المصدر المعطّل محفوظًا، لكنه يُخفى من محددات المصادر ولا يُختار تلقائيًا أبدًا. No No مفعّل
عمود التوقيت الزمني عمود أو تعبير من نوع Datetime يشكّل جزءًا من مفتاحك الأساسي. نعم نعم TimestampTime
التحديد الافتراضي الأعمدة المعروضة في نتائج البحث الافتراضية. نعم نعم Timestamp, ServiceName, SeverityText, Body
تعبير اسم الخدمة تعبير أو عمود لاسم الخدمة. نعم نعم ServiceName
تعبير إصدار الخدمة تعبير أو عمود يحدد الإصدار قيد التشغيل لخدمة، ويُستخدم لرسم علامات الإصدار على مخططات لوحات المعلومات. ويُستخدم افتراضيًا السمة service.version للمورد في OpenTelemetry عند تركه فارغًا. لا لا ResourceAttributes['service.version']
تعبير مستوى السجل تعبير أو عمود لمستوى السجل. نعم نعم SeverityText
تعبير متن السجل تعبير أو عمود لرسالة السجل. نعم نعم Body
تعبير سمات السجل تعبير أو عمود لسمات السجل المخصصة. نعم نعم LogAttributes
تعبير سمات المورد تعبير أو عمود للسمات على مستوى المورد. نعم نعم ResourceAttributes
عمود الطابع الزمني المعروض عمود طابع زمني اختياري بدقة أعلى يُستخدم للعرض في واجهة المستخدم. ويُستخدم عمود الطابع الزمني تلقائيًا عند عدم تحديده. No Yes Timestamp
مصدر المقاييس المترابط مصدر مقاييس مرتبط (مثل مقاييس HyperDX). No No –
مصدر التتبعات المرتبط مصدر تتبّع مرتبط (مثل تتبّعات HyperDX). لا No –
تعبير معرّف التتبّع تعبير أو عمود يُستخدم لاستخراج معرّف التتبّع. نعم نعم TraceId
تعبير معرّف المقطع تعبير أو عمود يُستخدم لاستخراج معرّف الامتداد. نعم نعم SpanId
تعبير العمود الضمني العمود المُستخدم للبحث بالنص الكامل عند عدم تحديد حقل (بنمط Lucene). ويكون عادةً متن السجل. نعم نعم النص
قائمة الأعمدة المعروفة للمصادر التي تعتمد على جدول Distributed أو Merge وكانت جداول الهدف فيها تحتوي على مجموعات أعمدة غير متطابقة. قائمة مفصولة بفواصل بالأعمدة المتاحة في جميع جداول الهدف، وتُستخدم بدلاً من SELECT * عند جلب بيانات الصف كاملةً (مثلًا في اللوحة الجانبية للصف). اتركها فارغة لتحديد جميع الأعمدة. أسماء الأعمدة فقط، دون تعبيرات أو أسماء مستعارة. لا لا –
استخدام فهرس نصي ما إذا كانت عمليات البحث المستندة إلى Lucene تُصدر hasAllTokens عند البحث في العمود الضمني. لا لا تلقائي (يُكتشف من المخطط)
السمات البارزة التعبيرات أو الأعمدة التي تُعرض عند فتح تفاصيل السجل. وتُعرض التعبيرات التي تُرجع عناوين URL على شكل روابط. لا لا –
سمات التتبّع البارزة تعبيرات أو أعمدة مستخرجة من كل سجل في تتبّع، تُعرض أعلى مخطط الشلال للتتبّع. وتُعرض التعبيرات التي تُرجع عناوين URL كروابط. لا لا –
العروض المُجسَّدة العروض المادية المجمّعة مسبقًا والمرتبطة بهذا المصدر، وتُستخدم تلقائيًا لتسريع الاستعلامات المؤهلة. راجع العروض المادية. لا لا –
العروض المادية للبيانات الوصفية العروض المحققة المستخدمة لتسريع اكتشاف الحقول والإكمال التلقائي للقيم. راجع العروض المحققة للبيانات الوصفية. No Yes <table>_kv_rollup_15m
ترتيب النتائج الافتراضي تعبير ORDER BY يتجاوز الترتيب الافتراضي لنتائج البحث. اتركه فارغًا لاستخدام القيمة الافتراضية التي تُكتشف تلقائيًا. ويمكن تخصيصه لكل عملية بحث لاحقًا. No No –

التتبعات

الإعداد الوصف مطلوب يُستدل عليه في المخطط الافتراضي القيمة المُستدل عليها
Name اسم المصدر. نعم لا –
Section تسمية اختيارية لتجميع المصادر في محدد المصادر. تظهر المصادر التي تشترك في القسم نفسه معًا، كما يطابق البحث اسم القسم بالإضافة إلى اسم المصدر. لا لا –
Server Connection اسم اتصال الخادم. نعم لا Default
Database اسم قاعدة بيانات ClickHouse. نعم نعم default
Table اسم الجدول الهدف. اضبطه على otel_traces إذا كنت تستخدم المخطط الافتراضي. نعم نعم -
Query Settings إعدادات الجلسة على مستوى الاستعلام، يُحدَّد كل منها باسم إعداد وقيمة، وتُضاف إلى كل استعلام يُنفَّذ على هذا المصدر. لا لا –
Enabled يُحتفظ بالمصدر المعطّل، لكنه يُخفى من محددات المصادر ولا يُختار تلقائيًا مطلقًا. لا لا مُمكّن
Timestamp Column عمود DateTime أو تعبير يكون جزءًا من المفتاح الأساسي. نعم نعم Timestamp
Default Select الأعمدة التي تظهر في نتائج البحث الافتراضية. نعم نعم Timestamp, ServiceName as service, StatusCode as level, round(Duration / 1e6) as duration, SpanName
Duration Expression تعبير لحساب مدة الـ span. نعم نعم Duration
Duration Precision دقة تعبير المدة (مثل النانوثانية أو الميكروثانية). نعم نعم ns
Trace Id Expression تعبير أو عمود لمعرّفات التتبّع. نعم نعم TraceId
Span Id Expression تعبير أو عمود لمعرّفات الـ span. نعم نعم SpanId
Parent Span Id Expression تعبير أو عمود لمعرّفات الـ span الأصلية. نعم نعم ParentSpanId
Span Name Expression تعبير أو عمود لأسماء الـ span. نعم نعم SpanName
Span Kind Expression تعبير أو عمود لنوع الـ span (مثل client أو server). نعم نعم SpanKind
Correlated Log Source اختياري. مصدر سجلات مرتبط (مثل HyperDX logs). لا لا –
Correlated Session Source اختياري. مصدر جلسة مرتبط. لا لا –
Correlated Metric Source اختياري. مصدر مقاييس مرتبط (مثل HyperDX metrics). لا لا –
Status Code Expression تعبير لرمز حالة الـ span. نعم نعم StatusCode
Status Message Expression تعبير لرسالة حالة الـ span. نعم نعم StatusMessage
Service Name Expression تعبير أو عمود لاسم الخدمة. نعم نعم ServiceName
Service Version Expression تعبير أو عمود يحدد إصدار الخدمة قيد التشغيل، ويُستخدم لرسم علامات الإصدار على مخططات لوحة المعلومات. يُضبط افتراضيًا على سمة المورد service.version في OpenTelemetry عند تركه فارغًا. لا لا ResourceAttributes['service.version']
Resource Attributes Expression تعبير أو عمود للسمات على مستوى المورد. نعم نعم ResourceAttributes
Event Attributes Expression تعبير أو عمود لسمات الأحداث. نعم نعم SpanAttributes
Sample Rate Expression عمود أو تعبير يحتوي على وزن أخذ العينات في المصدر (1/N). عند ضبطه، تُصحَّح عمليات التجميع (count وavg وsum وquantile) وفقًا لأخذ العينات. تستخدم النسب المئوية حينها quantileTDigestWeighted، وهو تقريبي، لذا قد تختلف القيم الدقيقة قليلًا. اتركه فارغًا إذا لم تُؤخذ عينات من الـ spans. لا لا –
Span Events Expression تعبير لاستخراج أحداث الـ span. ويكون عادةً عمودًا من النوع Nested. يتيح ذلك عرض تتبعات المكدس للاستثناءات باستخدام SDKS اللغوية المدعومة. نعم نعم Events
Span Links Expression تعبير لاستخراج روابط الـ span، يُستخدم لالتقاط الروابط من span إلى spans في تتبعات أخرى. يُتوقع أن يكون من النوع Nested(TraceId String, SpanId String, TraceState String, Attributes Map(LowCardinality(String), String)). لا نعم Links
Implicit Column Expression العمود المستخدم للبحث النصي الكامل إذا لم يُحدَّد حقل (بنمط Lucene). ويكون عادةً متن السجل. نعم نعم SpanName
Known Columns List للمصادر التي تعتمد على جدول Distributed أو Merge وتكون جداولها الهدف ذات مجموعات أعمدة غير متطابقة. قائمة مفصولة بفواصل بالأعمدة المتاحة عبر جميع الجداول الهدف، تُستخدم بدلًا من SELECT * عند جلب بيانات الصف الكاملة (مثلًا في اللوحة الجانبية للصف). اتركها فارغة لتحديد جميع الأعمدة. أسماء الأعمدة فقط، دون تعبيرات أو أسماء مستعارة. لا لا –
Use Text Index ما إذا كانت عمليات البحث المستندة إلى Lucene تُصدر hasAllTokens عند البحث في العمود الضمني. لا لا Auto (detect from schema)
Displayed Timestamp Column عمود timestamp اختياري عالي الدقة يُستخدم للعرض في UI. ويُضبط افتراضيًا على Timestamp Column عند عدم توفيره. لا نعم Timestamp
Highlighted Attributes تعبيرات أو أعمدة تُعرض عند فتح تفاصيل الـ span. وستُعرض التعبيرات التي تُرجع عناوين URL كروابط. لا لا –
Highlighted Trace Attributes تعبيرات أو أعمدة تُستخرج من كل span في التتبّع، وتُعرض فوق trace waterfall. وستُعرض التعبيرات التي تُرجع عناوين URL كروابط. لا لا –
Materialized Views عروض متجسدة مُجمّعة مسبقًا ومسجَّلة لهذا المصدر، وتُستخدم تلقائيًا لتسريع الاستعلامات المؤهلة. راجع العروض المتجسدة. لا لا –
Metadata Materialized Views عروض متجسدة تُستخدم لتسريع اكتشاف الحقول والإكمال التلقائي للقيم. راجع العروض المتجسدة للبيانات الوصفية. لا نعم <table>_kv_rollup_15m
Default Order By تعبير ORDER BY يتجاوز الترتيب الافتراضي لنتائج البحث. اتركه فارغًا لاستخدام الإعداد الافتراضي الذي يُكتشف تلقائيًا. يمكن تخصيصه لكل عملية بحث لاحقًا. لا لا –

المقاييس

الإعداد الوصف مطلوب يُستدل عليه في المخطط الافتراضي القيمة المستدل عليها
Name اسم المصدر. نعم لا –
Section تسمية اختيارية لتجميع المصادر في محدد المصادر. تظهر المصادر التي تشترك في القسم نفسه معًا، كما يطابق البحث اسم القسم بالإضافة إلى اسم المصدر. لا لا –
Server Connection اسم اتصال الخادم. نعم لا Default
Database اسم قاعدة بيانات ClickHouse. نعم نعم default
Query Settings حتى عشرة من إعدادات الجلسة على مستوى الاستعلام، يُحدَّد كل منها باسم إعداد وقيمة، وتُضاف إلى كل استعلام يُنفَّذ على هذا المصدر. لا لا –
Enabled مفتاح تبديل في أعلى نموذج المصدر. يُحتفَظ بالمصدر المعطّل، لكنه يُخفى من محددات المصادر ولا يُختار تلقائيًا أبدًا. يظهر فقط عند تحرير مصدر موجود. لا لا مفعّل
Gauge Table الجدول الذي يخزّن مقاييس من نوع Gauge. لا نعم otel_metrics_gauge
Histogram Table الجدول الذي يخزّن مقاييس من نوع Histogram. لا نعم otel_metrics_histogram
Sum Table الجدول الذي يخزّن مقاييس من نوع Sum (عداد). لا نعم otel_metrics_sum
Exponential Histogram Table الجدول الذي يخزّن مقاييس من نوع مُدرَّج تكراري أسي. لا نعم otel_metrics_exponential_histogram
Correlated Log Source اختياري. مصدر السجلات المرتبط (مثل سجلات HyperDX). لا لا –

الجلسات

الإعداد الوصف مطلوب مُستنتج في المخطط الافتراضي القيمة المُستنتجة
Name اسم المصدر. نعم لا –
Section تسمية اختيارية لتجميع المصادر في محدد المصادر. تظهر المصادر التي تشترك في قسم واحد معًا، ويطابق البحث اسم القسم بالإضافة إلى اسم المصدر. لا لا –
Server Connection اسم اتصال الخادم. نعم لا Default
Database اسم قاعدة بيانات ClickHouse. نعم نعم default
Table الجدول الهدف لبيانات الجلسات. اسم الجدول الهدف. اضبطه على hyperdx_sessions إذا كنت تستخدم المخطط الافتراضي. نعم نعم -
Query Settings ما يصل إلى عشرة من إعدادات الجلسة على مستوى الاستعلام، يُحدَّد كلٌّ منها باسم إعداد وقيمة، وتُضاف إلى كل استعلام يُنفَّذ على هذا المصدر. لا لا –
Enabled مفتاح تبديل في أعلى نموذج المصدر. يُحتفظ بالمصدر المعطّل، لكنه يُخفى من محددات المصادر ولا يُختار تلقائيًا مطلقًا. يظهر فقط عند تحرير مصدر موجود. لا لا مفعّل
Correlated Trace Source مصدر تتبّع مرتبط لترابط الجلسات. نعم لا –
Timestamp Column عمود DateTime أو تعبير يشكّل جزءًا من المفتاح الأساسي لديك. نعم نعم TimestampTime
Resource Attributes Expression تعبير لاستخراج البيانات الوصفية على مستوى المورد. لا نعم ResourceAttributes

العروض المادية

يمكن تسجيل العروض المادية لمصادر بيانات السجلات والتتبعات، بحيث تُجاب استعلامات التجميع المؤهلة من العرض المجمّع مسبقًا بدلًا من الجدول المصدر. للحصول على إرشادات حول إنشاء العروض وتسجيلها، راجع "العروض المادية".

يُضبط كل عرض مسجّل بالإعدادات التالية:

الإعداد الوصف
Database قاعدة بيانات ClickHouse التي تحتوي على الجدول الهدف للعرض المادي.
Table الجدول الهدف للعرض المادي، وليس العرض نفسه.
Timestamp Column عمود الطابع الزمني للجدول الهدف.
Granularity الفاصل الزمني لعمود الطابع الزمني في الجدول الهدف، مثل 1 minute. لا يمكن للاستعلام استخدام العرض إلا إذا كان فاصله الزمني مساويًا لهذا الفاصل أو أكبر منه.
Minimum Date اختياري. أقدم تاريخ ووقت يتضمن العرض بيانات لهما. إذا لم يُوفَّر، يفترض ClickStack أن العرض يحتوي على بيانات لكل تاريخ يحتوي الجدول المصدر على بيانات له.
Dimension Columns قائمة مفصولة بفواصل بالأعمدة التي لا تُجمَّع مسبقًا في العرض، وبالتالي يمكن استخدامها للتصفية والتجميع.
Pre-aggregated Columns الأعمدة التي تُجمَّع مسبقًا في العرض. يربط كل إدخال دالة تجميع (avg أو count أو max أو min أو quantile أو sum أو histogram) وعمودًا من الجدول المصدر بالعمود المقابل في العرض. لا يلزم تحديد العمود المصدر لـ count.

يُستدل على معظم هذه الإعدادات من مخطط العرض عند تحديد الجدول الهدف.

العروض المادية للبيانات الوصفية

العروض المادية للبيانات الوصفية هي عروض مادية تُسرّع اكتشاف الحقول لعوامل التصفية والإكمال التلقائي. يمكن تهيئتها لمصادر بيانات السجل والتتبّع.

الإعداد الوصف
Key Rollup Table اختياري ومهمل. جدول تجميعي للمفاتيح الموجودة في الجدول المصدر.
KV Rollup Table جدول تجميعي لأزواج المفتاح/القيمة الموجودة في الجدول المصدر.
الفاصل الزمني الفترة الزمنية التي تستخدمها الجداول التجميعية، على سبيل المثال 15 minute.

Highlighted Attributes

يمكن تهيئة Highlighted Attributes وHighlighted Trace Attributes في مصادر بيانات السجلات والتتبّعات.

  • Highlighted Attributes هي أعمدة أو تعبيرات تُعرض لكل سجل أو span عند عرض تفاصيل السجل أو span.
  • Highlighted Trace Attributes هي أعمدة أو تعبيرات يتم الاستعلام عنها من كل سجل أو span ضمن تتبّع، وتُعرض فوق trace waterfall.

تُعرَّف هذه السمات في تهيئة المصدر، ويمكن أن تكون أي تعبيرات SQL. إذا أعاد تعبير SQL قيمة بتنسيق URL، فستُعرض السمة كرابط. ولا تُعرض القيم الفارغة.

تُهيَّأ كل سمة بالإعدادات التالية:

الإعداد الوصف
SQL Expression العمود أو تعبير SQL يمكن الاستعلام عنه. مطلوب.
Alias اختياري. التسمية المعروضة للسمة بدلًا من تعبير SQL.
Lucene Expression اختياري. نسخة Lucene من تعبير SQL، تُستخدم عند البحث عن قيمة هذه السمة.

على سبيل المثال، تم إعداد مصدر التتبّع هذا بسمة Highlighted Attributes وسمة Highlighted Trace Attributes:

تهيئة Highlighted Attributes

تُعرض هذه السمات في اللوحة الجانبية بعد النقر على سجل أو span:

Highlighted Attributes

يؤدي النقر على سمة إلى إتاحة خيارات لاستخدامها كقيمة بحث. وإذا تم توفير تعبير Lucene اختياري في تهيئة السمة، فسيُستخدم تعبير Lucene للبحث بدلًا من تعبير SQL.

بحث Highlighted Attributes

المصادر المرتبطة

لتمكين الربط الكامل بين المصادر في ClickStack، يجب عليك تكوين مصادر مرتبطة للسجلات والتتبعات والمقاييس والجلسات. يتيح ذلك لـ HyperDX ربط البيانات ذات الصلة وتوفير سياق غني عند عرض الأحداث.

  • Logs: يمكن ربطها بالتتبعات والمقاييس.
  • Traces: يمكن ربطها بالسجلات والجلسات والمقاييس.
  • Metrics: يمكن ربطها بالسجلات.
  • Sessions: يمكن ربطها بالتتبعات.

يؤدي إعداد هذه الارتباطات إلى تمكين العديد من الميزات. على سبيل المثال، يمكن لـ HyperDX عرض السجلات ذات الصلة إلى جانب تتبّع معيّن أو إظهار شذوذات المقاييس المرتبطة بجلسة.

على سبيل المثال، يوضّح الشكل أدناه مصدر السجلات بعد تهيئته بمصادر مرتبطة:

مصدر HyperDX المرتبط

إعدادات تكوين التطبيق

  • 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

راجع "ClickStack OpenTelemetry Collector" لمزيد من التفاصيل.

  • CLICKHOUSE_ENDPOINT

    • الافتراضي: None (مطلوب) إذا كانت الصورة مستقلة. أما إذا كانت التوزيعة All-in-one أو Docker Compose، فستُضبط هذه القيمة على ClickHouse instance المدمجة.
    • الوصف: عنوان URL عبر HTTPS لـ ClickHouse instance التي ستُصدَّر إليها بيانات telemetry.
    • إرشادات:
      • يجب أن يكون endpoint كاملاً عبر HTTPS ويتضمن المنفذ (على سبيل المثال: https://clickhouse.example.com:8443)
      • هذا الإعداد مطلوب لكي يتمكن المجمّع من إرسال البيانات إلى ClickHouse

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

ClickHouse

يأتي ClickStack Open Source بإعداد ClickHouse افتراضي مصمم للعمل على نطاق متعدد التيرابايت، لكن يمكن للمستخدمين تعديله وتحسينه بما يناسب عبء العمل لديهم.

لضبط ClickHouse بفعالية، ينبغي فهم مفاهيم التخزين الأساسية مثل الأجزاء، والأقسام، والشظايا والنسخ المتماثلة، وكيف تحدث عمليات الدمج أثناء الإدراج. ونوصي بمراجعة أساسيات الفهارس الأولية، والفهارس الثانوية المتناثرة، وفهارس تخطي البيانات، إلى جانب تقنيات إدارة دورة حياة البيانات، مثل استخدام دورة حياة TTL.

يدعم ClickStack تخصيص المخطط — إذ يمكنك تعديل أنواع الأعمدة، واستخراج حقول جديدة (مثلًا من السجلات)، وتطبيق codecs والقواميس، وتسريع الاستعلامات باستخدام الإسقاطات.

بالإضافة إلى ذلك، يمكن استخدام العروض المادية لتحويل البيانات أو تصفيتها أثناء الإدخال، بشرط أن تُكتب البيانات إلى الجدول المصدر للعرض وأن يقرأ التطبيق من الجدول الهدف. ويمكن أيضًا استخدام العروض المادية لتسريع الاستعلامات مباشرةً في ClickStack.

لمزيد من التفاصيل، راجع وثائق ClickHouse حول تصميم المخطط، واستراتيجيات الفهرسة، وأفضل ممارسات إدارة البيانات — ومعظمها ينطبق مباشرةً على عمليات نشر ClickStack.

Navigation