إضافة Google Stackdriver Logging

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

الإصدار 1.2.1

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

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

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

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

  1. في "إدارة الهوية وإمكانية الوصول"، عيِّن التسجيل > إذن 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.

سجل عمومي

تكتب السياسة التالية الرسالة "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" : "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 اسم السجلّ الذي ينتمي إليه هذا الإدخال. سلسلة بلا عُري نعم.
البيانات الوصفية البيانات الوصفية حول إدخال السجلّ.
لمزيد من المعلومات والخيارات حول ضبط type وlabels في metadata، يمكنك الاطّلاع على MonitoredResource.
JSON بلا عُري لا.
رسالة البيانات التي يتم استخدامها كقيمة لإدخال السجلّ هذا ويمكنك تحديد سلسلة بسيطة أو استخدام JSON لتسجيل رسالة أكثر تنظيمًا. سلسلة أو JSON بلا عُري نعم.

الرد

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

مرجع الإعداد

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

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

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

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

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

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

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