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

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

الإصدار 1.6.1

.

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

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

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

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

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

  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، استخدِم واجهة برمجة التطبيقات Update organization properties (تعديل خصائص المؤسسة) لضبط العلامة features.allowExtensionsInPostClientFlow على true.

لمحة عن Cloud Logging

.

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

تُسجِّل إضافة "تسجيلات Cloud" حاليًا الإدخالات في السجلّ. لمزيد من المعلومات، يُرجى الاطّلاع على مستندات 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". تتألف إدخالات السجلّ من البيانات الوصفية وبيانات الإدخال. لمزيد من المعلومات عن إدخالات السجلّ، يُرجى الاطّلاع على مرجع الإدخال. للحصول على معلومات عن محتوى الموقع الإلكتروني metadata، اطّلِع على ملف LogEntry في مستندات "تسجيلات Cloud".

البنية

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

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

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

سمات الإضافات الشائعة

The following properties are present for every extension.

Property Description Default Required
name Name you're giving this configuration of the extension. None Yes
packageName Name of the extension package as given by Apigee Edge. None Yes
version Version number for the extension package from which you're configuring an extension. None Yes
configuration Configuration value specific to the extension you're adding. See Properties for this extension package None Yes

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

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

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