Site analysis example for the web content viewer

Site analysis example for the web content viewer

The site analysis log uses the NCSA Combined log format, which is a combination of NCSA Common log format and three additional fields: the referrer field, the user_agent field, and the cookie field. This example describes typical site analysis logging information for the web content viewer.

The IBM WebSphere Portal site analysis log is:
WP_PROFILE/logs/WebSphere_Portal/sa_date_time.log
where date_time is the date and time the file was created. The current (active) log file is named sa.log.
The WP SiteAnalyzerService might be configured to use different filenames.
The following example displays a sample entry in the site analysis log as it is written by the web content viewer if the SiteAnalyzerJSRPortletLogger is enabled.
9.37.3.88 - jdoe [22/Nov/2008:22:11:27 +0100] "GET /Portlet/5_8000CB1A00U6B02NVSPH1G20G1/Web_Content_Viewer_(JSR_286)/Web%20Content%2fTestSite01%2fTestSiteArea01%2fTestContent01?PortletPID=5_8000CB1A00U6B02NVSPH1G20G1&PortletMode=view&PortletState=normal&RequestType=render&PUBLIC_CONTEXT=%2fWeb%20Content%2fTestSite01 %2fTestSiteArea01%2fTestContent01 HTTP/1.1" 200 -1 "http://myserver.company.com/Page/ 6_8000CB1A00UR402F0JC25U1O25/MyPage" "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.18) Gecko/20081029 Firefox/2.0.0.18" "JSESSIONID=0000JwIm04xm7btVLwzCj9Qo-uj:-1"
The table describes each field of the log format:
Field in the Example Log Field Name and Explanation
9.37.3.88

host

The IP address of the HTTP client that sent the request.
Important: If there is a reverse proxy server between the client and the portal, the IP address logged is that of the reverse proxy server rather than the HTTP client. To log the IP address of the HTTP client, remove the reverse proxy server from the environment.

-

rcf931

The identifier used to identify the client making the request. If the client identifier is not known, the field is set to the hyphen character (-).

jdoe

username

The user ID for the client. If the user ID is not known, the field is set to the hyphen character (-).

[22/Nov/2008:22:11:27 +0100]

date:time timezone

The date and time of the HTTP request.
"GET /Portlet/[...] HTTP/1.1" 
request

The HTTP method, the URI of the requested resource, and the version of HTTP used by the client. The URI is composed of the following elements:

The identifier Portlet.

The ID of the web content viewer instance that is requested.

The administrative name of the web content viewer (Note: This name is always the same unless the portlet has been cloned.).

The context path of the rendered Web Content Manager item encoded in UTF-8.

A query string containing the following parameters:

PortletPID

The ID of the web content viewer instance that is requested.

PortletMode

The mode in which the portlet is rendered. Note that the web content viewer writes log entries only in its view mode.

PortletState

The portlet window state.

RequestType

The request type (note that the web content viewer writes log entries only for render requests).

This is followed by a list of all request parameters available to the web content viewer instance as UTF-8 encoded key-value-pairs.
200

statuscode

The HTTP status code for the request.

-1

bytes

The number of bytes of data transferred from the client as part of the request. A value of -1 indicates that the number of bytes is unknown.

"http://myserver.company.com/Page/6_8000CB1A00UR402F0JC25U1O25/MyPage"

referrer

The referrer in case of portlet site analysis log entries identifies the portal page on which the web content viewer instance is rendered.

"Mozilla/5.0 [...]"

user_agent

The type of web browser used by the client.

"JSESSIONID=0000JwIm04xm7btVLwzCj9Qo-uj:-1"

cookies

The name and value of a cookie sent to the client browser as part of the request. If multiple cookies were sent, the list is delimited by the semicolon character.
Parent: Set up site analysis for the web content viewer
Related reference:
Understand the site analysis log

Field in the Example	Log Field Name and Explanation
9.37.3.88	host The IP address of the HTTP client that sent the request. Important: If there is a reverse proxy server between the client and the portal, the IP address logged is that of the reverse proxy server rather than the HTTP client. To log the IP address of the HTTP client, remove the reverse proxy server from the environment.
-	rcf931 The identifier used to identify the client making the request. If the client identifier is not known, the field is set to the hyphen character (-).
jdoe	username The user ID for the client. If the user ID is not known, the field is set to the hyphen character (-).
[22/Nov/2008:22:11:27 +0100]	date:time timezone The date and time of the HTTP request.
"GET /Portlet/[...] HTTP/1.1"	request The HTTP method, the URI of the requested resource, and the version of HTTP used by the client. The URI is composed of the following elements: The identifier Portlet. The ID of the web content viewer instance that is requested. The administrative name of the web content viewer (Note: This name is always the same unless the portlet has been cloned.). The context path of the rendered Web Content Manager item encoded in UTF-8. A query string containing the following parameters: PortletPID The ID of the web content viewer instance that is requested. PortletMode The mode in which the portlet is rendered. Note that the web content viewer writes log entries only in its view mode. PortletState The portlet window state. RequestType The request type (note that the web content viewer writes log entries only for render requests). This is followed by a list of all request parameters available to the web content viewer instance as UTF-8 encoded key-value-pairs.
200	statuscode The HTTP status code for the request.
-1	bytes The number of bytes of data transferred from the client as part of the request. A value of -1 indicates that the number of bytes is unknown.
"http://myserver.company.com/Page/6_8000CB1A00UR402F0JC25U1O25/MyPage"	referrer The referrer in case of portlet site analysis log entries identifies the portal page on which the web content viewer instance is rendered.
"Mozilla/5.0 [...]"	user_agent The type of web browser used by the client.
"JSESSIONID=0000JwIm04xm7btVLwzCj9Qo-uj:-1"	cookies The name and value of a cookie sent to the client browser as part of the request. If multiple cookies were sent, the list is delimited by the semicolon character.