Google Stackdriver Logging Uzantısı

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

Sürüm 1.3.7

Stackdriver 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 Günlük Kaydı > Günlük Yazıcı ve Günlük Kaydı > Günlük Görüntüleyici rolünü, uzantınızı Stackdriver Logging sisteminde temsil edecek proje üyesine 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. GCP 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.

Stackdriver Logging hakkında

Stackdriver Logging, Google Cloud Platform'daki (GCP) Stackdriver ürün paketinin bir parçasıdır. Günlükler için depolama alanı, Günlük Görüntüleyici adlı bir kullanıcı arayüzü ve günlükleri programatik olarak yönetmenizi sağlayan bir API içerir. Stackdriver 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.

Bu uzantı şu anda günlüğe giriş yazıyor. Daha fazla bilgi için Stackdriver Logging belgelerine bakın.

Sana Özel

Aşağıdaki örneklerde, ExtensionCallout politikası aracılığıyla Stackdriver Logging uzantı işlemleri için desteğin nasıl yapılandırılacağı gösterilmektedir.

Genel günlük

Aşağıdaki politika, "This is a test" (Bu bir testtir) mesajını Stackdriver 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 bulabilirsiniz.

<?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>

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 Stackdriver günlük girişi yazar. Günlük girişleri, meta verilerden 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 Stackdriver Logging belgelerindeki LogEntry nesnesine bakın.

Söz dizimi

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-log-name-to-use",
  "metadata" : JSON-structured-metadata,
  "message" : "data-to-log-as-entry"
}]]></Input>

Örnek

<Action>log</Action>
<Input><![CDATA[{
  "logName" : "stackdriver-log-name-to-use",
  "metadata" : { "resource" : { "type" : "global" } },
  "message" : "data-to-log-as-entry"
}]]></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
mesaj Bu günlük girişinin değeri olarak kullanılacak veriler. Dize Yok. Evet.

Yanıt

İleti günlüğe yazıldıysa None (Yok) değerine sahip. 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 GCP projesinin kimliği. Yok. Evet.
giriş bilgileri 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.