Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Versi 1.5.0
Menulis entri ke log Cloud 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 > Peran Logs Writer Anda kepada anggota project yang akan mewakili ekstensi Anda ke sistem Cloud 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 Google Cloud Console untuk membuat kunci untuk akun layanan.
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 EkstensiInfo 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 Cloud Logging
Cloud Logging merupakan bagian dari Operations Suite. Layanan ini mencakup penyimpanan untuk log, antarmuka pengguna yang disebut {i>Log<i} dan API untuk mengelola log secara terprogram. Dengan Cloud Logging, Anda dapat membaca dan menulis entri log, menelusuri dan memfilter log Anda, mengekspor log, dan membuat metrik berbasis log.
Ekstensi Cloud Logging saat ini menulis entri ke log. Untuk selengkapnya, lihat dokumentasi Cloud Logging.
Contoh
Contoh berikut menggambarkan cara mengonfigurasi dukungan untuk Cloud Logging tindakan ekstensi menggunakan kebijakan Extensioncallout.
Log global
Kebijakan berikut menulis pesan This is a test
ke log yang disebut
example-log
di resource Cloud Global. Dalam penggunaan
yang sebenarnya, Anda mungkin
mengatur pesan agar dimuat dalam variabel flow yang nilainya telah 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>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>
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 akan menulis entri log Cloud Logging. Entri log terdiri dari metadata
dan data entri. Untuk informasi selengkapnya tentang entri log, lihat
Referensi entri.
Untuk informasi tentang konten properti metadata
, lihat
LogEntry
dalam dokumentasi Cloud Logging.
Sintaksis
<Action>log</Action>
<Input><![CDATA[{
"logName" : "cloud-log-name-to-use",
"metadata" : JSON-structured-metadata,
"message" : "data-to-log-as-entry"
}]]></Input>
Contoh: String
<Action>log</Action>
<Input><![CDATA[{
"logName" : "example-log",
"metadata" : { "resource" : { "type" : "global" } },
"message": "This is a test."
}]]></Input>
Contoh: JSON
<Action>log</Action>
<Input><![CDATA[{
"logName" : "example-log",
"metadata" : { "resource" : { "type" : "global" } },
"message" : { "info" : "This is a test." }
}]]></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 |
message |
Data yang akan digunakan sebagai nilai untuk entri log ini. Anda dapat menentukan string sederhana atau menggunakan JSON untuk mencatat pesan yang lebih terstruktur. | String atau JSON | Tidak ada | Ya |
Respons
None
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 |
ID project Google Cloud 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 |