SharePoint Agent logs for SharePoint Server requirements for Support
search cancel

SharePoint Agent logs for SharePoint Server requirements for Support

book

Article ID: 237891

calendar_today

Updated On:

Products

CA Single Sign On Agents (SiteMinder) CA Single Sign On Federation (SiteMinder) CA Single Sign On Secure Proxy Server (SiteMinder) SITEMINDER Protection for SharePoint Servers

Issue/Introduction


What logs files are needed for the support to trouble shoot SharePoint Agent logs for SharePointServer?

 

 

Environment

 

Resolution


Here are the log files needed for the support to trouble shoot SharePoint Agent logs for SharePointServer.

General Guidelines for Providing Log files to CA SiteMinder Security Support Cases

To determine root cause, CA SiteMinder Security Support typically needs a certain set of data to be collected.

Providing the information as described in the table below up front when the case is opened will expedite resolution.

The logs with full tracing (as opposed to partial tracing) provide the Support Engineer a great deal of insight into the state of the environment leading up to the error condition. More limited tracing or no logging is almost always insufficient.

CA SiteMinder Security Support certainly understands that most production environments are not set to full logging.

In these scenarios, CA SiteMinder Security Support will do its best to analyze the data provided however in many cases this may not provide enough information to determine the root cause of the issue and higher log levels will be requested. This document is only a baseline of data as some issues will require additional data collection which the Support Engineer will request as necessary.

 

| Problem Area                 | Log File(s)                 |
|------------------------------+-----------------------------|
| Agent for SharePoint Logging | server.log                  |
|                              | webagent.log                |
|                              | trace.log                   |
|                              | Httpclient.log              |
|                              | federation.log              |
|                              | federationtrace.log         |
|                              | claimswebservice.log        |
|                              | claimswebservicetrace.log   |
|                              | SPConnectionWizard.log      |

 

Important Note:

It's recommended to enable logging only for debugging. In a Production environment, enabling logging can cause performance degradation.

Claims Web Service Logging

The claimswebservice.log records events that take place in the WS layer in the Agent for SharePoint. This file can be found in the directory Agent-for-SharePoint_home/proxy-engine/logs. The logging configuration is done in the LoggerConfig.properties file.

The claims web service logging is disabled by default. Enable the claims web service logging by performing the following procedure in the LoggerConfig.properties file.

Follow these steps:

  1. Open the LoggerConfig.properties file. This file can be found in the directory Agent-for-SharePoint_home/Tomcat/webapps/ClaimsWS/WEB-INF/classes;
  2. Set the LoggingOn setting to Y;
  3. Accept the default name and location for the LogFileName setting, which points to the claimswebservice.log file.

Note: Restart the Agent for SharePoint when changing the LoggerConfig.properties file.   
   
Claims web service logging is now enabled.

HTTP Head tools

In order of preference for Support

  1. Fiddler2 (1):

    NOTE: be sure to activate the desencryption of the SSL connections in order to see them :
    Tools / Fiddler Option.. / HTTPS / Decrypt HTTPS traffic;

  2. Firefox (2).

HTTP Watch is not recommended as this is a licensed product that CA does not currently license.

Because of this the information that CA support can see when they use the free copy of this software is very limited.

 

Additional Information