MessageLogging politikası

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

Ne

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

Sana Özel

<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 politikayı PostClientFlow adlı özel bir akışta ProxyEndpoint yanıtına yerleştirmeyi değerlendirin. PostClientFlow, yanıt istekte bulunan istemciye gönderildikten sonra yürütülerek 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 yapılandırma referansı bölümüne bakın.

PostClientFlow, iki açıdan özeldir:

1. Yalnızca yanıt akışının bir parçası olarak yürütülür.
2. 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 yürütüleceği için MessageLogging politikalarını PostClientFlow'a yerleştirebilir ve her zaman yürütülecekleri garanti edebilirsiniz.

Aşağıdaki Trace görüntüsünde, DefaultFaultRule yürütüldükten sonra PostClientFlow'un parçası olarak yürütülen bir MessageLogging politikası gösterilmektedir:

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

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. Ayrıca isteğin veya yanıtın alındığı tarih ve saat, istekteki kullanıcı kimliği, isteğin gönderildiği kaynak IP adresi gibi değişkenleri içerecek şekilde günlük kaydını yapılandırabilirsiniz. Edge, eşzamansız olarak mesaj kaydeder. Yani API'nize, çağrıların engellenmesinden kaynaklanabilecek herhangi bir gecikme yaşanmaz.

MessageLogging politikası, günlüğe kaydedilen iletileri bellekteki bir arabelleğe yazar. Mesaj günlük kaydedici, arabellekteki mesajları okur ve ardından yapılandırdığınız hedefe yazar. Her hedefin kendi tamponu 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ğıdaki bilgileri içeren bir mesaj görebilirsiniz:

Log message size exceeded. Increase the max message size setting

Private Cloud 4.15.07 ve önceki sürümlerinde bu sorunla karşılaşırsanız message-logging.properties dosyasını bulun ve şu çözümü kullanı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 4.16.01 ve sonraki sürümler için /opt/apigee/customer/application/message-processor.properties dosyasında conf_message-logging_max.log.message.size.in.kb özelliğini ayarlayın ve İleti İşleyici'yi yeniden başlatın.

Not: Edge'deki yanıt mesajı değişkenleri, Hata Akışı'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. Bu nesneyi, hata olup olmadığına bakılmaksızın başlıklara ve yanıttaki diğer bilgilere ulaşmak için kullanabilirsiniz. Daha fazla bilgi ve bir örnek için Mesaj değişkenleri bölümüne bakın.

Private Cloud için Edge'de 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, DateFormat öğesi kullanılarak sistem günlüğü hedefleri için geçersiz kılınabilir. Bu şablonun davranışı, Java'nın SimpleDateFormat sınıfının dokümanlarında açıklanmıştır. Bu tanıma göre yyyy yerine 4 haneli yıl, MM yerine ise 2 haneli ay numarası getirilir. 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 İşleyici'deki conf_system_apigee.syslogger.dateFormat özelliğini 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 yıl şeklinde kısaltarak zaman damgası şu şekilde kaydedilir:

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

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

1. Bir düzenleyicide message-processor.properties dosyasını açın. Dosya mevcut değilse 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/impression/customer/application/message-processor.properties
5. Edge Mesaj İşleyici'yi yeniden başlatın:
   > /opt/Apigee/Apigee-service/bin/Apigee-service kenar-message-processoryeniden başlatma

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

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

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/

Varsayılan günlük konumunu, Mesaj İşleyiciler'de bulunan message-logging.properties dosyasındaki özellikleri değiştirerek değiştirebilirsiniz:

• bin_setenv_data_dir - Günlük dosyası depolama için kök yolunu ayarlar. Örneğin, bin_setenv_data_dir=/opt/apigee/var/log
• conf_message-logging_log.root.dir - 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 ayarlarsanız
  conf/message-logging.properties+log.root.dir=/opt/apigee/var/log/messages gibi mutlak bir yola ayarlarsanız mesaj günlükleri /opt/apigee/var/log/messages/messagelog/ konumunda depolanır.
  Mutlak yol, bin_setenv_data_dir ile karşılaştırıldığında önceliklidir.
  
  Varsayılan olarak yorumlandığı için özelliğe conf/message-logging.properties+log.root.dir olarak referans vermeniz gerektiğini unutmayın. Daha fazla bilgi için Şu anda yorum dışında bırakılmış bir jeton ayarlama bölümüne bakın.

Günlük dosyalarını düz bir dosya yapısında depolamak için tüm günlük dosyaları aynı dizine yerleştirmek istiyorsanız, message-logging.properties dosyasında conf/message-logging.properties+enable.flat.directory.structure özelliğini true olarak ayarlayın. Mesajlar, yukarıdaki özelliklerde belirtilen dizinde depolanır ve dosya adları {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}_{filename} biçiminde olur.

Bu özellikleri ayarlamak için:

1. Bir düzenleyicide message-processor.properties dosyasını açın. Dosya mevcut değilse 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/impression/customer/application/message-processor.properties
5. Edge bileşenini yeniden başlatın:
   > /opt/../..//Apigee-service/bin/Apigee-service Edge-message-processoryeniden başlatma

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

Varsayılan olarak mesaj günlükleri, mesaj işlemcilerinde aşağıdaki konumda bulunur:

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

Varsayılan günlük konumunu, mesaj işlemcilerindeki message-logging.properties dosyasında aşağıdaki özellikleri değiştirerek değiştirebilirsiniz:

• data.dir - Günlük dosyası depolama için kök yolunu ayarlar. Örneğin, data.dir=/opt/Apigee4/var/log
• log.root.dir - Bunu log.root.dir=custom/folder/ gibi göreli bir yol olarak ayarlarsanız yol data.dir konumuna eklenir.

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

Bunu log.root.dir=/opt/apigee4/var/log/messages gibi mutlak bir yola ayarlarsanız mesaj günlükleri /opt/impression4/var/log/messages/messagelog/ konumunda depolanır. log.root.dir dosyasındaki mutlak yol, data.dir konumuna göre önceliklidir.

Günlük dosyalarını düz bir dosya yapısında depolamak ve tüm günlük dosyalarının aynı dizine yerleştirilmesini sağlamak için Mesaj İşleyicileri'ndeki message-logging.properties dosyasında enable.flat.directory.structure özelliğini true olarak ayarlayın. Mesajlar, yukarıdaki özelliklerde belirtilen dizinde depolanır ve dosya adları {org}_{environment}_{api_proxy_name}_{revision}_{logging_policy_name}_{filename} biçiminde olur.

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

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

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

Message öğesinde defaultVariableValue özelliği ayarlanarak tüm çözülmemiş değişkenler için 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

MessageLogging politikası Splunk, Sumo Logic ve Loggly gibi üçüncü taraf günlük yönetimi hizmetlerine sistem günlüğü mesajları göndermenize olanak tanır. Bu hizmetlerden birine sistem günlüğü göndermek istiyorsanız hizmetin ana makinesini, bağlantı noktasını ve protokolünü yapılandırmak için ilgili hizmetin belgelerine bakın. Ardından, bu politikada Sistem Günlüğü öğesini uygun şekilde ayarlayın.

Üçüncü taraf günlük yönetimi yapılandırması için aşağıdaki belgelere bakı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 Logic
  • Şu Apigee Topluluğu yayınına da göz atın: https://community.become.com/questions/5226/setting-up-logging-with-sumo-logic- which-host-shou.html
  • Günlük kaydı hizmeti olarak Sumo Logic'i kullanma örneği 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 yapmak 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'yi kullanırken <FormatMessage>true</FormatMessage>, politikada <Syslog> öğesinin alt öğesi olarak zorunludur.
  Loggly'de ileti günlük kaydı hakkında daha fazla bilgi için şu Apigee Topluluk gönderisine de göz atın: https://community.apigee.com/content/kbentry/14798/log-messages-into-loggly.html

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanan hata kodları ile hata mesajları ve döndürülen hata mesajları ile Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Bu bilgiyi, hataları ele almak için hata kuralları geliştirip geliştirmediğinizi bilmeniz önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme bölümlerine bakın.

Çalışma zamanı hataları

Politika yürütüldüğünde bu hatalar ortaya çıkabilir.

Dağıtım hataları

Bu hatalar, bu politikayı içeren bir proxy dağıttığınızda ortaya çıkabilir.

Hata değişkenleri

Bu değişkenler, bir çalışma zamanı hatası oluştuğunda ayarlanır. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler bölümüne bakın.

Örnek hata yanıtı

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

Hata kuralı örneği

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