إضافة Google Stackdriver Logging

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

الإصدار 1.3.7

اكتب إدخالات في سجلات Stackdriver Logging.

يوفر هذا المحتوى مرجعًا لضبط هذه الإضافة واستخدامها.

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

قبل استخدام هذه الإضافة من خادم وكيل لواجهة برمجة التطبيقات، يجب:

  1. في "إدارة الهوية وإمكانية الوصول"، عليك إسناد الدور التسجيل > كاتب السجلات والتسجيل > مُشاهد السجلات إلى عضو المشروع الذي سيمثّل إضافتك في نظام Stackdriver Logging. للحصول على تعليمات عن كيفية منح الأدوار، يُرجى الاطّلاع على منح الأدوار لحساب خدمة لموارد محدَّدة. لمزيد من المعلومات عن تسجيل الأدوار، يُرجى الاطّلاع على دليل التحكّم في الوصول.

  2. استخدِم وحدة تحكُّم Google Cloud Platform لإنشاء مفتاح لحساب الخدمة.

  3. استخدِم محتوى ملف JSON للمفتاح الناتج عند تثبيت الإضافة وضبطها باستخدام مرجع الإعدادات.

يمكن طلب هذه الإضافة من خلال سياسة ExtensionCallout المتوفّرة في PostClientFlow. إذا كنت تريد استخدام سياسة ExtensionCallout لطلب هذه الإضافة من PostClientFlow، تأكّد من ضبط العلامة features.allowExtensionsInPostClientFlow على true في مؤسستك.

  • إذا كنت أحد عملاء Apigee Edge for Public Cloud، يجب التواصل مع فريق دعم Apigee Edge للتأكّد من ضبط العلامة features.allowExtensionsInPostClientFlow على true في مؤسستك.

  • إذا كنت أحد عملاء Apigee Edge for Private Cloud، يمكنك استخدام واجهة برمجة التطبيقات تحديث خصائص المؤسسة لضبط العلامة features.allowExtensionsInPostClientFlow على true.

لمحة عن Stackdriver Logging

.

Stackdriver Logging هو جزء من مجموعة منتجات Stackdriver في Google Cloud Platform (GCP). ويتضمن مساحة تخزين للسجلات، وواجهة مستخدم تسمى عارض السجلات، وواجهة برمجة تطبيقات لإدارة السجلات آليًا. باستخدام Stackdriver Logging، يمكنك قراءة الإدخالات في السجلّ وكتابتها والبحث في السجلات وتصفيتها وتصديرها وإنشاء مقاييس مستندة إلى السجلات.

تكتب هذه الإضافة حاليًا إدخالات إلى السجلّ. لمزيد من المعلومات، اطّلِع على مستندات Stackdriver Logging.

عيّنات

توضّح الأمثلة التالية كيفية ضبط الدعم لإجراءات إضافة Stackdriver Logging باستخدام سياسة ExtensionCallout.

السجلّ العام

تكتب السياسة التالية الرسالة "This is a test" (هذا اختبار) في سجلّ يُسمى example-log في مورد Stackdriver Global. وفي الاستخدام الفعلي، قد يتم تضمين الرسالة في متغير تدفق تم تعيينه في مكان آخر في الخادم الوكيل لواجهة برمجة التطبيقات.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Logging-Extension">
    <DisplayName>Logging Connector</DisplayName>
    <Connector>stackdriver-extension-sample</Connector>
    <Action>log</Action>
    <Input><![CDATA[{
        "logName": "example-log",
        "metadata": {
            "resource": {
                "type": "global",
                "labels": {
                    "project_id": "my-test"
                }
            }
        },
        "message": "This is a test"
    }]]></Input>
</ConnectorCallout>

يوفر هذا المحتوى مرجعًا لضبط هذه الإضافة واستخدامها. لمعرفة خطوات إعداد إضافة باستخدام وحدة تحكُّم Apigee، يُرجى الاطّلاع على إضافة إضافة وضبطها.

المهام

log

يكتب رسالة في السجل.

يؤدي هذا الإجراء إلى كتابة إدخال في سجلّ Stackdriver. تتكون إدخالات السجل من بيانات وصفية وبيانات الإدخال. لمزيد من المعلومات عن إدخالات السجل، راجع مرجع الإدخال. للحصول على معلومات حول محتوى السمة metadata، يُرجى الاطّلاع على الكائن LogEntry في وثائق Stackdriver Logging.

البنية

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-log-name-to-use",
  "metadata" : JSON-structured-metadata,
  "message" : "data-to-log-as-entry"
}]]></Input>

مثال

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-log-name-to-use",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : "data-to-log-as-entry"
}]]></Input>

مَعلمات الطلب

المَعلمة الوصف Type تلقائي مطلوبة
logName اسم السجل الذي ينتمي إليه هذا الإدخال. سلسلة بلا عُري نعم.
البيانات الوصفية البيانات الوصفية حول إدخال السجلّ.
لمزيد من المعلومات والخيارات حول ضبط type وlabels في metadata، يُرجى الاطّلاع على MonitoredResource.
JSON بلا عُري لا.
رسالة البيانات المطلوب استخدامها كقيمة لإدخال السجلّ هذا. سلسلة بلا عُري نعم.

الإجابة

لا شيء إذا تمت كتابة الرسالة في السجل. وإلا، فسيعرض الطلب خطأ. راجع أيضًا تصحيح أخطاء الإضافة.

مرجع التكوين

استخدِم ما يلي عند ضبط هذه الإضافة ونشرها للاستخدام في الخوادم الوكيلة لواجهة برمجة التطبيقات.

خصائص الإضافات الشائعة

السمات التالية متاحة لكل إضافة.

الموقع الوصف تلقائي عنصر مطلوب
name الاسم الذي تُعطِه هذه الإضافة من الإضافات. لا ينطبق متوافق
packageName اسم حزمة الإضافة كما هو مُوضَّح من Apigee Edge. لا ينطبق متوافق
version رقم إصدار حزمة الإضافة التي تجري عملية إعداد الإضافة منها. لا ينطبق متوافق
configuration قيمة الإعداد المتعلقة بالإضافة التي تدرجها الاطّلاع على خصائص حزمة الإضافات هذه لا ينطبق متوافق

الخصائص لحزمة الإضافات هذه

يمكنك تحديد قيم لخصائص الإعداد التالية الخاصة بهذه الإضافة.

الموقع الوصف تلقائي مطلوبة
projectId رقم تعريف مشروع Google Cloud Platform الذي يجب إنشاء السجلّات فيه. بلا عُري نعم.
بيانات الاعتماد عند إدخالها في وحدة تحكّم Apigee Edge، تكون هي محتوى ملف مفتاح حساب الخدمة. وعند إرسالها من خلال واجهة برمجة تطبيقات الإدارة، تكون قيمة بترميز base64 يتم إنشاؤها من ملف مفتاح حساب الخدمة. بلا عُري نعم.