Ekstensi Google Stackdriver Logging

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Versi 1.2.0

Menulis entri ke log Stackdriver Logging.

Konten ini memberikan referensi untuk mengonfigurasi dan menggunakan ekstensi ini.

Prasyarat

Sebelum menggunakan ekstensi ini dari proxy API, Anda harus:

1. Di IAM, tetapkan izin Logging > Logs Writer ke anggota project yang akan mewakili ekstensi Anda ke sistem Stackdriver Logging. Untuk petunjuk tentang cara memberikan peran, lihat Memberikan peran ke akun layanan untuk resource tertentu. Untuk mengetahui informasi selengkapnya tentang peran logging, lihat Panduan Kontrol Akses.

2. Gunakan Konsol GCP untuk membuat kunci akun layanan.

3. Gunakan konten file JSON kunci yang dihasilkan saat menambahkan dan mengonfigurasi ekstensi menggunakan referensi konfigurasi.

Tentang Stackdriver Logging

Stackdriver Logging adalah bagian dari rangkaian produk Stackdriver di Google Cloud Platform (GCP). Logging mencakup penyimpanan untuk log, antarmuka pengguna yang disebut Logs Viewer, dan API untuk mengelola log secara terprogram. Dengan Stackdriver Logging, Anda dapat membaca dan menulis entri log, menelusuri dan memfilter log, mengekspor log, serta membuat metrik berbasis log.

Saat ini ekstensi ini menulis entri ke log.

Untuk mengetahui informasi selengkapnya, lihat dokumen Stackdriver Logging.

Contoh

Contoh berikut mengilustrasikan cara mengonfigurasi dukungan untuk tindakan ekstensi Stackdriver Logging menggunakan kebijakan ExtensionCallout.

Log global

Kebijakan berikut menulis pesan "Ini adalah pengujian" ke log yang disebut example-log di resource Global Stackdriver. Dalam penggunaan sebenarnya, Anda mungkin akan menyimpan pesan dalam variabel alur yang nilainya Anda tetapkan di tempat lain dalam proxy 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>

Konten ini memberikan referensi untuk mengonfigurasi dan menggunakan ekstensi ini. Untuk mengetahui langkah-langkah mengonfigurasi ekstensi menggunakan konsol Apigee, lihat Menambahkan dan mengonfigurasi ekstensi.

Tindakan

log

Menulis pesan ke log.

Tindakan ini menulis entri log Stackdriver. Entri log terdiri dari metadata dan data entri. Untuk mengetahui informasi selengkapnya tentang entri log, lihat Referensi entri. Untuk informasi tentang konten properti metadata, lihat objek LogEntry dalam dokumentasi 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>

Parameter permintaan

Respons

Tidak ada jika pesan ditulis ke log. Jika tidak, permintaan akan menampilkan error. Lihat juga Men-debug ekstensi.

Referensi Konfigurasi

Gunakan hal berikut saat Anda mengonfigurasi dan men-deploy ekstensi ini untuk digunakan di proxy API.

Properti ekstensi umum

Properti berikut ada untuk setiap ekstensi.

Properti untuk paket ekstensi ini

Tentukan nilai untuk properti konfigurasi berikut yang khusus untuk ekstensi ini.