افزونه Google Stackdriver Logging

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

نسخه ۱.۲.۰

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

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

پیش‌نیازها

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

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

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

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

درباره Stackdriver Logging

Stackdriver Logging بخشی از مجموعه محصولات Stackdriver در Google Cloud Platform (GCP) است. این سرویس شامل فضای ذخیره‌سازی برای گزارش‌ها، میانای کاربری به‌نام «بیننده گزارش‌ها»، و یک 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، به افزودن و پیکربندی افزونه مراجعه کنید.

کنش‌ها

log

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

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

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

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

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

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