أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X. info
الإصدار 1.2.1
يمكنك كتابة الإدخالات في سجلّات Stackdriver Logging.
يوفر هذا المحتوى مرجعًا لإعداد هذه الإضافة واستخدامها.
المتطلبات الأساسية
قبل استخدام هذه الإضافة من خادم وكيل لواجهة برمجة التطبيقات، يجب تنفيذ ما يلي:
في "إدارة الهوية وإمكانية الوصول"، عليك منح إذن Logging > Logs Writer لعضو المشروع الذي سيمثّل إضافتك في نظام Stackdriver Logging. للحصول على تعليمات حول كيفية منح الأدوار، يُرجى الاطّلاع على منح الأدوار لحساب خدمة لموارد معيّنة. لمزيد من المعلومات عن أدوار التسجيل، يُرجى الاطّلاع على دليل التحكّم في الوصول.
استخدِم وحدة تحكّم Google Cloud Platform لإنشاء مفتاح لحساب الخدمة.
استخدِم محتويات ملف 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 | اسم السجلّ الذي ينتمي إليه هذا الإدخال. | سلسلة | بلا عُري | نعم. |
| metadata | البيانات الوصفية حول إدخال في السجلّ. لمزيد من المعلومات والخيارات حول ضبط type و labels في metadata، يُرجى الاطّلاع على MonitoredResource. |
JSON | بلا عُري | لا. |
| message | البيانات التي سيتم استخدامها كقيمة لهذا الإدخال في السجلّ. يمكنك تحديد سلسلة بسيطة أو استخدام JSON لتسجيل رسالة أكثر تنظيمًا. | سلسلة أو JSON | بلا عُري | نعم. |
الردّ
لا يتم عرض أي ردّ إذا تمّت كتابة الرسالة في السجلّ. وإلا، سيعرض الطلب خطأً. يُرجى الاطّلاع أيضًا على مقالة تحديد المشاكل في إضافة وحلّها.
مرجع الإعدادات
استخدِم ما يلي عند إعداد هذه الإضافة ونشرها لاستخدامها في الخوادم الوكيلة لواجهة برمجة التطبيقات.
السمات الشائعة للإضافة
السمات التالية متاحة لكل إضافة.
| الموقع | الوصف | تلقائي | عنصر مطلوب |
|---|---|---|---|
name |
الاسم الذي تُعطِه هذه الإضافة من الإضافات. | لا ينطبق | متوافق |
packageName |
اسم حزمة الإضافة كما هو مُوضَّح من Apigee Edge. | لا ينطبق | متوافق |
version |
رقم إصدار حزمة الإضافة التي تجري عملية إعداد الإضافة منها. | لا ينطبق | متوافق |
configuration |
قيمة الإعداد المتعلقة بالإضافة التي تدرجها الاطّلاع على خصائص حزمة الإضافات هذه | لا ينطبق | متوافق |
سمات حزمة الإضافة هذه
حدِّد قيمًا لسمات الإعدادات التالية الخاصة بهذه الإضافة.
| الموقع | الوصف | تلقائي | مطلوب |
|---|---|---|---|
| projectId | رقم تعريف مشروع Google Cloud Platform الذي يجب إنشاء السجلّات فيه. | بلا عُري | نعم. |
| credentials | عند إدخالها في وحدة تحكّم Apigee Edge، تكون هذه محتويات ملف مفتاح حساب الخدمة. عند إرسالها عبر Management API، تكون قيمة بترميز base64 تم إنشاؤها من ملف مفتاح حساب الخدمة. | بلا عُري | نعم. |