Using the Detailed Auditing Policy
Learn how to enable detailed auditing of message size, bindings, and contracts.
Table of Contents
- Creating a Detailed Auditing Policy
- Detailed Auditing Policy: use case for Policy Manager
The Detailed Auditing Policy is an out-of-the-box policy that is part of the Policy Manager default installation. It is an instance of the Auditing Service Policy. It provides detailed auditing of messages and records the message metrics in the Monitoring > Logs tab as well as the messages of each exchange. The policy is located in the Policies folder of the Root Organization.
The following message metrics are recorded:
- Input Message: Audits Input Message content.
- Output Message: Audits Output Message content.
- Fault Message: Audits Fault Message content.
- Message Size: Audits the size of messages in the exchange.
- Binding: Audits binding information.
- Transport: Audits Transport information.
- Contract: Audits the contract governing a message.
The following identities are audited:
- Consumer: Audits consumer identity sent with a request message.
- End User: Audits end-user identity sent with a request message.
Creating a Detailed Auditing Policy
The first step in creating a policy is to define the basic policy information. Then, you can configure the policy details.
To add an operational policy
- Go to Workbench > Browse > Organization, and select Policies > Operational Policies. The Policies Summary is displayed.
- Click Add Policy.
- Choose the policy type and click Next.
- Specify a name (required) and description (optional) and click Finish. At the Completion Summary, Click Close. The Add Policy Wizard creates a draft policy instance that you can then configure on the Policy Details page.
For more information, see Add Policy.
Let's take a quick walkthrough of the Detailed Auditing Policy configuration process to get you started.
Step 1: Attach Policy
Go to the Policies folder in the Root Organization and attach it to a web service, operation, or binding that you would like to audit.
Step 2: Test Policy and View Monitoring Data
After you've attached the Detailed Auditing Policy to a web service, operation, or binding, send a request to your service and go to the Services > Monitoring section to view the results for Logs, Real Time Charts, and Historical Charts. For more information on using the monitoring functions, refer to the Policy Manager Online Help, available via the Help button.
Detailed Auditing Policy: use case for Policy Manager
This section includes the following usage scenario for the Detailed Auditing Policy:
Audit Entire Message and Message Metrics
Audit entire message and message metrics of each exchange in usage logs of Monitoring tab.
- Create a physical service in the Policy Manager Management Console using Create Physical Service.
- Provide service details and finish the wizard.
- Using Virtualize Service, virtualize and host the physical service on Network Director (ND1), and assign a name (for example, Vs1).
- Attach the Detailed Auditing Policy located in the Root Organization Policies folder to the Vs1 service in Service Details > Policy Attachments > Operational Policies.
- Send requests from the application/client to the Vs1 service.
- The details of the usage logs show the recorded information for each exchange.
The fields that are recorded in each exchange are:
- Message Size
- Input Message
- Output Message
- Fault Message
- Identities: Consumer/End-User