Agent logs record the actions performed on a message by specific anti-spam agents in Microsoft Exchange Server 2013. Only the following agents can write information to the agent log:

• Connection Filtering agent
  
  
• Content Filter agent
  
  
• Edge Rules agent
  
  
• Recipient Filter agent
  
  
• Sender Filter agent
  
  
• Sender ID agent
  
  

Note:
The Connection Filtering agent and the Edge Rules agent aren't available on Mailbox servers.

The information written to the agent log depends on the agent, the SMTP event, and the action performed on the message.

You use the Set-TransportService cmdlet in the Exchange Management Shell to perform all agent log configuration tasks. The following options are available for the agent logs:

• Enable or disable agent logging. The default is enabled.
  
  
• Specify the location of the agent log files. The default value is %ExchangeInstallPath%TransportRoles\Logs\Hub\AgentLog.
  
  
• Specify a maximum size for the individual agent log files. The default size is 10 megabytes (MB).
  
  
• Specify a maximum size for the directory that contains agent log files. The default size is 250 MB.
  
  
• Specify a maximum age for the agent log files. The default age is 7 days.
  
  

Exchange uses circular logging to limit the agent logs based on file size and file age to help control the hard disk space used by the log files.

Contents

Overview of transport agents

Structure of the agent log files

Information written to the agent log

Search the agent logs

Agents can only act upon messages at specific points in the SMTP command sequence used to transport the messages through the Transport service on a Mailbox server or an Edge Transport server. These access points in the SMTP command sequence are called SMTP events. Each agent has a priority value that can be assigned. However, the SMTP events must always occur in a specific order. Therefore, the agent priority depends on the SMTP event. If two agents can act on a message during the same SMTP event, the agent that has the highest priority will act on the message first.

The following table lists the SMTP events in order of occurrence and the agents that write information to the agent log in order of priority from highest to lowest for each SMTP event.

SMTP events in order of occurrence and the agents that write information to the agent log in order of priority for each SMTP event

Note:
The Connection Filtering agent and the Edge Rules agent aren't available on Mailbox servers.

For more information about agents, SMTP events, and agent priority, see Transport Agents.

Return to top

The agent logs exist in %ExchangeInstallPath%TransportRoles\Logs\Hub\AgentLog.

The naming convention for the agent log files is AGENTLOGyyyymmdd-nnnn.log. The placeholders represent the following information:

• The placeholder yyyymmdd is the Coordinated Universal Time (UTC) date that the log file was created. The placeholder yyyy = year, mm = month, and dd = day.
  
  
• The placeholder nnnn is an instance number that starts at the value of 1 for each day.
  
  

Information is written to the log file until the file size reaches its maximum specified value, and a new log file that has an incremented instance number is opened. This process is repeated throughout the day. Circular logging deletes the oldest log files when the agent log directory reaches its maximum specified size, or when a log file reaches its maximum specified age.

The agent log files are text files that contain data in the comma-separated value file (CSV) format. Each agent log file has a header that contains the following information:

• #Software   Name of the software that created the agent log file. Typically, the value is Microsoft Exchange Server.
  
  
• #Version   Version number of the software that created the agent log file. Currently, the value is 15.0.0.0.
  
  
• #Log-Type   Log type value, which is Agent Log.
  
  
• #Date   UTC date-time when the log file was created. The UTC date-time is represented in the ISO 8601 date-time format: yyyy-mm-ddThh:mm:ss.fffZ, where yyyy = year, mm = month, dd = day, T indicates the beginning of the time component, hh = hour, mm = minute, ss = second, fff = fractions of a second, and Z signifies Zulu, which is another way to denote UTC.
  
  
• #Fields   Comma delimited field names used in the agent log files.
  
  

Return to top

The agent log stores each agent transaction on a single line in the log. The information stored on each line is organized by fields. These fields are separated by commas. The field name is generally descriptive enough to determine the type of information it contains. However, some of the fields may be blank. Or the type of information stored in the field may change based on the agent or the action performed on the message by the agent. The following table describes the fields used to classify each agent transaction.

Fields used to classify each agent transaction

Return to top

You can use the Get-AgentLog cmdlet and the Get-AntiSpamFilteringReport.ps1 script to search the agent logs.

The Get-AntiSpamFilteringReport.ps1 script is located in %ExchangeInstallPath%Scripts. You need to run the script in the Shell from the Scripts folder. To change your location in the Shell to the Scripts folder, run the following command:

	Copy Code
Cd $env:ExchangeInstallPath\Scripts

To run the script in the Scripts folder, use the following syntax:

	Copy Code
.\Get-AntiSpamFilteringReport.ps1 -report <ReportValue> [<OptionalParameters>]

For details about using the script, run the following command:

	Copy Code
Get-Help -Detailed .\Get-AntiSpamFilteringReport.ps1

Return to top