Google Cloud Logging Uzantısı

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin.
bilgi

Sürüm 1.6.1

Cloud Logging günlüklerine giriş yazın.

Bu içerik, bu uzantıyı yapılandırmak ve kullanmak için referans sağlar.

Ön koşullar

Bu uzantıyı bir API proxy'sinden kullanmadan önce şunları yapmanız gerekir:

  1. IAM'de, uzantınızı Cloud Logging sisteminde temsil edecek proje üyesine Günlük Kaydı > Günlük Yazıcı rolünü atayın. Rol atama talimatları için Belirli kaynaklar için bir hizmet hesabına rol atama başlıklı makaleye bakın. Günlük kaydı rolleri hakkında daha fazla bilgi için Erişim Denetimi Kılavuzu'na bakın.

  2. Google Cloud Console'u kullanarak hizmet hesabı için bir anahtar oluşturun.

  3. Uzantıyı yapılandırma referansını kullanarak ekleyip yapılandırırken, elde edilen anahtar JSON dosyasının içeriğini kullanın.

Bu uzantı, PostClientFlow'da bulunan bir ExtensionDescription politikası tarafından çağrılmayı destekler. Bu uzantıyı bir PostClientFlow'dan çağırmak için ExtensionCallout politikasını kullanmak istiyorsanız kuruluşunuzda features.allowExtensionsInPostClientFlow işaretinin true olarak ayarlandığından emin olun.

  • Herkese Açık Bulut İçin Apigee Edge müşterisiyseniz features.allowExtensionsInPostClientFlow işaretinin kuruluşunuzda true olarak ayarlandığından emin olmak için Apigee Edge Destek Ekibi ile iletişime geçmeniz gerekir.

  • Private Cloud için Apigee Edge müşterisiyseniz features.allowExtensionsInPostClientFlow işaretini true olarak ayarlamak için Güncelleme kuruluş özelliklerini API'yi kullanın.

Cloud Logging hakkında

Cloud Logging, Google Cloud işlem paketinin bir parçasıdır. Günlük kayıtları için depolama alanı, Günlük Gezgini adı verilen bir kullanıcı arayüzü ve günlükleri programatik olarak yönetmenizi sağlayan bir API içerir. Cloud Logging ile günlük girişleri okuyup yazabilir, günlüklerinizi arayıp filtreleyebilir, 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 fazla bilgi için Cloud Logging belgelerine bakın.

Sana Özel

Aşağıdaki örnekler, ExtensionExtension politikası kullanılarak Cloud Logging uzantı işlemleri için desteğin nasıl yapılandırılacağını gösterir.

Genel günlük

Aşağıdaki politika, This is a test mesajını Cloud Global kaynağındaki example-log adlı bir günlüğe yazar. Gerçek kullanımda muhtemelen mesaj, değerini API proxy'sinde başka bir yerde ayarladığınız bir akış değişkeninde tutulur.

<?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ıyı yapılandırmak ve kullanmak için referans sağlar. Apigee konsolunu kullanarak uzantı yapılandırma adımları için Uzantı ekleme ve yapılandırma bölümüne bakın.

İş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 veriler ve giriş verilerinden oluşur. Günlük girişleri hakkında daha fazla bilgi için Giriş referansı bölümüne bakın. metadata mülkünün içeriği hakkında bilgi için Cloud Logging belgelerindeki LogEntry nesnesine bakın.

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: String

<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 Gerekli
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çenek için MonitoredResource sayfasına bakın.
JSON Yok Hayır
message Bu günlük girişinin değeri 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

İleti, günlüğe yazıldıysa None. Aksi takdirde, istek bir hata döndürür. Ayrıca Bir uzantıda hata ayıklama konusuna bakın.

Yapılandırma referansı

Bu uzantıyı API proxy'lerinde kullanmak üzere yapılandırırken ve 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 özgü aşağıdaki yapılandırma özellikleri için değerler belirtin.

Özellik Açıklama Varsayılan Gerekli
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 budur. Yönetim API'si aracılığıyla gönderildiğinde, hizmet hesabı anahtar dosyasından oluşturulan base64 kodlu bir değerdir. Yok Evet