SharePoint (WSS or MOSS) have built-in usage reporting feature. Usage reporting is a service that enables site administrators, site collection administrators, and Shared Services Provider (SSP) administrators to monitor statistics about the use of their sites. Usage reporting also includes usage reporting for search queries that can be viewed by SSP administrators for search and site collection administrators.
Usage reporting is very useful for managing complex site hierarchies with many sites, a large number of page hits, and a large number of search queries, and it is recommended that the service be enabled for deployments of complex site hierarchies.
To configure usage reporting, a farm administrator must first enable Windows SharePoint Services usage logging for the farm that hosts the Web application containing the SSP. The SSP administrator enables and configures the usage reporting service. Then, site collection administrators can activate the 'reporting feature' to enable usage reports on the site collection.
After usage reporting is enabled, site administrators and site collection administrators can view site usage summary pages that have the following information for their sites and site collections (SpUsageSite.aspx):
SSP administrators for the search service can view a search usage reports page that tracks the following information (SpUsageSiteSearchQueries.aspx)
Site collection administrators for the SSP site can view a usage summary page that tracks the following information (usage.aspx)
Windows SharePoint Services (WSS) 3.0 provides the most basic of reports which are primarily text-based. Site collection administrators can also view a site usage report that includes monthly and daily page hit totals filtered by the following criteria
- Page - User - Operating system - Browser - Referrer URL
Enable Windows SharePoint Services Usage Logging
Enable Windows SharePoint Services usage logging for the farm hosting the Web application. Please refer the following steps to enable usage logging for the farm:
Enable Office SharePoint Usage Reporting
After Windows SharePoint Services usage logging is enabled in the server farm, SSP administrators must enable the Office SharePoint Usage Reporting service. SSP administrators can control the complexity of usage analysis processing, and select whether or not reporting is enabled for search queries. Please refer the following steps to enable portal usage reporting:
Note: If advanced usage analysis processing is not selected, usage reporting statistics will be minimal.
Reset Internet Information Server
Activate Office SharePoint Usage Reporting
After Office SharePoint Usage Reporting is enabled for the SSP, site collection administrators must activate the reporting feature. Until the reporting feature is activated on a site collection, usage reports are not available.
Please refer the following steps to activate the reporting feature:
Note: You must enable Office SharePoint Server Standard Site Collection Features for reporting to work.
How this data makes it back to DB, differs for WSS and MOSS
More Information
Whenever Usage Analysis is enabled, the Web Application Servers begin creating usage analysis logs in the ' <Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\Logs> ' path. There will be a separate folder named with a GUID that represents the web application. Within each of these folders will be a subfolder for each days logs which in turn contains usage logs in the format 01.log, 02.log etc. The usage analysis job runs against the data collected from the previous day(s) logs. For this reason running the Usage Analysis job more than once per day will not update usage data.
- On a high level, this is how the usage reports are generated
WSS 3.0 inserts an ampersand (&) between the top-level site URL and the sub site URL when it processes the log files. This marks the log file as "processed" and prevents data from being counted twice if the usage processing job is accidentally run again on the same day. If the connection is located in this file and has the ampersand (&), you will see it reflected in the usage data.
In MOSS, the two important timer jobs which are responsible for parsing, processing and updating the SSP DB (the ANL tables) are
‘Office SharePoint Usage Analytics Log Import’ and 'SharePoint Usage Analytics Log processing'.
These jobs run on each WFE in the farm on a daily basis to process the data in the shadow tables and write the final usage data into another set of tables like ANLHit.
‘Office SharePoint Usage Analytics Log Import’ job is responsible for parsing and populating the usage report data in the SSP DB’s analytics tables (that use the ANL prefix) and runs daily to pick up yesterday and only yesterday’s usage log files and parse them into the SSP table like 'ANLShadowHit' while 'SharePoint Usage Analytics Log Processing' job runs on hourly or minutely basis to process the data in the above shadow tables and write the final usage data into another set of tables like ANLHit.
The following categories are the most relevant for usage reports
Report pages
The http://_layouts/usageDetails.aspx even shows you the total hits for the documents which are very useful information.
Names of the application pages in the '_layouts' directory which show usage analysis data
All of these pages reside in the ‘_layouts’ folder of the site. Now, the information in the "Advanced" reports (SPUsageSite.aspx) isn't exactly the same as that in the basic WSS reports (usageDetails.aspx).
MOSS Usage Reports explained provides a very good insight into the kind the data for each parameter in the Site Collection Usage Summary page.
Mark Arend has written an excellent post with detailed descriptions of parameters displayed in MOSS 2007’s usage reports on the pages like SpUsageWeb.aspx (Site), SpUsageSite.aspx (Site Collection), SpUsageWebTopPages.aspx (Site), SpUsageSiteTopPages.aspx (Site Collection) and so on.
There are two report pages that are extremely useful, particularly for slightly smaller sites, that cannot be reached through the GUI interface in MOSS 2007. They are actually from the basic WSS system, and MOSS inexplicably misses out any direct reference though the administration pages.
In short, the data on the ‘usagedetails.aspx’ page is calculated for any hit (success or failure) to the location whereas the data in the ‘spUsageSite.aspx’ page shows the page which was accessed (and the number of times it was access in the Pie chart) FROM the site collection.
These are the definitions used by WSS and MOSS in summary usage reports (which are stored in the web metainfo):
How Usage Analysis works
All WFEs behave in the same way as long as the Windows SharePoint Web Services service is running on each WFE. HTTP data from each WFE is collected and stored locally on disk. The method and process by which this data is persisted on disk is described in Usage Event Logging in Windows SharePoint Services 3.0. This behavior is the same for all WFEs.
In WSS, a timer job called Usage Analysis, runs on each WFE and is responsible for parsing the usage log files and updating the information in the site’s content DB. In MOSS, a timer job called Office SharePoint Usage Analytics Log Import, runs on each WFE and is responsible for parsing the usage log files and uploading this data in the SSP DB (for SSP’s that have usage turned on, as per the instructions that you quote below)
If the connection is located in this file and has the ampersand (&) you will see it reflected in the usage data.
The default page for usage reporting has the most reporting parts; each part executes at least one stored procedure to retrieve its data. Each part is also found on other reporting pages.
Who can view these Reports
Site Collection Admins or users will Full Control permissions can view Site Collection and Site Usage Reports. So if you want other users to access these reports you can do the following:
You can also use a web part to display the links and above and audience targeting so only the users in the SharePoint group “Usage Report Viewers” see the web part.
FAQs (A few common questions regarding usage reports)
- The data is kept in two spots. One is on the file system where you specified the logs to be kept. The second is in the database. - The data is not discarded, it is still kept in the database and on the file system unless you attempt to remove it.
Here are the direct links to the SharePoint SDKs:
- WSS 3.0 : http://msdn.microsoft.com/en-us/library/ms441339.aspx - MOSS 2007: http://msdn.microsoft.com/en-us/library/ms550992.aspx
References
Very good articel Praveen. Helped me a lot to resolve a case.
Lovely article praveen...
Pretty detailed.
Hi Praveen,
Is this report able to track how much space (eg. due to uploading of files) used per user?
Best Regards,
William
Hi Praveen
Great article. Do these links only work for admin users or can other users (contributors, content editors, etc) also view the stats? So far as I have tested it only works for admin users.. Could there be a workaround to this?
Vanisha
hi Vanisha,
You are right about the pages being accessible to the administrators only. See
Configure usage reporting technet.microsoft.com/.../cc262541(v=office.12).aspx
I did not find any out-of-the-way to override this behavior.
William,
The information is limited to those described in
View usage summary for a site collection technet.microsoft.com/.../cc262808(v=office.12).aspx
however, you could create custom aspx pages / web service to pull the data required.
Vanisha,
Please see the 'Who can view these Reports' section
Is there a way to do analysis on how many times an faq in a list is viewed. If it is the most viewed for the day can that one be moved to the top of the list.
Thanks for making this so detailed, very helpful
This is very nice. i need another information,Please help on this. 1. No. of websites frequently accessed in the last 1 year, when was the last date each site was accessed 2. How many people have access to these sites (at each site level) 3. No. of people having full/editing access & no. of people having restricted access 4. Who is the listed owner for these sites ( contact information) 5. When did the last request come for modification (Ex: change from read to write access or vice-versa) of user access rights ( at each site level) Thanks,
is there any third party free tools to find the above report..
Really good information, it's provide step wise details regarding to SharePoint usages report and view the complete visibility of SharePoint server. I tried this SharePoint auditing tool (http://www.lepide.com/sharepoint-audit/ ) that allows to generate the comprehensive report on demand . This tool tracks all changes and get the instant alerts to inform who has performed what changes on the server, when, and at which SharePoint site.