إضافة Google Stackdriver Logging

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

الإصدار 1.2.1

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

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

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

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

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

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

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

لمحة عن Stackdriver Logging

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

تكتب هذه الإضافة حاليًا إدخالات في السجلّ.

لمزيد من المعلومات، راجِع مستندات Stackdriver Logging.

نماذج

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

السجلّ العام

تكتب السياسة التالية الرسالة "هذه تجربة" في سجلّ باسم 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" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message": "This is a test."
}]]></Input>

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

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

الردّ

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

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

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

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

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

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

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