أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات
Apigee X. info
الإصدار 1.2.1
كتابة الإدخالات في سجلات Stackdriver Logging
يوفّر هذا المحتوى مرجعًا لضبط هذه الإضافة واستخدامها.
المتطلبات الأساسية
قبل استخدام هذه الإضافة من خادم وكيل لواجهة برمجة التطبيقات، عليك إجراء ما يلي:
في "إدارة الهوية وإمكانية الوصول"، امنح إذن "التسجيل> "كاتب السجلّات" إلى عضو المشروع الذي سيمثّل إضافة Chrome في نظام "تسجيل Stackdriver". للحصول على تعليمات عن كيفية منح الأدوار، يُرجى الاطّلاع على مقالة منح أدوار لحساب خدمة لموارد معيّنة. لمزيد من المعلومات عن أدوار تسجيل الدخول، يُرجى الاطّلاع على دليل التحكّم في الوصول.
استخدِم وحدة تحكّم Google Cloud Platform لإنشاء مفتاح لحساب الخدمة.
استخدِم محتوى ملف JSON الناتج عن المفتاح عند إضافة الإضافة وضبطها باستخدام مرجع الإعدادات.
لمحة عن Stackdriver Logging
تسجيل Stackdriver هو جزء من مجموعة منتجات Stackdriver في Google Cloud Platform (GCP). يتضمّن هذا الإصدار مساحة تخزين للسجلات وواجهة مستخدم تُعرف باسم "عارض السجلّات" وواجهة برمجة تطبيقات لإدارة السجلّات آليًا. باستخدام ميزة "تسجيل Stackdriver"، يمكنك قراءة إدخالات السجلّات وكتابتها والبحث في السجلّات وفلترتها وتصديرها وإنشاء مقاييس مستندة إلى السجلّات.
تُسجِّل هذه الإضافة حاليًا الإدخالات في السجلّ.
لمزيد من المعلومات، يُرجى الاطّلاع على مستندات تسجيل Stackdriver.
نماذج
توضِّح الأمثلة التالية كيفية ضبط الإعدادات لتفعيل إجراءات إضافة "تسجيل Stackdriver" باستخدام سياسة ExtensionCallout.
السجلّ العام
تُسجِّل السياسة التالية الرسالة "هذا اختبار" في سجلّ يُسمى example-log في المورد الشامل في Stackdriver. في الاستخدام الفعلي، من المحتمل أن تتضمّن الرسالة متغيّر مسار يمكنك ضبط قيمته في مكان آخر في الوكيل لواجهة برمجة التطبيقات.
<?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 |
قيمة الإعداد المتعلقة بالإضافة التي تدرجها الاطّلاع على خصائص حزمة الإضافات هذه | لا ينطبق | متوافق |
سمات حزمة الإضافة هذه
حدِّد قيمًا لسمات الإعدادات التالية الخاصة بهذه الإضافة.
الموقع | الوصف | تلقائي | مطلوب |
---|---|---|---|
projectId | رقم تعريف مشروع Google Cloud Platform الذي يجب إنشاء السجلّات فيه. | بلا عُري | نعم. |
بيانات الاعتماد | عند إدخالها في وحدة تحكّم Apigee Edge، تكون هذه هي محتويات ملف مفتاح حساب الخدمة. عند إرسالها من خلال Management API، تكون قيمة مُشفَّرة بترميز base64 تم إنشاؤها من ملف مفتاح حساب الخدمة. | بلا عُري | نعم. |