Google Stackdriver Logging Uzantısı

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri.
bilgi

Sürüm 1.2.1

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

  1. IAM'de Günlük kaydını atayın > Campaign Logging sistemindeki uzantınızı temsil edecek proje üyesine Günlük Yazıcı izni verir. 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.

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

  3. 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.

Cloud Logging hakkında

Stackdriver Logging, Google Cloud Platform'daki (GCP) ürün paketinin bir parçasıdır. Günlükler için depolama, Günlük Görüntüleyici adı verilen bir kullanıcı arayüzü ve günlükleri programatik olarak yönetmek için bir API içerir. Stackdriver Logging ile günlük girişlerini 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şler yazıyor.

Daha fazla bilgi için Stackdriver Logging belgelerine bakın.

Örnekler

Aşağıdaki örnekler, Uzantı Çağrı Politikası'nı kullanarak Stackdriver 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, "Bu bir testtir" mesajını yazar bir günlüğe kaydeder. Gerçek kullanımda muhtemelen mesaj, değerini API proxy'sinde başka bir yerde ayarladığınız bir akış değişkeninde yer alacaktır.

<?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ının yapılandırılması ve kullanılması için referans sağlamaktadır. Apigee konsolunu kullanarak uzantı yapılandırma adımları için Uzantı ekleme ve yapılandırma'ya 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 özelliğinin içeriği hakkında bilgi için Cloud 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: 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.
meta veri 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. Sıra
mesaj 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 yok değerini alır. 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
proje kimliği 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 bu şekildedir. Management API aracılığıyla gönderildiğinde, hizmet hesabı anahtar dosyasından oluşturulan base64 kodlu bir değerdir. Yok. Evet.