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

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

نسخه 1.6.0

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

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

پیش نیازها

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

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

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

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

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

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

• اگر مشتری Apigee Edge برای Private Cloud هستید، از API ویژگی های سازمان به روز رسانی برای تنظیم پرچم features.allowExtensionsInPostClientFlow روی true استفاده کنید.

درباره Cloud Logging

Cloud Logging بخشی از مجموعه عملیات Google Cloud است. این شامل فضای ذخیره‌سازی برای گزارش‌ها، یک رابط کاربری به نام کاوشگر گزارش‌ها و یک 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 را می نویسد. ورودی های گزارش شامل ابرداده و داده های ورودی است. برای اطلاعات بیشتر درباره ورودی‌های گزارش، به مرجع ورود مراجعه کنید. برای اطلاعات در مورد محتویات ویژگی 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 از موارد زیر استفاده کنید.

ویژگی های رایج پسوند

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

ویژگی های این بسته افزونه

مقادیری را برای خصوصیات پیکربندی زیر مخصوص این افزونه مشخص کنید.