MessageLogging politikası

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

Ne?

API çalışma zamanı ortamındaki sorunları tespit etmenin en iyi yollarından biri, mesajları günlüğe kaydetmektir. Özel mesajları günlüğe kaydetmek için API'nize bir MessageLogging politikası ekleyebilir ve yerel diske (yalnızca Private Cloud için Edge) veya syslog'a.

Örnekler

<MessageLogging name="LogToSyslog">
  <Syslog>
    <Message>[3f509b58 tag="{organization.name}.{apiproxy.name}.{environment.name}"] Weather request for WOEID {request.queryparam.w}.</Message>
    <Host>logs-01.loggly.com</Host>
    <Port>514</Port>
    <Protocol>TCP</Protocol>
    <FormatMessage>true</FormatMessage>
    <DateFormat>yyyy-MM-dd'T'HH:mm:ss.SSSZ</DateFormat>
  </Syslog>
  <logLevel>ALERT</logLevel>
</MessageLogging>

<MessageLogging name="LogToSyslog">
  <Syslog>
    <Message>[3f509b58 tag="{organization.name}.{apiproxy.name}.{environment.name}"] Weather request for WOEID {request.queryparam.w}.</Message>
    <Host>logs-01.loggly.com</Host>
    <Port>6514</Port>
    <Protocol>TCP</Protocol>
    <FormatMessage>true</FormatMessage>
    <SSLInfo>
        <Enabled>true</Enabled>
    </SSLInfo>
    <DateFormat>yyMMdd-HH:mm:ss.SSS</DateFormat>
  </Syslog>
  <logLevel>WARN</logLevel>
</MessageLogging>

<MessageLogging name="LogPolicy">
  <File>
    <Message>This is a test message. Message id : {request.header.messageid}</Message>
      <FileName>test.log</FileName>
      <FileRotationOptions rotateFileOnStartup="true">
        <FileRotationType>SIZE</FileRotationType>
        <MaxFileSizeInMB>10</MaxFileSizeInMB>
        <MaxFilesToRetain>10</MaxFilesToRetain>
      </FileRotationOptions>
  </File>
  <logLevel>ERROR</logLevel>
</MessageLogging>

<MessageLogging name="LogPolicy">
  <File>
    <Message>This is a test message. Message id : {request.header.messageid}</Message>
    <FileName>test.log</FileName>
    <FileRotationOptions rotateFileOnStartup="true">
      <FileRotationType>TIME</FileRotationType>
      <RotationFrequency unit="minute">10</RotationFrequency>
      <MaxFilesToRetain>10</MaxFilesToRetain>
    </FileRotationOptions>
  </File>
  <logLevel>ERROR</logLevel>
</MessageLogging>

<MessageLogging name="LogPolicy">
  <File>
    <Message>This is a test message. Message id : {request.header.messageid}</Message>
    <FileName>test.log</FileName>
    <FileRotationOptions rotateFileOnStartup="true">
      <FileRotationType>TIME_SIZE</FileRotationType>
      <MaxFileSizeInMB>10</MaxFileSizeInMB>
      <MaxFilesToRetain>10</MaxFilesToRetain>
      <RotationFrequency unit="minute">10</RotationFrequency>
    </FileRotationOptions>
  </File>
  <logLevel>ERROR</logLevel>
</MessageLogging>

<MessageLogging name="LogPolicy">
  <File>
  ....
  ....
  </File>
  <BufferMessage>true</BufferMessage>
</MessageLogging>

Öğe referansı

MessageLogging politika türünü yapılandırmak için aşağıdaki öğeleri kullanın.

<SSLInfo>
    <Enabled>true</Enabled>
</SSLInfo>

Şemalar

Kullanım notları

API proxy akışına bir MessageLogging politikası eklerken bunu PostClientFlow adlı özel bir akışta ProxyEndpoint yanıtı gösterilir. PostClientFlow, tüm metriklerin kullanılabilir olmasını sağlayan, istek sahibi müşteriye yanıt gönderildikten sonra günlük kaydı için. PostClientFlow'un kullanımıyla ilgili ayrıntılar için API proxy'si yapılandırma referansı başlıklı makaleye bakın.

PostClientFlow iki şekilde özeldir:

1. Bu işlem yalnızca yanıt akışının bir parçası olarak yürütüldü.
2. Bu, proxy hata durumuna girdikten sonra yürütülen tek akıştır.

Proxy'nin başarılı veya başarısız olmasına bakılmaksızın çalıştırıldığı için PostClientFlow'daki MessageLogging politikaları ve bunların her zaman yürütüldüğünden emin olun.

Aşağıdaki Trace görüntüsü, PostClientFlow, DefaultFaultRule çalıştırıldıktan sonra:

Bu örnekte, API Anahtarını Doğrulama politikası, geçersiz bir veri kaynağı nedeniyle hataya tuşuna basın.

Aşağıda, PostClientFlow'u içeren ProxyEndpoint tanımı gösterilmektedir:

<ProxyEndpoint name="default">
  ...
  <PostClientFlow>
    <Response>
      <Step>
        <Name>Message-Logging-1</Name>
      </Step>
    </Response>
  </PostClientFlow>
  ...
</ProxyEndpoint>

Edge, mesajları basit metin olarak günlüğe kaydeder. Günlük kaydını şu gibi değişkenleri içerecek şekilde yapılandırabilirsiniz: istek veya yanıtın alındığı tarih ve saat, istekteki kullanıcı kimliği isteğin gönderildiği kaynak IP adresi vb. Edge günlükleri mesajı eşzamansız olarak yapılır. Diğer bir deyişle, açıklama metinlerinin engellenmesinden kaynaklanabilecek herhangi bir gecikme ekleyin.

MessageLogging politikası, bellekteki günlüğe kaydedilen mesajları bir arabelleğe yazar. Mesaj günlük kaydı arabellekteki mesajları okur ve daha sonra, yapılandırdığınız hedefe yazar. Her biri hedefin kendi tamponu vardır.

Arabelleğe yazma hızı okuma hızının üzerine çıkarsa arabellek taşar ve başarısız olur. Bu durumda, günlükte şunları içeren bir mesaj bulabilirsiniz: dosya:

Log message size exceeded. Increase the max message size setting

Edge for Private Cloud 4.15.07 ve önceki sürümlerde bu sorunla karşılaşırsanız message-logging.properties dosyasını yükleyin ve şu çözümü kullanın:

max.log.message.size.in.kb özelliğini (varsayılan değer = 128 KB) message-logging.properties dosya

Edge for Private Cloud 4.16.01 ve sonraki sürümler için conf/message-logging.properties+max. log.message.size.in.kb özelliğini /opt/apigee/customer/application/message-processor.properties dosyasında ayarlayın ve İleti İşleyici'yi yeniden başlatın. Bu mülke başlangıçta varsayılan olarak yorum yapıldığını lütfen unutmayın.

Not: Yanıt mesajı değişkenleri Hata Akışı'nda kullanılamaz. Bu değişkenler önceki akış Hata Akışı ise PostClientFlow'da kullanılabilir. Yanıtı günlüğe kaydetmek istiyorsanız message nesnesini kullanın. Şunları yapabilirsiniz: yanıtta olsun veya olmasın başlıkları ve diğer bilgileri almak için bu nesneyi kullanın bir hataydı. Bkz. Mesaj değişkenleri inceleyin.

Günlük mesajı kontrol ediliyor Private Cloud için Edge'de zaman damgası

Varsayılan olarak tüm günlük mesajlarındaki zaman damgası şu biçimdedir:

yyyy-MM-dd'T'HH:mm:ss.SSSZ

Bu sistem genelindeki varsayılan, DateFormat öğesi. Bu şablonun davranışı şurada açıklanmıştır: Java'nın SimpleDateFormat sınıfı ile ilgili dokümanlara göz atın. Bu tanıma göre yyyy değiştirilir yıl 4 basamaklı bir yıl ise MM 2 basamaklı bir ay numarasıyla değiştirilir ve bu böyle devam eder. Yukarıdaki biçim, şu biçimde bir dizeyle sonuçlanabilir:

2022-09-28T22:38:11.721+0000

Şunu kullanabilirsiniz: conf_system_apigee.syslogger.dateFormat özelliğini kullanabilirsiniz. Örneğin, iletiyi değiştirmek biçimi şu şekildedir:

yy/MM/dd'T'HH:mm:ss.SSSZ

..tirelerin eğik çizgiyle değiştirilmesi ve yılı 2 basamaklı olarak kısaltmanız, biçimde bir zaman damgası kaydeder:

22/09/28T22:38:11.721+0000

Biçimi değiştirmek için:

1. message-processor.properties dosyasını yardımcı olur. Dosya mevcut değilse dosyayı oluşturun:
   > vi /opt/apigee/customer/application/message-processor.properties
2. Özellikleri istediğiniz gibi ayarlayın:
   conf_system_apigee.syslogger.dateFormat=yy/MM/dd'T'HH:mm:ss.SSSZ
3. Değişikliklerinizi kaydedin.
4. Özellikler dosyasının sahibi olarak 'Apigee' olduğundan emin olun kullanıcı:
   > chown Apigee:Apigee /opt/potansiyel/customer/application/message-processor.properties
5. Edge Message Processor'ı yeniden başlatın:
   > /opt/Apigee/Apigee-service/bin/gelir-hizmeti uç-mesajı işlemcisi yeniden başlatma

Private Cloud için Edge'de günlük dosya konumu

Private Cloud 4.16.01 ve sonraki sürümleri için Edge

Varsayılan olarak Private Cloud ileti günlükleri, Message İşlemci düğümleri:

/opt/apigee/var/log/edge-message-processor/messagelogging/org_name/environment/api_proxy_name/revision/logging_policy_name/

Message-logging.properties dosyasını İleti İşleyicilerde bulabilirsiniz:

• bin_setenv_data_dir - Günlük dosyası depolaması için kök yolu ayarlar. Örneğin, bin_setenv_data_dir=/opt/apigee/var/log.
• conf_message-logging_log.root.dir - Eğer bunu, conf/message-logging.properties+log.root.dir=custom/folder/, the path is appended to the bin_setenv_data_dir location.
  gibi göreli bir yola ayarlarsınız
  Bunu mutlak bir yol olarak ayarlarsanız, conf/message-logging.properties+log.root.dir=/opt/apigee/var/log/messages, mesaj günlükler /opt/apigee/var/log/messages/messagelog/ içinde depolanır. Mutlak yol bin_setenv_data_dir ürününe göre önceliklidir.
  .
  . Bu nedenle özelliğe conf/message-logging.properties+log.root.dir olarak başvurmanız gerektiğini unutmayın varsayılan olarak yorum dışındadır. Daha fazla bilgi için daha fazla bilgi için kullanılabilir.

Günlük dosyalarını düz bir dosya yapısında depolamak istiyorsanız, tüm günlük dosyalarının için aynı dizinde conf/message-logging.properties+enable.flat.directory.structure değerini true değerine ayarlayın. İletiler ve dosya adları şu biçimi alır: {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}_{filename}

Bu özellikleri ayarlamak için:

1. message-processor.properties dosyasını yardımcı olur. Dosya mevcut değilse dosyayı oluşturun:
   > vi /opt/apigee/customer/application/message-processor.properties
2. Özellikleri istediğiniz gibi ayarlayın:
   conf/message-logging.properties+log.root.dir=/opt/apigee/var/log/messages
3. Değişikliklerinizi kaydedin.
4. Özellikler dosyasının sahibi olarak 'Apigee' olduğundan emin olun kullanıcı:
   > chown Apigee:Apigee /opt/potansiyel/customer/application/message-processor.properties
5. Edge bileşenini yeniden başlatın:
   > /opt/Apigee/Apigee-service/bin/gelir-hizmeti uç-mesajı işlemcisi yeniden başlatma

Private Cloud 4.15.07 ve önceki sürümler için Edge

Varsayılan olarak, ileti günlükleri iletinin konumunda aşağıdaki konumdadır: işleyenler:

/opt/apigee4/var/log/apigee/message-processor/messagelog/{org}/{environment}/{api_proxy_name}/{revision}/{logging_policy_name}/

Message-logging.properties dosyasını kullanın:

• data.dir - Kökü ayarlar günlük dosyası depolama yoludur. Örneğin, data.dir=/opt/Apigee4/var/log
• log.root.dir - Bunu log.root.dir=custom/folder/ gibi göreli bir yola eklerseniz yol data.dir konumu.

Örneğin, iki özelliğin kombinasyonu, günlük kaydı dizinini /opt/Apigee4/var/log/custom/folder/messagelog/ (/messagelog dosyasının eklendiğine dikkat edin) otomatik olarak) sağlar.

Bunu log.root.dir=/opt/apigee4/var/log/messages gibi mutlak bir yol olarak ayarlarsanız, mesaj günlükleri /opt/Apigee4/var/log/messages/messagelog/ konumunda saklanacaktır. log.root.dir, data.dir'e göre önceliklidir.

Günlük dosyalarını düz bir dosya yapısında depolamak istiyorsanız, tüm günlük dosyalarının enable.flat.directory.structure özelliğini Message üzerindeki message-logging.properties dosyasında doğru İşlemciler. İletiler, yukarıdaki özellikler tarafından belirtilen dizinde depolanır ve adları {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}_{filename} biçimindedir.

Şuradaki değişkenler için varsayılan değerler: mesaj şablonu

İleti şablonundaki her değişken için varsayılan değerler ayrı ayrı belirtilebilir. Örneğin, request.header.id değişkeni çözümlenemezse değeri değiştirilir unknown değerine sahip.

<Message>This is a test message. id = {request.header.id:unknown}</Message>

Çözülmemiş tüm değişkenler için ortak bir varsayılan değer Message öğesindeki defaultVariableValue özelliği:

<Message defaultVariableValue="unknown">This is a test message. id = {request.header.id}</Message>

Üçüncü taraf günlük yönetimi hizmetlerini yapılandırma

MessageLogging politikası, sistem günlüğü mesajlarını üçüncü taraf günlük yönetimine göndermenize olanak tanır temel hizmetler arasındadır. Bunlardan birine sistem günlüğü göndermek isterseniz kullanıyorsanız, hizmetin ana makinesini, bağlantı noktasını ve protokolünü yapılandırmak için hizmetin dokümanlarına bakın Ardından, bu politikadaki Sistem günlüğü öğesini uygun şekilde ayarlayın.

Üçüncü taraf günlük yönetimi yapılandırması için aşağıdaki dokümanlara göz atın:

• Splunk (ürün sürümünü seçin)
  Şu Apigee Topluluğu gönderisine de göz atın: https://community.apigee.com/content/kbentry/13298/log-messages-into-splunk.html
• Sumo Mantık
  • Bu Apigee Topluluğu gönderisine de göz atın: https://community.apigee.com/questions/5226/setting-up-logging-with-sumo-logic-which-host-shou.html
  • Günlük kaydı hizmeti olarak Sumo Logic'in kullanıldığı tam bir örnek için aşağıdaki Apigee topluluk gönderisi. Çözüm, HTTP POST işlemi oluşturmak için tek bir JavaScript politikası kullanır Sumo Logic HTTP Kaynak Toplayıcısı'na gönderilen istekler: https://community.apigee.com/articles/32286/logging-to-sumo-logic-using-javascript-and-http.html
• Loggly
  Loggly kullanılırken <FormatMessage>true</FormatMessage> gereklidir politika, <Syslog> öğesinin alt öğesi olarak kullanılır.
  . Ayrıca, Loggly'de mesaj günlük kaydı hakkında daha fazla bilgi edinmek için bu Apigee Topluluk gönderisine bakabilirsiniz: https://community.apigee.com/content/kbentry/14798/log-messages-into-loggly.html

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde döndürülen hata kodları ve hata mesajlarının yanı sıra Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Hata kuralları geliştirirken bu bilgilerin farkında olmanız önemlidir. hoşuma gitmesi için bir fırsattır. Daha fazla bilgi için Bilmeniz gerekenler Politika hataları ve Kullanım sorun.

Çalışma zamanı hataları

Bu hatalar, politika yürütüldüğünde ortaya çıkabilir.

Dağıtım hataları

Bu politikayı içeren bir proxy dağıttığınızda bu hatalar oluşabilir.

Hata değişkenleri

Bu değişkenler, çalışma zamanı hatası oluştuğunda ayarlanır. Daha fazla bilgi için Bilmeniz gerekenler hakkında daha fazla bilgi edinin.

Örnek hata yanıtı

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.messagelogging.StepDefinitionExecutionFailed"
      },
      "faultstring":"Execution failed"
   }
}

Örnek hata kuralı

<FaultRule name="MessageLogging">
    <Step>
        <Name>ML-LogMessages</Name>
        <Condition>(fault.name Matches "StepDefinitionExecutionFailed") </Condition>
    </Step>
    <Condition>(messagelogging.ML-LogMessages.failed = true) </Condition>
</FaultRule>

Akış değişkenleri

Politika hatası durumunda aşağıdaki değişkenler doldurulur.

• messagelogging.failed
• messagelogging.{stepdefinition-name}.failed

İlgili konular

• Edge tarafından gösterilen değişkenler: Değişkenler referansı