Google Stackdriver Logging Extension

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

نسخه 1.3.7

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

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

پیش نیازها

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

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

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

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

درباره Stackdriver Logging

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

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

نمونه ها

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

ثبت جهانی

خط مشی زیر پیام "This is a test" را در گزارشی به نام 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 را می نویسد. ورودی های گزارش شامل ابرداده و داده های ورودی است. برای اطلاعات بیشتر درباره ورودی‌های گزارش، به مرجع ورود مراجعه کنید. برای اطلاعات در مورد محتویات ویژگی 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 از موارد زیر استفاده کنید.

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

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

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

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