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

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

الإصدار 1.5.0

اكتب الإدخالات في سجلّات 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 للسحابة الإلكترونية الخاصة، استخدِم واجهة برمجة التطبيقات تعديل خصائص المؤسسة لضبط العلامة 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 إذا تمّت كتابة الرسالة في السجلّ. وإلا، سيعرض الطلب خطأً. يُرجى الاطّلاع أيضًا على مقالة تحديد المشاكل في إضافة وحلّها.

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

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

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

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

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

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

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

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