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

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

الإصدار 1.5.0

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

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

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

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

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

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

  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.

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

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

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

نماذج

توضّح الأمثلة التالية كيفية ضبط إتاحة "تسجيل الدخول إلى السحابة الإلكترونية" إجراءات الإضافات باستخدام سياسة 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 في وثائق تسجيل الدخول إلى السحابة الإلكترونية.

البنية

<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 إذا تمت كتابة الرسالة في السجلّ. وإلا، سيعرض الطلب خطأ. راجِع أيضًا تصحيح أخطاء الإضافة.

مرجع الإعداد

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

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

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

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

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

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

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