برنامه افزودنی Google Cloud Logging

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

نسخه ۲.۰.۲

نوشته‌ها را در گزارش‌های Cloud Logging بنویسید.

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

پیش‌نیازها

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

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

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

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 استفاده کنید.

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

Cloud Logging بخشی از مجموعه عملیات Google Cloud است. این مجموعه شامل فضای ذخیره‌سازی برای گزارش‌ها، یک رابط کاربری به نام Logs explorer و یک API برای مدیریت گزارش‌ها به صورت برنامه‌نویسی شده است. با Cloud Logging، می‌توانید ورودی‌های گزارش را بخوانید و بنویسید، گزارش‌های خود را جستجو و فیلتر کنید، گزارش‌های خود را صادر کنید و معیارهای مبتنی بر گزارش‌ها را ایجاد کنید.

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

نمونه‌ها

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

گزارش سراسری

سیاست زیر پیام « This is a test را در یک گزارش به نام example-log در منبع Cloud 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>cloud-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، به افزودن و پیکربندی یک افزونه مراجعه کنید.

اقدامات

ورود به سیستم

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

این اقدام یک ورودی لاگ Cloud Logging می‌نویسد. ورودی‌های لاگ شامل فراداده و داده‌های ورودی هستند. برای اطلاعات بیشتر در مورد ورودی‌های لاگ، به مرجع Entry مراجعه کنید. برای اطلاعات در مورد محتوای ویژگی metadata ، به شیء LogEntry در مستندات Cloud Logging مراجعه کنید.

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "cloud-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>

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "example-log",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : { "info" :  "This is a test." }
}]]></Input>

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

پاسخ

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

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

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

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

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

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

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