MessageLogging politikası

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

Ne?

API çalışma ortamı sorunlarını izlemenin en iyi yollarından biri, iletileri günlüğe kaydetmektir. Özel mesajları yerel bir diske (yalnızca Private Cloud için Edge) veya syslog'a kaydetmek için API'nize bir MessageLogging politikası ekleyip yapılandırabilirsiniz.

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

<FileName>/opt/apigee/var/log/messages/mylog.log</FileName>

<FileName>mylog.log</FileName>

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

Şemalar

Kullanım notları

Bir API proxy akışına MessageLogging politikası eklerken bunu ProxyEndpoint yanıtına, PostClientFlow adlı özel bir akışa yerleştirebilirsiniz. PostClientFlow, istek gönderen istemciye yanıt gönderildikten sonra yürütülür. Bu, tüm metriklerin günlük kaydı için kullanılabilir olmasını sağlar. PostClientFlow'u kullanmayla ilgili ayrıntılar için API proxy'si yapılandırma referansı başlıklı makaleyi inceleyin.

PostClientFlow iki açıdan özeldir:

1. Yalnızca yanıt akışı kapsamında yürütülür.
2. Proxy hata durumuna girdikten sonra yürütülen tek akıştır.

Proxy'nin başarılı olup olmadığından bağımsız olarak yürütüldüğü için PostClientFlow'a MessageLogging politikaları ekleyebilir ve her zaman yürütüleceklerini garanti edebilirsiniz.

Aşağıdaki izleme resminde, DefaultFaultRule çalıştıktan sonra PostClientFlow kapsamında yürütülen bir MessageLogging politikası gösterilmektedir:

Bu örnekte, geçersiz bir anahtar nedeniyle API Anahtarı Doğrulama Politikası hataya neden olmuştur.

PostClientFlow'u içeren ProxyEndpoint tanımı aşağıda gösterilmiştir:

<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üğe kaydetme işlemini, istek veya yanıtın alındığı tarih ve saat, istekteki kullanıcı kimliği, istemin gönderildiği kaynak IP adresi gibi değişkenleri içerecek şekilde yapılandırabilirsiniz. Edge, mesajları asenkron olarak kaydeder. Bu sayede, açıklama metinlerinin engellenmesinden kaynaklanabilecek gecikme API'nize eklenmez.

MessageLogging politikası, günlüklenen iletileri bellekte bir arabelleğe yazar. İleti günlüğü, arabellekten iletileri okur ve ardından yapılandırdığınız hedefe yazar. Her hedefin kendi arabelleği vardır.

Arabelleğe yazma hızı, okuma hızının üzerine çıkarsa arabellek taşar ve günlük kaydı başarısız olur. Bu durumda, günlük dosyasında aşağıdakileri içeren bir mesaj görebilirsiniz:

Log message size exceeded. Increase the max message size setting

Bu sorunla Private Cloud için Edge 4.15.07 ve önceki sürümlerde karşılaşırsanız message-logging.properties dosyasını bulun ve aşağıdaki çözümü uygulayın:

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

Private Cloud için Edge 4.16.01 ve sonraki sürümlerde /opt/apigee/customer/application/message-processor.properties dosyasında conf/message-logging.properties+max. log.message.size.in.kb mülkünü ayarlayın ve Mesaj İşlemcisi'ni yeniden başlatın. Bu özelliğin varsayılan olarak ilk başta yoruma alındığını lütfen unutmayın.

Not: Edge'deki yanıt mesajı değişkenleri Hata Akışları'nda kullanılamaz. Önceki akış Hata Akışı ise bu değişkenler PostClientFlow'da da kullanılamaz. PostClientFlow'dan gelen yanıt bilgilerini günlüğe kaydetmek istiyorsanız message nesnesini kullanın. Hata olup olmadığına bakılmaksızın yanıttaki üstbilgileri ve diğer bilgileri almak için bu nesneyi kullanabilirsiniz. Daha fazla bilgi ve örnek için Mesaj değişkenleri bölümüne bakın.

Edge for Private Cloud'da günlük mesajı zaman damgasını kontrol etme

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

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

Sistem genelindeki bu varsayılan ayar, DateFormat öğesi kullanılarak syslog hedefleri için geçersiz kılınabilir. Bu şablonun davranışı, Java'nın SimpleDateFormat sınıfıyla ilgili belgelerde açıklanmaktadır. Bu tanıma göre yyyy, 4 haneli bir yıl sayısıyla, MM ise 2 haneli bir ay sayısıyla değiştirilir. Yukarıdaki biçim, şu biçimde bir dizeyle sonuçlanabilir:

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

Bu biçimi kontrol etmek için Edge Mesaj İşleyicide conf_system_apigee.syslogger.dateFormat mülkünü kullanabilirsiniz. Örneğin, mesaj biçimini şu şekilde değiştirebilirsiniz:

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

..kısa çizgileri eğik çizgiyle değiştirip 2 haneli bir yıla kısaltarak şu 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ı bir düzenleyicide açın. 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 "apigee" kullanıcısına ait olduğundan emin olun:
   > chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
5. Edge Mesaj İşlemcisini yeniden başlatın:
   > /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

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

Edge for Private Cloud 4.16.01 ve sonraki sürümler

Varsayılan olarak Private Cloud mesaj günlükleri, Mesaj İşleyici düğümlerinde aşağıdaki dizinde bulunur:

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

Mesaj işleyicilerdeki message-logging.properties dosyasında özellikleri değiştirerek varsayılan günlük konumunu değiştirebilirsiniz:

• bin_setenv_data_dir: Günlük dosyası depolama alanının kök yolunu belirler. Örneğin, bin_setenv_data_dir=/opt/apigee/var/log
• conf_message-logging_log.root.dir: Bu parametreyi 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 ayarlarsanız
  
  Bu parametreyi conf/message-logging.properties+log.root.dir=/opt/apigee/var/log/messages gibi mutlak bir yola ayarlarsanız ileti günlükleri /opt/apigee/var/log/messages/messagelog/'de depolanır. Mutlak yol, bin_setenv_data_dir değerine göre önceliklidir.
  
  Varsayılan olarak yoruma alındığı için mülke conf/message-logging.properties+log.root.dir olarak referans vermeniz gerektiğini unutmayın. Daha fazla bilgi için Şu anda yorumlanmış bir jeton ayarlama başlıklı makaleyi inceleyin.

Günlük dosyalarını düz dosya yapısında depolamak istiyorsanız (tüm günlük dosyalarının aynı dizinde yer alması için) message-logging.properties dosyasında conf/message-logging.properties+enable.flat.directory.structure değerini true olarak ayarlayın. İletiler, yukarıdaki özelliklerle belirtilen dizinde saklanır ve dosya adları {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}_{filename} biçimindedir.

Bu özellikleri ayarlamak için:

1. message-processor.properties dosyasını bir düzenleyicide açın. 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 "apigee" kullanıcısına ait olduğundan emin olun:
   > chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
5. Edge bileşenini yeniden başlatın:
   > /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart

Edge for Private Cloud 4.15.07 ve önceki sürümler

Mesaj günlükleri varsayılan olarak mesaj işleyicilerde aşağıdaki konumda bulunur:

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

Mesaj işleyicilerdeki message-logging.properties dosyasında aşağıdaki özellikleri değiştirerek varsayılan günlük konumunu değiştirebilirsiniz:

• data.dir: Günlük dosyasının depolandığı kök yolunu belirler. Örneğin, data.dir=/opt/apigee4/var/log
• log.root.dir: Bu parametreyi log.root.dir=custom/folder/ gibi göreli bir yola ayarlarsanız yol, data.dir konumuna eklenir.

Örneğin, iki özelliğin birleşimi günlük kaydı dizinini /opt/apigee4/var/log/custom/folder/messagelog/ olarak ayarlar (/messagelog'un otomatik olarak eklendiğini unutmayın).

Bu değeri log.root.dir=/opt/apigee4/var/log/messages gibi mutlak bir yola ayarlarsanız mesaj günlükleri /opt/apigee4/var/log/messages/messagelog/ adresinde saklanır. log.root.dir içindeki mutlak bir yol, data.dir'e göre önceliklidir.

Günlük dosyalarını düz dosya yapısında depolamak istiyorsanız (tüm günlük dosyalarının aynı dizinde olması için) Mesaj İşleyicilerdeki message-logging.properties dosyasında enable.flat.directory.structure property değerini true olarak ayarlayın. Mesajlar, yukarıdaki özellikler tarafından belirtilen dizinde saklanır ve dosya adları {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}_{filename} biçimindedir.

Mesaj şablonundaki değişkenler için varsayılan değerler

Mesaj şablonundaki her değişken için ayrı ayrı varsayılan değerler belirtilebilir. Örneğin, request.header.id değişkeni çözülemezse değeri unknown değeriyle değiştirilir.

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

Çözümlenmemiş tüm değişkenler için Message öğesinde defaultVariableValue özelliği ayarlanarak ortak bir varsayılan değer belirtilebilir:

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

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

Mesaj Günlüğe Kaydetme politikası, Splunk, Sumo Logic ve Loggly gibi üçüncü taraf günlük yönetimi hizmetlerine syslog mesajları göndermenize olanak tanır. Bu hizmetlerden birine syslog göndermek istiyorsanız hizmetin ana makinesini, bağlantı noktasını ve protokolünü yapılandırmak için ilgili hizmetin dokümanlarına bakın, ardından bu politikadaki Syslog öğesini uygun şekilde ayarlayın.

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

• Splunk (ürün sürümünü seçin)
  Ayrıca şu Apigee Topluluk yayınını da inceleyin: https://community.apigee.com/content/kbentry/13298/log-messages-into-splunk.html
• Sumo Logic
  • Ayrıca şu Apigee Topluluğu yayınını da inceleyin: 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 Topluluğu yayınına bakın. Çözüm, Sumo Logic HTTP Kaynak Toplayıcı'ya HTTP POST istekleri göndermek için tek bir JavaScript politikası kullanır: https://community.apigee.com/articles/32286/logging-to-sumo-logic-using-javascript-and-http.html
• Loggly
  Loggly kullanılırken politikada <Syslog> öğesinin alt öğesi olarak <FormatMessage>true</FormatMessage> gereklidir.
  Loggly'ye mesaj kaydetme hakkında daha fazla bilgi için bu Apigee Topluluğu gönderisini de inceleyin: 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 başarısız olduğunda aşağıdaki değişkenler doldurulur.

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

İlgili konular

• Edge tarafından sunulan değişkenler: Değişkenler referansı