إضافة Google Stackdriver Logging

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

الإصدار 1.3.7

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

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

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

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

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

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

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.

لمحة عن Stackdriver Logging

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

تكتب هذه الإضافة حاليًا إدخالات في السجلّ. لمزيد من المعلومات، يُرجى الاطّلاع على مستندات Stackdriver Logging.

نماذج

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

سجل عمومي

تكتب السياسة التالية الرسالة "This is a test" إلى سجل يسمى 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" : "stackdriver-log-name-to-use",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : "data-to-log-as-entry"
}]]></Input>

معلمات الطلب

الرد

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

مرجع الإعداد

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

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

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

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

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