أتمتة الإدارة عبر API Cluster في Dynatrace Managed

API Cluster في Dynatrace Managed: أتمتة البيئات والرموز والمستخدمين والعقد بسكربتات عملية بـ curl وbash يمكنك إعادة استخدامها.
Automatiser l'administration avec l'API Cluster de Dynatrace Managed

إنشاء بيئة (environment) لشركة تابعة جديدة، وإضافة مجموعة مستخدمين، وتوليد رمز (token) لسلسلة النشر، والتحقق من حالة العقد قبل صيانة: كل مهمة من هذه المهام تُنجز بنقرات قليلة في Cluster Management Console. لكنها حين تتكرر كل أسبوع، على عدة عناقيد، على يد عدة مديرين، تتحول إلى مصدر للأخطاء والفروقات في الإعدادات، ما لم تُسنَد إلى API Cluster.

صُمّمت واجهة API Cluster في Dynatrace Managed لهذا الغرض. وهي تختلف عن واجهة البيئة (https://{your-domain}/e/{environment-id}/api/…)، إذ تعمل على مستوى المنصة: https://{your-domain}/api/cluster/v2/… للإصدار v2، وبصورة رئيسية https://{your-domain}/api/v1.0/onpremise/… للإصدار v1. ولا مقابل لها لعميل SaaS، لأن مشغّل العنقود، أي أنت، هو من يحتاج إليها.

يستعرض هذا المقال ما تتيحه، وكيف تؤمّنها، ويقدّم سكربتات عملية لبدء أتمتة جادة.

API Cluster أم واجهة البيئة؟

المعيار API Cluster واجهة البيئة
عنوان URL الأساسي https://{your-domain}/api/cluster/v2 و…/api/v1.0/onpremise (v1) https://{your-domain}/e/{id}/api/v1|v2
الرمز رمز العنقود (CMC، Settings > API tokens) رمز البيئة
النطاق العقد والبيئات والمستخدمون والمجموعات والتراخيص وإعدادات العنقود الكيانات والمقاييس والمشكلات وإعدادات المراقبة ونشر OneAgent
المستخدمون المعتادون فريق المنصة فرق التشغيل وCI/CD والأدوات الخارجية

تستخدم الأتمتة الكاملة الواجهتين معًا في الغالب: تنشئ API Cluster البيئة وأول رمز بيئة، ثم تتولى واجهة البيئة إعداد المراقبة.

ما الذي يُؤتمت عادة؟

  • دورة حياة البيئات: الإنشاء وإعادة التسمية والتفعيل والتعطيل، والحصص (وحدات المضيفات والجلسات والتخزين).
  • الرموز (tokens): توليد رموز بيئة لتهيئة الأدوات.
  • المستخدمون والمجموعات: إنشاء المجموعات ومنح الصلاحيات وتصدير بيانات التدقيق (راجع نموذج الوصول في Managed).
  • حالة العنقود: قائمة العقد وحالتها وإصدارها، وهي مفيدة قبل الصيانة وبعدها.
  • الإعدادات: SMTP والوكيل (proxy) والنسخ الاحتياطي، بحسب ما يعرضه إصدارك.

تتوقف القائمة الدقيقة لنقاط النهاية على إصدار Managed. والمرجع الحاسم هو مستكشف API Cluster المتاح من CMC، الذي يوثّق كل مسار ويتيح تجربته.

درس تطبيقي خطوة بخطوة

الخطوة 1: أنشئ Cluster API token مخصصًا

في CMC افتح Settings > API tokens، قسم Cluster tokens، وأنشئ رمزًا لكل استخدام: audit وprovisioning-environnements وغيرها. لا تحدد إلا الصلاحيات اللازمة من بين Service Provider API (ServiceProviderAPI، وهي مطلوبة للبيئات والمستخدمين والمجموعات والعقد) وCluster token management وRead settings وWrite settings. خزّن القيمة في خزنة أسرارك؛ فلن تُعرض مرة أخرى.

export DT_CLUSTER="https://{your-domain}"
export DT_CTOKEN="{token}"   # to load from a vault, never hardcoded in a repository

الخطوة 2: أول استدعاء، سرد البيئات

curl -s -H "Authorization: Api-Token $DT_CTOKEN" \
  -H "Accept: application/json" \
  "$DT_CLUSTER/api/cluster/v2/environments" | python3 -m json.tool

ستحصل على قائمة البيئات مع معرّفها واسمها وحالتها وحصصها. وإذا تلقيت الخطأ 401 فقد فشلت مصادقة الرمز: تحقق من صلاحيته وصلاحياته.

الخطوة 3: أنشئ بيئة بطريقة متكافئة (idempotent)

السكربت الجيد يمكن إعادة تشغيله دون آثار جانبية. لذلك نتحقق من الوجود قبل الإنشاء:

#!/usr/bin/env bash
set -euo pipefail
NOM="${1:?usage: $0 nom-environnement}"

existe=$(curl -s -H "Authorization: Api-Token $DT_CTOKEN" \
  "$DT_CLUSTER/api/cluster/v2/environments" \
  | python3 -c "import sys,json; d=json.load(sys.stdin); print(any(e.get('name')=='$NOM' for e in d.get('environments',[])))")

if [ "$existe" = "True" ]; then
  echo "Environnement $NOM déjà présent, rien à faire."
  exit 0
fi

curl -s -X POST -H "Authorization: Api-Token $DT_CTOKEN" \
  -H "Content-Type: application/json" \
  -d "{\"name\": \"$NOM\", \"state\": \"ENABLED\", \"tags\": [\"provisionne-par-api\"]}" \
  "$DT_CLUSTER/api/cluster/v2/environments"

تُعاد القائمة في المصفوفة environments مقسّمة إلى صفحات (nextPageKey): في عنقود كبير اتبع الترقيم أو زد pageSize. ويحتوي رد الإنشاء على معرّف البيئة الجديدة، فاحتفظ به للخطوات التالية.

الخطوة 4: هيّئ البيئة برمز

بإضافة ?createToken=true إلى طلب POST الخاص بالإنشاء، يحتوي الرد على tokenManagementToken (النطاقات apiTokens.read وapiTokens.write وTenantTokenManagement). يتيح هذا الرمز إنشاء رمز بيئة بنطاقات محدودة عبر POST /e/{id}/api/v2/apiTokens. ويُستخدم الأخير في مرحلة ثانية من السكربتات تدفع الإعداد الأساسي عبر واجهة البيئة: الوسوم التلقائية وmanagement zones وملفات التنبيه.

export DT_ENV="$DT_CLUSTER/e/{environment-id}"
curl -s -H "Authorization: Api-Token {environment-token}" \
  "$DT_ENV/api/v2/settings/schemas" | python3 -m json.tool | head -40

الخطوة 5: افحص حالة العقد قبل الصيانة

استعلم عن مسار v1 الذي يعطي معلومات عن العقد المعروفة في العنقود (صلاحية Service Provider API)، وهو يعيد خصوصًا operationState والإصدار، وارفض المتابعة إذا لم تكن عقدة في الحالة المتوقعة:

curl -s -H "Authorization: Api-Token $DT_CTOKEN" \
  "$DT_CLUSTER/api/v1.0/onpremise/cluster" | python3 -m json.tool

وحين يقترن هذا الفحص بـ systemctl أو df -h /var/opt/dynatrace-managed المنفّذ على كل عقدة عبر أداة إدارة الإعدادات لديك، يصبح «فحصًا مسبقًا» موثوقًا للصيانة.

الخطوة 6: دمجها في أدواتك الحالية

تندمج الاستدعاءات نفسها بسهولة في Ansible (الوحدة uri) أو في مسار CI أو في Terraform عبر مزوّد (provider) متوافق مع إصدارك. والمبدأ ثابت: مستودع Git يصف الحالة المطلوبة (البيئات والمجموعات والحصص)، ومهمة تقارنها بالحالة الفعلية وتطبق الفرق.

أفضل الممارسات

  • رمز لكل استخدام، بأقل نطاقات ممكنة، وتاريخ انتهاء، وتدوير مجدول.
  • لا رموز مكشوفة في سكربت أو مستودع أو سجل الصدفة (shell)؛ استخدم خزنة ومتغيرات بيئة.
  • التكافؤ (idempotence): تحقق قبل الإنشاء، وحدّث بدل أن تعيد الإنشاء.
  • وضع «dry-run»: اعرض خطة العمل قبل تطبيقها.
  • معالجة الأخطاء: افحص رمز HTTP (curl -w "%{http_code}") والتزم بحدود المعدل (الرد 429).
  • اختبارات الانحدار بعد كل تحديث لـ Managed: فالواجهات تتطور وقد تُهمَل مسارات v1 لصالح v2.
  • التتبع: يجب أن يظهر كل إجراء مؤتمت في سجل التدقيق ويرتبط بـ commit.

الأسئلة الشائعة

ما الفرق بين API Cluster وواجهة البيئة؟

تغطي API Cluster (/api/cluster/v2 و/api/v1.0/onpremise، ورمز العنقود المنشأ في CMC) المنصة: العقد والبيئات والمستخدمين والمجموعات والتراخيص. وتغطي واجهة البيئة (/e/{id}/api/…، ورمز البيئة) المراقبة: الكيانات والمقاييس والمشكلات والإعدادات. وتجمع الأتمتة الكاملة بينهما في الغالب.

ماذا تعني الأخطاء 401 و403 و429؟

يدل 401 على فشل مصادقة الرمز (غير صالح أو منتهي أو يفتقر إلى الصلاحية المطلوبة)، ويدل 403 على رفض الوصول، ويدل 429 على تجاوز حدود المعدل: أبطئ الاستدعاءات وأعد المحاولة لاحقًا.

أين أجد القائمة الدقيقة للمسارات المتاحة؟

في مستكشف API Cluster المتاح من CMC: فهو يوثّق كل مسار في إصدارك ويتيح تجربته. أعد فحص سكربتاتك بعد كل تحديث، فقد تُهمَل بعض مسارات v1 لصالح v2.

الخلاصة

API Cluster هي الأداة التي تنقل إدارة Dynatrace Managed من النقر اليدوي إلى التشغيل الصناعي. فبالبدء بسكربتات بسيطة ومتكافئة، كالجرد وإنشاء البيئة وتصدير التدقيق، ثم دمجها في أدوات الإعداد لديك، تكسب السرعة والاتساق بين العناقيد والتتبع. وكل ذلك دون مغادرة المعايير: HTTP وJSON وcurl وخزنة للأسرار.

span.observer مدوّنة مجتمعية مستقلة وغير تابعة لشركة Dynatrace LLC. Dynatrace علامة تجارية لشركة Dynatrace LLC. تحقق دائمًا من القيم (المنافذ والإصدارات والأحجام) في الوثائق الرسمية الخاصة بإصدارك من Managed.

Total
0
Shares
Leave a Reply

Your email address will not be published. Required fields are marked *

Previous Post
Alerting, profils, intégrations : les notifications dans Dynatrace Managed

ملفات التنبيه والتكاملات: الإشعارات في Dynatrace Managed

Next Post
Surveiller la santé de son cluster Managed

مراقبة سلامة العنقود: كيف تراقب عنقود Dynatrace Managed

Related Posts