設定訊息記錄

本主題描述如何針對不同的案例設定訊息記錄。

啟用訊息記錄

Windows Communication Foundation (WCF) 預設不會記錄訊息。 若要啟動訊息記錄，您必須將追蹤接聽項加入至 System.ServiceModel.MessageLogging 追蹤來源，並在組態檔中設定 <messagelogging> 項目的屬性。

下列範例示範如何啟用記錄並指定其他選項。

<system.diagnostics>
  <sources>
    <source name="System.ServiceModel.MessageLogging">
      <listeners>
         <add name="messages"
              type="System.Diagnostics.XmlWriterTraceListener"
              initializeData="c:\logs\messages.svclog" />
        </listeners>
    </source>
  </sources>
</system.diagnostics>

<system.serviceModel>
  <diagnostics>
    <messageLogging
         logEntireMessage="true"
         logMalformedMessages="false"
         logMessagesAtServiceLevel="true"
         logMessagesAtTransportLevel="false"
         maxMessagesToLog="3000"
         maxSizeOfMessageToLog="2000"/>
  </diagnostics>
</system.serviceModel>

如需訊息記錄設定的詳細資訊，請參閱追蹤與訊息記錄的建議設定。

您可以使用 add 來指定所要使用之接聽項的名稱和型別。 在範例組態中，我們已將接聽項命名為 "messages"，並且加入標準 .NET Framework 追蹤接聽項 (System.Diagnostics.XmlWriterTraceListener) 做為要使用的型別。 如果您要使用 System.Diagnostics.XmlWriterTraceListener，就必須在組態檔中指定輸出檔案位置和名稱。 將 initializeData 設定為記錄檔的名稱，即可做到這點。 否則，系統會擲回例外狀況 (Exception)。 您也可以實作會將記錄發出到預設檔案的自訂接聽項。

在記錄層級和選項 (本頁面可能為英文) 一節中，對於記錄層級以及其他選項都有加以討論。

switchValue 的 source 屬性只對追蹤有效。 如果您依下面所示指定 switchValue的 System.ServiceModel.MessageLogging 屬性，該屬性並不會產生作用。

<source name="System.ServiceModel.MessageLogging" switchValue="Verbose">
</source>

如果想要停用追蹤來源，您就應該改成使用 logMessagesAtServiceLevel 項目的 logMalformedMessages、logMessagesAtTransportLevel 及 messageLogging 屬性。 您應該將所有這些屬性都設定為 false。 使用先前程式碼範例中的組態檔、透過組態編輯器 UI 介面，或是使用 WMI，都可以做到這點。 如需設定編輯器工具的詳細資訊，請參閱設定編輯器工具 (SvcConfigEditor.exe)。 如需 WMI 的詳細資訊，請參閱使用 Windows Management Instrumentation 進行診斷。

記錄層級和選項

對於傳入的訊息，系統會緊接在訊息形成之後、在訊息到達服務層級中的使用者程式碼之前，以及在偵測到格式錯誤的訊息時進行記錄。

對於傳出的訊息，系統會緊接在訊息離開使用者程式碼之後，以及在訊息傳送到網路上之前進行記錄。

WCF 會在服務和傳輸這兩個不同的層級上記錄訊息。 格式錯誤的訊息也會加以記錄。 三個分類彼此獨立，而且可以透過組態來個別啟動。

您可以設定 logMessagesAtServiceLevel 項目的 logMalformedMessages、logMessagesAtTransportLevel 及 messageLogging 屬性以控制記錄層級。

服務等級

記錄在這層的是即將進入 (進行接收時) 或離開 (進行傳送時) 使用者程式碼的訊息。 如果有定義篩選條件，就只會記錄符合篩選條件的訊息。 否則，便會記錄服務層級中的所有訊息。 基礎結構訊息 (交易、對等通道及安全性) 也會記錄在此層級，除了可信賴傳訊訊息以外。 若是已進行資料流處理的訊息，則只記錄標頭。 此外，安全訊息會以解密形式記錄在此層級。

傳輸層級

記錄在這層的是要送到網路上傳輸或是在傳輸後而要進行編碼或解碼的訊息。 如果有定義篩選條件，就只會記錄符合篩選條件的訊息。 否則，便會記錄傳輸層級中的所有訊息。 所有的基礎結構訊息都會記錄在這層，其中包括可信賴傳訊訊息。 若是已進行資料流處理的訊息，則只記錄標頭。 此外，安全訊息會以加密形式記錄在此層級，除了使用 HTTPS 一類的安全傳輸的情況以外。

格式錯誤層級

格式錯誤訊息是指 WCF 堆疊在任何處理階段所拒絕的訊息。 格式錯誤訊息會依現狀加以記錄：也就是若有加密，便會以加密形式記錄，並包含不正確的 XML 和其他格式。 maxSizeOfMessageToLog 定義了要以 CDATA 形式記錄之訊息的大小。 根據預設，maxSizeOfMessageToLog 會等於 256 K。 如需此屬性的詳細資訊，請參閱＜其他選項＞一節。

其他選項

除了記錄層級，使用者也可以指定下列選項：

• 記錄整個訊息 (logEntireMessage 屬性)：這個值會指定是否記錄整個訊息 (訊息標頭和本文)。 預設值為 false，表示只記錄標頭。 這項設定會影響到服務和傳輸訊息記錄層級。

• 要記錄的最大訊息數 (maxMessagesToLog 屬性)：這個值會指定所要記錄訊息的最大數目。 所有的訊息 (服務、傳輸及格式錯誤訊息) 都會計算到此配額內。 當抵達配額時，便會發出追蹤，而且不再記錄其他訊息。 預設值為 10000。

• 要記錄訊息的最大大小 (maxSizeOfMessageToLog 屬性)：這個值會指定所要記錄訊息的最大大小，以位元組為單位。 不記錄超過大小限制的訊息，而且也不針對該訊息執行任何其他活動。 這個設定會影響所有的追蹤層級。 如果有開啟 ServiceModel 追蹤，便會在第一個記錄點 (ServiceModelSend* 或 TransportReceive) 發出警告層級追蹤以通知使用者。 服務層級和傳輸層級等訊息的預設值是 256 K，而格式錯誤訊息的預設值是 4 K。

  警告

  經過計算以便與 maxSizeOfMessageToLog 比較的訊息大小，就是進行序列化之前在記憶體中的訊息大小。 這個大小可能不同於已記錄之訊息字串的實際長度，而且在許多情況下都會大於實際大小。 如此一來，訊息可能就不會加以記錄。 您可以將 maxSizeOfMessageToLog 屬性指定為超過預期訊息大小的 10%，這樣就可以解決這個情形。 此外，如果有記錄格式錯誤訊息，由訊息記錄應用的實際磁碟空間大小最多可為 maxSizeOfMessageToLog 所指定值的 5 倍。

如果組態檔中未定義追蹤接聽項，則無論指定的記錄層級為何，都不會產生記錄輸出。

包含本節所描述屬性的訊息記錄選項，可以在執行階段使用 Windows Management Instrumentation (WMI) 來加以變更。 若要執行此方法，請存取 AppDomainInfo 執行個體，該執行個體會公開下列布林值屬性：LogMessagesAtServiceLevel、LogMessagesAtTransportLevel 和 LogMalformedMessages。 因此，如果您為訊息記錄設定一個追蹤接聽項，但在組態中將這些選項設定為 false，那麼您可以在稍後應用程式執行時，將選項變更為 true。 這會在執行階段有效地啟用訊息記錄。 同樣地，如果您在設定檔中啟用訊息記錄，則您可以在執行階段使用 WMI 來停用訊息記錄。 如需詳細資訊，請參閱使用 Windows Management Instrumentation 進行診斷。

訊息記錄中的 source 欄位會指定要用哪種內容來記錄訊息：何時傳送/接收要求訊息、針對要求-回覆或單向要求、在服務模型或傳輸層，或是在發生格式錯誤訊息的情況下。

若為格式錯誤訊息，source 等於 Malformed。 否則，便依據內容將來源指定為下列值。

若為要求/回覆：

若為單向要求：

訊息篩選條件

訊息篩選條件會定義於 messageLogging 組態區段的 diagnostics 組態項目中。 訊息篩選條件會套用在服務和傳輸層級上。 當定義一個或多個篩選條件時，只會記錄符合至少其中一個篩選條件的訊息。 如果沒有定義篩選條件，所有訊息都會通過。

篩選條件支援完整的 XPath 語法，並依其出現在組態檔中的順序套用。 語法不正確的篩選條件會造成組態例外狀況。

篩選條件也提供使用 nodeQuota 屬性的安全性功能，該屬性會限制 XPath DOM 中的節點數目上限，而這些節點可加以檢查來比對篩選條件。

下列範例示範如何設定只記錄含有 SOAP 標頭區段之訊息的篩選條件。

<messageLogging logEntireMessage="true"
    logMalformedMessages="true"
    logMessagesAtServiceLevel="true"
    logMessagesAtTransportLevel="true"
    maxMessagesToLog="420">
    <filters>
        <add nodeQuota="10" xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
                 /soap:Envelope/soap:Header
        </add>
     </filters>
</messageLogging>

篩選條件無法套用至訊息的本文。 系統會從篩選條件的清單中移除嘗試操作訊息本文的篩選條件， 而且也會發出事件以表明此點。 例如，系統會從篩選資料表中移除下列篩選條件。

<add xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">/s:Envelope/s:Body[contains(text(), "Hello")]</add>

設定自訂接聽項

您也可以運用其他選項來設定自訂接聽項。 要在記錄之前從訊息中篩選應用程式特定的 PII 項目時，便可以使用自訂接聽項。 下列範例示範了自訂接聽項組態。

<system.diagnostics>
   <sources>
     <source name="System.ServiceModel.MessageLogging">
           <listeners>
             <add name="MyListener"
                    type="YourCustomListener"
                    initializeData="c:\logs\messages.svclog"
                    maxDiskSpace="1000"/>
           </listeners>
     </source>
   </sources>
</system.diagnostics>

請注意，type 屬性應該設定為此型別的限定組件名稱。

另請參閱

• <messageLogging>
• 訊息記錄
• 追蹤與訊息記錄的建議設定