Google Stackdriver Logging Extension

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

نسخه ۱.۳.۷

نوشته‌ها را در لاگ‌های Stackdriver Logging بنویسید.

این محتوا مرجعی برای پیکربندی و استفاده از این افزونه ارائه می‌دهد.

پیش‌نیازها

قبل از استفاده از این افزونه از طریق یک پروکسی API، باید:

1. در IAM، نقش‌های Logging > Logs Writer و Logging > Logs Viewer را به عضو پروژه‌ای که نماینده افزونه شما در سیستم Stackdriver Logging خواهد بود، اختصاص دهید. برای دستورالعمل‌های مربوط به نحوه اعطای نقش‌ها، به اعطای نقش به یک حساب سرویس برای منابع خاص مراجعه کنید. برای اطلاعات بیشتر در مورد نقش‌های ثبت وقایع، به راهنمای کنترل دسترسی مراجعه کنید.

2. از کنسول GCP برای تولید کلید برای حساب سرویس استفاده کنید .

3. هنگام افزودن و پیکربندی افزونه با استفاده از مرجع پیکربندی ، از محتویات فایل JSON کلید حاصل استفاده کنید.

این افزونه از فراخوانی توسط یک سیاست ExtensionCallout واقع در PostClientFlow پشتیبانی می‌کند. اگر می‌خواهید از سیاست ExtensionCallout برای فراخوانی این افزونه از یک PostClientFlow استفاده کنید، مطمئن شوید که پرچم features.allowExtensionsInPostClientFlow در سازمان شما روی true تنظیم شده باشد.

• اگر شما مشتری Apigee Edge برای فضای ابری عمومی هستید، باید با پشتیبانی Apigee Edge تماس بگیرید تا مطمئن شوید که پرچم features.allowExtensionsInPostClientFlow در سازمان شما روی true تنظیم شده است.

• اگر شما مشتری Apigee Edge برای Private Cloud هستید، از API مربوط به Update organization properties برای تنظیم flag مربوط به features.allowExtensionsInPostClientFlow روی true استفاده کنید.

درباره ثبت وقایع Stackdriver

Stackdriver Logging بخشی از مجموعه محصولات Stackdriver در پلتفرم ابری گوگل (GCP) است. این مجموعه شامل فضای ذخیره‌سازی برای لاگ‌ها، یک رابط کاربری به نام Logs Viewer و یک API برای مدیریت لاگ‌ها به صورت برنامه‌نویسی شده است. با Stackdriver Logging، می‌توانید ورودی‌های لاگ را بخوانید و بنویسید، لاگ‌های خود را جستجو و فیلتر کنید، لاگ‌های خود را صادر کنید و معیارهای مبتنی بر لاگ ایجاد کنید.

این افزونه در حال حاضر ورودی‌ها را در لاگ می‌نویسد. برای اطلاعات بیشتر، به مستندات Stackdriver Logging مراجعه کنید.

نمونه‌ها

مثال‌های زیر نحوه پیکربندی پشتیبانی از اقدامات افزونه Stackdriver Logging را با استفاده از خط‌مشی ExtensionCallout نشان می‌دهند.

گزارش سراسری

سیاست زیر پیام "این یک آزمایش است" را در یک گزارش به نام example-log در منبع Stackdriver Global می‌نویسد. در استفاده واقعی، احتمالاً این پیام در یک متغیر جریان قرار می‌گیرد که مقدار آن را در جای دیگری در پروکسی API تنظیم کرده‌اید.

<?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، به افزودن و پیکربندی یک افزونه مراجعه کنید.

اقدامات

ورود به سیستم

پیامی را در لاگ می‌نویسد.

این عمل یک ورودی لاگ Stackdriver می‌نویسد. ورودی‌های لاگ شامل فراداده و داده‌های ورودی هستند. برای اطلاعات بیشتر در مورد ورودی‌های لاگ، به مرجع Entry مراجعه کنید. برای اطلاعات در مورد محتوای ویژگی 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>

پارامترهای درخواست

پاسخ

اگر پیام در لاگ نوشته شده باشد، هیچکدام. در غیر این صورت، درخواست خطا برمی‌گرداند. همچنین به اشکال‌زدایی افزونه مراجعه کنید.

مرجع پیکربندی

هنگام پیکربندی و استقرار این افزونه برای استفاده در پروکسی‌های API، از موارد زیر استفاده کنید.

ویژگی‌های افزونه‌های رایج

ویژگی های زیر برای هر افزونه وجود دارد.

ویژگی‌های این بسته الحاقی

مقادیر مربوط به ویژگی‌های پیکربندی زیر را که مختص این افزونه هستند، مشخص کنید.