Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Versi 1.3.7
Menulis entri ke log Stackdriver Logging.
Konten ini menyediakan referensi untuk mengonfigurasi dan menggunakan ekstensi ini.
Prasyarat
Sebelum menggunakan ekstensi ini dari proxy API, Anda harus:
Di IAM, tetapkan log Logging > Penulis Log dan Pencatatan Log > Peran Logs Viewer kepada anggota project yang akan mewakili ekstensi Anda ke sistem Stackdriver Logging. Untuk mengetahui petunjuk cara memberikan peran, lihat Memberikan peran ke akun layanan untuk resource tertentu. Untuk mengetahui informasi selengkapnya tentang peran logging, lihat Panduan Kontrol Akses.
Gunakan konten file JSON utama yang dihasilkan saat menambahkan dan mengonfigurasi ekstensi menggunakan referensi konfigurasi.
Ekstensi ini mendukung pemanggilan oleh kebijakan Extensioncallout yang ada di PostClientFlow.
Jika Anda ingin menggunakan kebijakan Extensioncallout untuk memanggil ekstensi ini dari
PostClientFlow, pastikan bahwa flag features.allowExtensionsInPostClientFlow
ditetapkan ke true
di organisasi Anda.
Jika Anda adalah pelanggan Apigee Edge untuk Public Cloud, Anda harus menghubungi Dukungan Apigee Edge untuk memastikan bahwa Tanda
features.allowExtensionsInPostClientFlow
ditetapkan ketrue
di organisasi Anda.Jika Anda adalah pelanggan Apigee Edge untuk Private Cloud, gunakan API Memperbarui properti organisasi untuk menyetel tanda
features.allowExtensionsInPostClientFlow
ketrue
.
Tentang Stackdriver Logging
Stackdriver Logging adalah bagian dari rangkaian produk Stackdriver di Google Cloud Platform (GCP). Layanan ini 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.
Ekstensi ini saat ini menulis entri ke log. Untuk informasi selengkapnya, lihat dokumen Stackdriver Logging.
Contoh
Contoh berikut menggambarkan cara mengonfigurasi dukungan untuk tindakan ekstensi Stackdriver Logging menggunakan kebijakan Extensioncallout.
Log global
Kebijakan berikut menulis pesan "This is a test" ke log yang disebut {i>example-log<i} di resource Stackdriver Global. Dalam penggunaan sebenarnya, Anda mungkin memiliki pesan yang dimuat dalam variabel alur yang nilainya Anda tetapkan di tempat lain di 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 menyediakan referensi untuk mengonfigurasi dan menggunakan ekstensi ini. Untuk mengetahui langkah-langkah dalam 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 mengetahui informasi tentang konten properti metadata
, lihat objek LogEntry dalam dokumentasi Stackdriver Logging.
Sintaksis
<Action>log</Action>
<Input><![CDATA[{
"logName" : "stackdriver-log-name-to-use",
"metadata" : JSON-structured-metadata,
"message" : "data-to-log-as-entry"
}]]></Input>
Contoh
<Action>log</Action>
<Input><![CDATA[{
"logName" : "stackdriver-log-name-to-use",
"metadata" : { "resource" : { "type" : "global" } },
"message" : "data-to-log-as-entry"
}]]></Input>
Parameter permintaan
Parameter | Deskripsi | Jenis | Default | Wajib |
---|---|---|---|---|
logName | Nama log tempat entri ini berada. | String | Tidak ada. | Ya. |
metadata | Metadata tentang entri log. Untuk informasi selengkapnya dan opsi tentang cara menyetel type dan labels di metadata , lihat MonitoredResource. |
JSON | Tidak ada. | Tidak. |
pesan | Data yang akan digunakan sebagai nilai untuk entri log ini. | String | Tidak ada. | Ya. |
Respons
Tidak ada jika pesan ditulis ke log. Jika tidak, permintaan akan menampilkan error. Lihat juga Melakukan 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 | Deskripsi | Default | Wajib |
---|---|---|---|
name |
Nama yang Anda berikan pada konfigurasi ekstensi ini. | Tidak ada | Ya |
packageName |
Nama paket ekstensi seperti yang diberikan oleh Apigee Edge. | Tidak ada | Ya |
version |
Nomor versi untuk paket ekstensi tempat Anda mengonfigurasi ekstensi. | Tidak ada | Ya |
configuration |
Nilai konfigurasi khusus untuk ekstensi yang Anda tambahkan. Lihat Properti untuk paket ekstensi ini | Tidak ada | Ya |
Properti untuk paket ekstensi ini
Tentukan nilai untuk properti konfigurasi berikut khusus untuk ekstensi ini.
Properti | Deskripsi | Default | Wajib |
---|---|---|---|
projectId | Project ID GCP tempat log akan dibuat. | Tidak ada. | Ya. |
credentials | Saat dimasukkan di konsol Apigee Edge, ini adalah isi file kunci akun layanan Anda. Saat dikirim melalui Management API, ini adalah nilai berenkode base64 yang dihasilkan dari file kunci akun layanan. | Tidak ada. | Ya. |