Apigee Edge belgelerini görüntülüyorsunuz.
.
Git:
Apigee X belgeleri. bilgi
ziyaret edin.Sürüm 1.5.0
Cloud Logging günlüklerine giriş yazın.
Bu içerik, bu uzantının yapılandırılması ve kullanılması için referans sağlamaktadır.
Ön koşullar
Bu uzantıyı bir API proxy'sinden kullanmadan önce şunları yapmanız gerekir:
IAM'de Günlük Kaydı > Cloud Logging sistemindeki uzantınızı temsil edecek proje üyesine Günlük Yazıcı rolü. Rollerin nasıl atanacağıyla ilgili talimatları Belirli kaynaklar için hizmet hesabına rol atama başlıklı makalede bulabilirsiniz. Günlük kaydı rolleri hakkında daha fazla bilgi için Erişim Denetimi Kılavuzu'na bakın.
Google Cloud Console'u kullanarak hizmet hesabı için bir anahtar oluşturun.
Yapılandırma referansını kullanarak uzantıyı eklerken ve yapılandırırken sonuçta ortaya çıkan anahtar JSON dosyasının içeriğini kullanın.
Bu uzantı, PostClientFlow'da bulunan bir ExtensionReference politikası tarafından çağrılmayı destekler.
Bu uzantıyı
PostClientFlow, features.allowExtensionsInPostClientFlow
işaretinin
kuruluşunuzda true
olarak ayarlanmış olmalıdır.
Herkese Açık Bulut alanında Apigee Edge müşterisiyseniz Apigee Edge Destek Ekibi ile iletişime geçerek
features.allowExtensionsInPostClientFlow
işareti kuruluşunuzdatrue
olarak ayarlandı.Private Cloud müşterisi iseniz Apigee Edge'i Kuruluş özelliklerini güncelleme API'si
features.allowExtensionsInPostClientFlow
işaretinitrue
olarak ayarlayın.
Cloud Logging hakkında
Cloud Logging, Google Cloud'un ürün paketimiz var. Bu deneyimde, günlüklerin depolanmasını ve Günlükler adlı bir kullanıcı gezgini ve günlükleri programatik olarak yönetmek için bir API kullanabilirsiniz. Cloud Logging ile şunları yapabilirsiniz: günlük girişlerini okuyabilir ve yazabilir, günlüklerinizde arama yapabilir ve filtre uygulayabilir, günlüklerinizi dışa aktarabilir ve günlük tabanlı metrikler oluşturabilirsiniz.
Cloud Logging uzantısı şu anda günlüğe giriş yazıyor. Daha fazlası için Cloud Logging belgelerine göz atın.
Örnekler
Aşağıdaki örnekler, Cloud Logging desteğinin nasıl yapılandırılacağını gösterir UzantıAçıklama Metni politikasını kullanarak uzantı işlemleri.
Genel günlük
Aşağıdaki politika, This is a test
mesajını
Cloud Global kaynağında example-log
. Gerçek kullanımda,
mesajın, değerini başka bir yerde ayarladığınız bir akış değişkeninde bulunmasını sağlama
inceleyebilirsiniz.
<?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>
Bu içerik, bu uzantının yapılandırılması ve kullanılması için referans sağlamaktadır. Apigee konsolunu kullanarak uzantıları yapılandırma adımları için bkz. Uzantı ekleme ve yapılandırma.
İşlemler
log
Günlüğe bir mesaj yazar.
Bu işlem bir Cloud Logging günlük girişi yazar. Günlük girişleri meta verilerden oluşur
ve giriş verilerini içerir. Günlük girişleri hakkında daha fazla bilgi için
Giriş referansı.
metadata
özelliğinin içeriği hakkında bilgi için
LogEntry
nesnesini ele alalım.
Söz dizimi
<Action>log</Action>
<Input><![CDATA[{
"logName" : "cloud-log-name-to-use",
"metadata" : JSON-structured-metadata,
"message" : "data-to-log-as-entry"
}]]></Input>
Örnek: Dize
<Action>log</Action>
<Input><![CDATA[{
"logName" : "example-log",
"metadata" : { "resource" : { "type" : "global" } },
"message": "This is a test."
}]]></Input>
Örnek: JSON
<Action>log</Action>
<Input><![CDATA[{
"logName" : "example-log",
"metadata" : { "resource" : { "type" : "global" } },
"message" : { "info" : "This is a test." }
}]]></Input>
İstek parametreleri
Parametre | Açıklama | Tür | Varsayılan | Zorunlu |
---|---|---|---|---|
logName |
Bu girişin ait olduğu günlüğün adı. | Dize | Yok | Evet |
metadata |
Günlük girişiyle ilgili meta veriler.metadata içinde type ve labels ayarlarını yapmayla ilgili daha fazla bilgi ve seçenekler için MonitoredResource bölümüne bakın. |
JSON | Yok | Hayır |
message |
Bu günlük girişi için değer olarak kullanılacak veriler. Basit bir dize belirtebilir veya daha yapılandırılmış bir mesajı günlüğe kaydetmek için JSON kullanabilirsiniz. | Dize veya JSON | Yok | Evet |
Yanıt
Mesaj günlüğe yazıldıysa None
. Aksi takdirde istek bir hata döndürür. Ayrıca, Uzantılarda hata ayıklama bölümüne de göz atın.
Yapılandırma referansı
Bu uzantıyı API proxy'lerinde kullanmak üzere yapılandırıp dağıtırken aşağıdakileri kullanın.
Sık kullanılan uzantı özellikleri
Aşağıdaki özellikler her uzantı için mevcuttur.
Mülk | Açıklama | Varsayılan | Zorunlu |
---|---|---|---|
name |
Uzantının bu yapılandırmasını verdiğiniz ad. | Yok | Evet |
packageName |
Apigee Edge'in sağladığı uzantı paketinin adı. | Yok | Evet |
version |
Uzantıyı yapılandırdığınız uzantı paketinin sürüm numarası. | Yok | Evet |
configuration |
Eklediğiniz uzantıya özgü yapılandırma değeri. Bu uzantı paketinin özellikleri başlıklı makaleyi inceleyin | Yok | Evet |
Bu uzantı paketinin özellikleri
Bu uzantıya özel aşağıdaki yapılandırma özelliklerinin değerlerini belirtin.
Özellik | Açıklama | Varsayılan | Zorunlu |
---|---|---|---|
projectId |
Günlüklerin oluşturulması gereken Google Cloud projesinin kimliği. | Yok | Evet |
credentials |
Apigee Edge konsoluna girildiğinde hizmet hesabı anahtar dosyanızın içeriği bu şekildedir. Management API aracılığıyla gönderildiğinde, hizmet hesabı anahtar dosyasından oluşturulan base64 kodlu bir değerdir. | Yok | Evet |