إضافة التسجيل في السحابة الإلكترونية من Google

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
info

الإصدار 2.0.2

كتابة إدخالات في سجلّات Cloud Logging

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

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

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

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

  2. استخدِم Google Cloud Console لإنشاء مفتاح لحساب الخدمة.

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

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

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

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

لمحة عن Cloud Logging

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

تكتب إضافة Cloud Logging الإدخالات في السجلّ. لمزيد من المعلومات، راجِع مستندات Cloud Logging.

نماذج

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

السجلّ العام

تكتب السياسة التالية الرسالة This is a test في سجلّ باسم example-log في مورد Cloud 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>cloud-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

تكتب هذه السمة رسالة في السجلّ.

يكتب هذا الإجراء إدخالاً في سجلّ Cloud Logging. تتألف إدخالات السجلّ من بيانات وصفية وبيانات الإدخال. لمزيد من المعلومات عن إدخالات السجلّ، يمكنك الاطّلاع على مرجع الإدخالات. للحصول على معلومات حول محتوى السمة metadata، راجِع عنصر LogEntry في مستندات Cloud Logging.

البنية

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

مثال: سلسلة

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message": "This is a test."
}]]></Input>

مثال: JSON

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : { "info" :  "This is a test." }
}]]></Input>

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

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

الردّ

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

مرجع الإعدادات

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

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

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

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

سمات حزمة الإضافة هذه

حدِّد قيمًا لخصائص الإعداد التالية الخاصة بهذا الامتداد.

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