Google Cloud Logging Extension

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

نسخه ۱.۶.۰

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

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

پیش‌نیازها

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

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

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

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

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

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

• اگر مشتری Apigee Edge for Private Cloud هستید، از Update organization properties (به‌روزرسانی دارایی‌های سازمان) API برای تنظیم پرچم features.allowExtensionsInPostClientFlow روی true استفاده کنید.

درباره Cloud Logging

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

افزونه «ثبت گزارش Cloud» درحال‌حاضر ورودی‌ها را در گزارش می‌نویسد. برای اطلاعات بیشتر، مستندات Cloud Logging را ببینید.

نمونه‌ها

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

گزارش جهانی

خط‌مشی زیر پیام This is a test را در گزارش example-log در منبع «جهانی Cloud» می‌نویسد. در استفاده واقعی، احتمالاً پیام را در متغیر جریانی قرار می‌دهید که مقدار آن را در جای دیگری در پراکسی 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، به افزودن و پیکربندی افزونه مراجعه کنید.

کنش‌ها

log

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

این کنش ورودی گزارش 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، از موارد زیر استفاده کنید.

دارایی‌های افزونه مشترک

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

دارایی‌های این بسته افزونه

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