|
Configuration Summary's configuration pages are accessed through a web browser, just as Summary's reports are. To configure Summary, simply launch your web browser and open up the main Summary page. You will see an icon of a wrench in the top right of your browser and a link called Configuration. Clicking on the icon or link will take you to the main configuration page. There are several configuration pages. They are: The Main Page and Sub-report Pages Main Page and Sub-report PagesSplit into Sub-reports - Pressing this button will create a new sub-report. If there were not previously any sub-reports defined this will result in two sub-reports. The first sub-report will inherit the configuration properties of the original report. You will be prompted to enter the configuration of the new sub-report. Each sub-report has an entirely separate set of reports that can be configured to display information about some portion of your log entries. This is normally used to provide separate reports for virtual domains or other divisions of the site's content. This button only appears when you don't have any subreports. Edit settings for Sub-report (#): - Clicking on this link will allow you to edit the settings for the given sub-report. These links only appear when there are already sub-reports defined. Add New Sub-report - Pressing this button will add an additional sub-report. You will be prompted to enter the configuration of the new sub-report. This button only appears when there are already sub-reports and there are fewer than three sub-reports in Summary, or fewer than 50 sub-reports in Summary Plus, or fewer than 100 sub-reports in Summary SP lite, or fewer than 1000 sub-reports in Summary SP. Registration Code - This is the place to enter your registration code. Your registration code will be e-mailed to you a few hours (or days if you didn't pay by credit card) after you register. See the section on Purchasing for more information. Enable incremental processing - Checking this option turns on incremental processing mode. In incremental processing mode Summary remembers log files it has seen before and does not need to read them again, they don't even need to be present. However log files must only be added in date order and many of the configuration settings are locked while in incremental processing mode. If you turn off incremental processing Summary will delete the internal database. Any log files that you want reports on will have to be processed again. This option is only available in Summary Plus, SP Lite, and SP. For more information on what configuration settings are locked and other implications click here. Base Directory - This setting is only available on Linux, Sun, and OS X Command Line. This sets the directory where Summary will look for its data files. This should be an absolute path name to the directory Summary is installed in. That directory will contain the Summary application as well as the config, data, logs, and reports directories. By default Summary looks in the "current directory" for these files. This field should normally be set to "./". If you need to be able to execute Summary when the current working directory is not set to the Summary directory then you will need to set this field. To do that you must run Summary with the current directory set to the directory where Summary is installed the first time. Then set this field to the correct absolute path name. After that Summary can be run with any directory as the current directory. Name required to access configuration This user name and password can also be used to access all reports and sub-reports. There are also separate name and password settings for each sub-report, see "Name required to access reports, Password required to access reports", below. If you have chosen to require a configuration name and password, then accessing the full list of sub-reports requires that same name and password, unless "Allow all access to sub-report list" is checked. If it is checked, any of the report name and passwords can be used to access the full list of subreports. In the rare occasion that you haven't entered a configuration name and password, but you have entered a report name and password, Summary will require the report name and password from the first sub-report to access configuration. If you forget your name or password, click here. Comments and questions to email address- The data you enter into this field will appear at the bottom of each report as an email link for "Questions or comments". For example, you could enter "bob@bob.com" and at the bottom of every report would be a click-able email link for users to send mail to that address. The default email address is "summary@summary.net".
Note: The following fields appear on the main configuration page unless you have defined sub-reports. When you have defined the following fields appear on the sub-report configuration page. Site descriptive name - This name will appear at the top of each report in the sub-reports. The site descriptive name is typically set to the domain name that the sub-report is reporting on, but you can put whatever text you want here. Disable this sub-report - When checked the sub-report is disabled, reports are not displayed and log entries are not processed. Attempts to view the reports will get an "Reports are disabled!" error mesage. Any log downloading configured in the sub-report will not happen. If you are using incremental mode, log entries processed while the sub-report is disabled are not counted, even when the sub-report is enabled again. This setting only appears in Summary SP Lite and SP. Preferred domain name - This should be the full domain name of the site that you are producing reports for. This name is used for making links to the pages at your site from inside of Summary's reports. It is also used as one of the domain names considered local, see Other local domain names below. It should be entered all lowercase. For example "summary.net". Name required to access reports If you forget your name or password, click here. Other local domain names - These names are used, along with the "Preferred domain name" above, to determine if a referrer is local or remote. If the domain of a referrer matches one of the names on this list it is considered local. You should enter all of the domain names that can be used to access your web site, including numeric IP addresses, except for the one you entered as the "Preferred domain name". These names should be entered all lowercase. For example;
Note: The following fields only appear on the sub-report configuration page. Identifier for use in report URLs - A name used in the URL to access this sub-report. This allows you to assign easy to remember names to the sub-reports instead of accessing them by number. Only letters, numbers, underscore, hyphen, period, and dollar sign are allowed in this field and it must not be longer than 60 characters. These names are used with a leading "~", ".", or "$" to identify the sub-report. For example, if Summary is running on a machine called "summary.net", on port 7000, and this field is set to "demo", the URL to access the current sub-report would be <http://summary.net:7000/~demo>. Send report to email address - A text version of the Overview will get mailed to this email address each time the logs are processed except that email will not be sent if log processing is initiated through the web interface. You can provide multiple email addresses in this field separated by commas. "Send email each processing run", on the Options configuration page, must be enabled for reports to be e-mailed. This option only appears in Summary Plus, SP Lite, and SP. Domains to include in this Sub-report - A log entry will only be included in the current subreport if it's domain name matches one of the names on this list. The domain name field may come from the log entry or from the name of the sub-folder within the Logs folder. Many log formats do not include the domain name. Use "*" alone to match any log entry. You might want to look at the Details:Domains report to see what domain names occur in your situation before configuring sub-reports. See the Virtual Domains chapter for more information on configuring sub-reports. Only available when there are sub-reports. Requests to include in this Sub-report - A log entry will only be included in the current sub-report if it's URI (file name) matches one of the patterns on this list. Requests are checked against this list after aliases, if any, are applied. You can use this field to configure a sub-report to report on any subset of the content at your site. "*" matches any string, "?" matches any single character, and lines starting with "-" are excluded instead of being included. The first pattern matched in the list is the one that is used. WebStar adds several folder names to the front of the request in the log entry, indicating which virtual domain that log entry is associated with. With WebSTAR logs, you can use this field to select a single virtual domain. You can use "*" alone to match any log entry. Another example, if your server is configured to redirect the "summary.net" domain to the "summary" folder, use "/summary/*" to select only requests in that folder. If you have "Lowercase request names" on in the Options configuration page, the request name will be matched against this list after it is lowercased. See the Virtual Domains chapter for more information on configuring sub-reports. Only available when there are sub-reports. Notes - A place for you to keep notes about the configuration. Summary does not interpret this field in any way. Only available when there are sub-reports.
DetailsIP address to serve on (blank is any) - Use this field to specify which local IP address to serve reports on. Leaving this field blank causes Summary to serve reports on all available IP addresses. This field must either be blank, or specify a numeric IP address associated with the machine Summary is running on. This is not necessarily the IP address of your website, it needs to be an IP address owned by the machine that Summary is running on. You only need to set this if you wish to prevent Summary from serving interactive reports on all of the IP addresses of the machine Summary is running on. Do not set this field unless you know what you are doing, if it set wrong it will disable Summary! Port to serve on (0-autoselect) - This is the TCP/IP port that Summary uses to serve configuration and report requests. A value of zero causes Summary to automatically select a free port from the list 9000, 8000, 7000, 6000, 80, and 9001, 8001, 7001, 6001, 9002, 8002, 7002, and 6002. The normal port for web servers is 80. The WebSTAR Proxy service defaults to port 8000. Other port numbers between 1 and 1023 are normally reserved for existing services. If you enter a port number and that port is not available, Summary will not be able to operate properly. If you need to set the port number before running Summary, you can add a line to the "summary.conf" file in the "Config" folder/directory that reads: ServerPort: 80 where 80 is replaced with the port number you want to use. On machines where there is also a web server running, it is important that you set this to some number other than 80. Remove first directory name - WebSTAR adds one or more folder names to the request that is logged when it is configured to support multiple virtual servers. Checking this option causes Summary to remove the first folder name from the request before entering it into the reports. Note that the request is modified after it is checked for filtering and checked against "Requests to include in this Sub-report". Remove two directory names - Checking this option causes Summary to remove the first two folder names from the request before entering it into the reports. This option can be combined with the previous option to remove a total of three folder names from each request. Remove four directory names - Checking this option causes Summary to remove the first four folder names from the request before entering it into the reports. This option can be combined with the previous two options to remove a total of up to seven folder names from each request. Column label for Goals column - If set, this value will get used as the column heading for the Goals column. You should keep the name fairly short to avoid messing up the column layout in the reports. This feature is only available in Summary SP Lite and SP. Requests to Count as the Goal - A list of requests to count as having reached the "goal". Visits are tracked to see if they make a request that appears on this list. Several reports show the percentage of visits for a given domain, search word, or search phrase that do so. The Custom:Goal report lists requests that match an entry on this list. Decide what your most valuable outcome is. For example, someone ordering your product. Find a URL which indicates that your goal/outcome has happened. For example, a request to "/thanksforyourorder.html". Put this request into this field. Now you can track for each referring domain, search word, and search phrase what percentage of your visitors reach the goal. In this example, what percentage order your product. Don't count goals that start a visit - Checking this option causes Summary to not count requests that start a visit as goals, even if they match Requests to Count as the Goal. Requests to count as Featured - A list of requests that will be counted as "Featured". Requests matching an entry in this list will appear in the Featured report. CGI Tokens to exclude - A list of CGI tokens which should not be included in the CGI Arguments report. The entire token is used for the match, so to exclude "name=value" you need to enter "name=*" here. This feature is only available in Summary SP Lite and SP. Prefix for local URLs - When set, this string is used as the start of URLs that link to content at your site. For example, if this field is set to "http://summary.net" and Summary is making a link to "/versions.html", the URL would be "http://summary.net/versions.html. If this field is not set Summary uses "http://" and the preferred domain name. This field allows you to include port numbers in the URL or to use protocols other than HTTP. Query tag to include in request - If a CGI argument name matches this string it will be included as part of the request. The specified query tag will still appear in the CGI Arguments report (unless you exclude it). This option is only available in Summary SP Lite and SP. For example, if a request to your site looks like "http://summary.net/content.cgi?look=bold&page=home&lang=en", and this field is set to "page" then Summary will log a request to "/content.cgi?page=home". This is useful with database driven sites, where the page being requested is secified by one of the CGI arguments. Local search tag - If a CGI argument matches this string it's associated value is used as a search phrase for a local search engine. For example, if a request made to your local search engine looks like "http://summary.net/search.cgi?term=log+analysis", then the search field needs to be set to "term". This option is only available in Summary Plus, SP Lite, and SP. Visit tracking tag - If a CGI argument matches this string, the value of the tag will be tracked for hits, goals, and value, see the Details:Tracking Tags report. "Include query string in requests" needs to be off for this to work. This setting is only available in Summary Plus, SP Lite, and SP. For example, if you have paid ads at Google and overture, and you want them to link to your home page, "http://summary.net/", you could set the URL your Google ads use to "http://summary.net/?src=google", and the URL your Overture ads use to "http://summary.net/?src=overture". Then you would set "Visit tracking tag" to "src", and then the Tracking tages report would report information on the visits that came in from Google and the visits that came in from Overture. Cookie token to use as session ID - If your session IDs are recorded in the logs as a cookie value, as opposed to being in their own field, then you should set this field to the name of the cookie that contains the session ID. For example if the session ID appears as "CFTOKEN=57140764", then you would set this field to "CFTOKEN". Available in Summary SP Lite and SP only. Leakage tracking page
FilteringAll of the filtering fields take a list of items to ignore. Any log entry which has a value that matches one of the entries in the corresponding list is filtered out, i.e. not used for processing at all. Items are compared to each entry in the list from top to bottom. The first match is the one that is used. Lowercase letters match either upper or lowercase, uppercase letters match only uppercase. You can use a "*" in an entry to match any string, or a "?" to match exactly one character. Be careful not to put extra whitespace at the end of an entry. For example, if you want to filter out all of your own hits then you might set "hosts (visitors) to ignore" to: 151.200.97.173 You can use a "*" to match any string. If you want to filter out everything in an entire folder you can use a "* to match anything that starts with the folder name. For example you could give: /summary/* to exclude any entries that start with "/summary/". Lines which start with a "+" indicate items which should be included, even if subsequent lines exclude them. For example you could give: +/summary/* to include only those entries that start with "/summary/". Filtering can be used for several purposes. You can include only a single page, which causes the time reports to tell you about access to that page over time. You can filter out specific robots, such as a checker that makes sure your site is up and running, that might distort the results. Domains (servers) to ignore - The domain name field may come from any of several places depending on how you have Summary configured. It typically indicates which virtual server a log entry is for. If you have logs covering more than one domain, for example, "myhomedomain.com" and "myworkdomain.com" you would set this field to "myworkdomain.com" to get a report that only included requests to "myhomedomain.com". Domain name fields may come from the name of a sub-folder inside Summary's logs folder. It could also come from any of several fields in a log entry. For example, the CS-HOST log field, which contains the domain name that a visitor used when accessing your site. It can also come from S-IP, the server's IP address. Hosts (visitors) to ignore - This pattern is matched against the host name as it appears in the log file. The host field is the domain name or the IP address of the client visiting your site. If DNS lookups are enabled, Summary may display a domain name for an entry that appears as an IP address in the log file. In that case, this pattern will only match on the IP address. For example, "151.200.97.173". In Summary SP Lite and SP only this field may be configured separately for each sub-report. When Summary is doing the DNS lookups for you it can sometimes be difficult to figure out what to put in this field since most of the reports will list the domain name and not the IP address. The Visitors: Visitors: Hosts with IP report can be used to discover the IP address associated with a specific host. It's often useful to block all of the machines on a particular sub-net. This can be done by replacing the last number in an IP address with a "*". For example, entering "151.200.97.*" will filter out all hosts on "151.200.97" sub-net. Requests/files to ignore - The request is the path name requested by the user. These are written as Unix style path names, i.e. "/summary/download.html". Filtering based on this field is checked before Aliases, if any, are applied. Visit initiating referrers to ignore - This is the referrer from the request that initiated the visit. This field will be the same for all subsequent requests during a single visit, regardless of their individual referrers. Normally this is the URL of an external site that has a link to your site, which was followed to start the visit. For example "http://www.infoseek.com/Topic/Macintosh_web_servers". In Summary SP Lite and SP only this field may be configured separately for each sub-report. Auth. users to ignore - This is the name entered by the user in response to a request for a user name/password by the browser. This field is typically blank unless this is a request to a restricted access portion of your site. In Summary SP Lite and SP only this field may be configured separately for each sub-report. Agents to ignore - The agent is the long identifying string provided by the web browser to indicate which version of which browser is making the request on behalf of the client. These strings vary quite a bit even within a single browser. For example "Mozilla/4.04 (Macintosh; I; PPC)". In Summary SP Lite and SP only this field may be configured separately for each sub-report. Cookies to ignore - The cookie string returned by the web browser along with the request. This is taken from the WebSTAR log token CS(COOKIE). This field is typically blank unless you have put cookies in your site. In Summary SP Lite and SP only this field may be configured separately for each sub-report. Status codes to ignore - This is the result, or status, code returned by the server in response to the request. For example, 200 indicates a successful request, while 404 means file not found. In Summary SP Lite and SP only, this field may be configured separately for each sub-report. Ignore known and likely robots - Filters out all requests that are not from a known browser. This filters out almost all robot activity. A few robots disguise themselves as known browsers and so can't be filtered, but that is comparatively rare. Ignore requests with no session ID - Filters out requests that don't contain a session ID. Most such requests will be from robots. Available is Summary SP Lite and SP only.
Time (Schedules, Ranges, Formats)When to process logs - There are several ways to specify when Summary should process log files.
Incremental every hour, regular on schedule - Process the logs incrementally every hour. At the regularly scheduled processing time, or any time the configuration changes, the logs will be processed non-incrementally. This allows you to get most of the advantages of incremental processing without locking the configuration. You will need to keep all of the log files you want reports for though. This setting is ignored if normal incremental processing is enabled. This option is only available in Summary Plus, SP Lite, and SP. Start processing on (MM/DD/YY) - Log entries before the date entered will not be processed. To include all log entries, leave this field blank. This field can be used in combination with either of the next two fields to set a range of dates to be processed. Log entries which are excluded because they fall before this date will be counted as filtered in the Program Status report. Stop processing after (MM/DD/YY) - Log entries after the date entered will not be processed. To include all log entries, leave this field blank. This field can be used in combination with the previous or next fields to set a range of dates to be processed. The global setting of this field is ignored in incremental processing mode, but sub-report specific settings do apply. Number of days to include (0 means all) - When used alone, Summary will only process requests back this many days from the date the logs are processed. When used with a "Start processing on" date, it limits processing to this many days starting at the start date. When used with a "Stop processing after" date, it limits processing to this many days before the stop date. If both a start date and a stop date are specified, this field is ignored. To include all log entries, leave this field at 0. The global setting of this field is ignored in incremental processing mode, but sub-report specific settings do apply. Number of idle minutes to end visit - A visit consists of a sequence of requests from the same host, with the same agent string, and with a gap of no more than this many minutes between requests. The default is 30 minutes which works well in most situations. Number of minutes to offset times in logs - This number of minutes are added to every date of every request. If your logs are kept in GMT and you want a report for the east coast of the US during daylight saving time (which is four hours before GMT) you would set this to -240. First day of the week - Specifies which day is to be the first day of the week. Weeks start at 12 AM on the day specified. Use DD/MM/YY for dates on output - When checked, causes Summary to use a common European date format (DD/MM/YY) for some dates in reports. The default is to use the US format (MM/DD/YY). Expect DD/MM/YY for dates in log - When checked, causes Summary to expect dates to be in a common European date format (DD/MM/YY) in log files in WebSTAR, Microsoft IIS, and MacHTTP log formats. The default is to expect US format (MM/DD/YY). Display time using a 24 hour clock (military time) - When checked, causes Summary to display time using a 24 hour clock, often used by the milirary, instead of using AM and PM. The default is to use a 12 hour clock with AM and PM. Using a 24 hour clock 6 PM is written as 1800.
OptionsDo DNS lookups - Web servers typically run more efficiently if DNS lookups are turned off. To allow Summary to report on domain names instead of just numeric IP addresses, check this box. DNS lookups may take quite some time during which you must maintain an active internet connection. If you want to run Summary while offline you should un-check this box. Process logs automatically at startup - Summary normally processes the log files automatically each time you start the application. If you have very large log files you might not want this to happen. Un-check this box to prevent Summary from processing logs on startup. Write reports as HTML files (best left off) - When checked, each processing run, Summary will output the Report Menu, Overview, and the first couple of pages of each of the other reports as static HTML files. This can take a very long time. Unless you really need these files you should leave this option turned off. You can manually trigger writing HTML files to disk on the Tools configuration page. This option is only present in Summary Plus, SP Lite, and SP. The number of pages written, for each report, is set with "Maximum # of static HTML pages to write per report". These files will be written to the "Reports" folder. If you have sub-reports, a separate folder will be created for each sub-report inside the Reports folder. These files can be read with a web browser even when Summary is not running and are suitable for uploading to a web server. You won't normally need to turn this option on unless you want to keep an archive of old reports or upload reports to another server. If you have many subreports or if "Maximum # of static HTML pages to write per report" is set to a high number, Summary will write thousands of files to your hard drive. This may take a long time and use a lot of disk space. In extreme cases you may not be able to access reports while this is taking place. Send e-mail each scheduled log processing - When enabled, Summary will e-mail a report at the end of each scheduled log processing. E-mail is not sent if Summary processes logs on startup or when processing is triggered through the web interface. Be sure to enter an email address on the main configuration page. This option is only present in Summary Plus, SP Lite, and SP. Lowercase request names - Some servers, particularly on Macintosh and Windows, ignore the case of the requests. Unix servers are normally case sensitive. Check this check box if you want Summary to ignore the capitalization of requests. Lowercase CGI name/value strings - Lowercases the CGI arguments, both names and values, before building the CGI Arguments report. Turn this option on if you want to ignore the capitalization of CGI arguement names and values. Write numbers as 1.234.567,89 - When checked, causes Summary to write numbers in a common European format where periods separate thousands and commas are used to indicate a decimal fraction. By default Summary uses the US format where commas separate thousands and periods indicate a decimal fraction. Always use folder name as domain name - When checked, Summary will use the sub-folder, in the Logs folder, name as the domain name. By default, Summary uses the domain name read from the log entry in preference to the sub-folder name. Always use sub-folder name as server name - When checked, Summary will use the sub-sub-folder, in the Logs folder, name as the physical server name. By default, Summary uses the physical server name read from the log entry in preference to the sub-sub-folder name. Include query string in requests - Include the portion of each request after a question mark as part of the request; instead of using it to create a list of CGI arguments. This will cause the query strings to appear in the content reports as part of the request. This is useful for CGI code that accesses a database of pages that you want reported in the request reports. Turning on this option may cause Summary to require a lot more memory, and will disable the CGI Arguments report and many of the Visitors:Browsers and Visitors:Computers reports. Treat "/x" as "/x/" if "/x/" occurs - Requests, that appear to be to a file, are combined with requests to a directory of the same name; if there is a request which treats that name as a directory, ie. it appears with a trailing slash at some point in the logs. This works around a problem where some servers treat an access without a trailing slash in the same way as the same access with a trailing slash. Don't check this item unless you know your server has this bug. Allow all access to sub-report list - If you turn this option on, anyone can view the entire list of sub-reports and also see detailed processing status messages. If you turn it off, the configuration name and password are required to access the full list of sub-reports or to see status messages. Show name/password limited sub-report lists - If you turn this option on, and someone is accessing Summary with a name/password that is valid for more than one sub-report, they will be offered a list of all the sub-reports that their name/password is valid for. If you turn this option off, or their name/password is only valid for one sub-report, they will be taken to the first sub-report their name/password is valid for. Anyone using the configuration name/password is always allowed to see the complete list of sub-reports. If "Allow all access to sub-report list" is on, it overrides this setting, allowing everyone to see the complete sub-report list. Combine proxy clusters into one host - Combines all of the hosts in each known proxy cluster into a single host. Proxy clusters are groups of machines that all send requests to a web server on behalf of a single user. Since visit recognition depends on all requests in the visit coming from a single host, this practice distorts visit counts. Turning on this option slows down processing slightly. This option is only available in Summary Plus, SP Lite, and SP. Use session IDs to determine visits - Use session IDs, read from the log entries, to determine visits. Session IDs must be present in the log entries or all requests will appear to be part of a single visit. Available is Summary SP Lite and SP only.
MemoryExpire hosts and failed requests - Choice of Never, Weekly, or Monthly. If you are processing more than 7 days of logs this option can save a dramatic amount of memory. Deletes hosts which haven't made any requests in the last week or month (31 days). It also deletes requests which only have errors and which have not been requested in the specified time. It also deletes referrers that have fewer than three hits and have not referred a visit within twice the specified time. This option can affect the Visitors: Countries and Visitors: Visitors: Domains Reports, causing the word (Unknown) to show higher numbers. Larger values of (Unknown) happen because the DNS lookups are done after log processing and the hosts are deleted before the DNS lookups can happen. Those particular reports depend on the DNS lookups. Expire req. and ref. if not hit every N days (0-don't) - Expires (removes from memory) requests and referrers that don't have at least one hit every N days. Set this field to zero to not expire anything. Expire words, phrases, paths, int. refers monthly - Expires (removes from memory) search words, search phrases, and internal referrers that have only one hit at the end of the each month. Create the CGI Arguments report - The CGI Arguments report can take a lot of memory and is only useful to some people. Check this box if you wish to get a report on CGI arguments passed, in requests, to your server. Create the Cookie Report - The Cookie Report can take a lot of memory. Most sites don't use cookies and some that do use a unique cookie every time. Attempting to track cookies, which are unique on each request, takes a huge amount of memory. Check this box if you want a report on cookies passed, in requests, to your server. Create by Source, by Dest, Bad Links reports - Creating these reports can take a lot of memory if there are a large number of unique requests. Uncheck this item to disable these reports and save memory. The complete list of reports affected by this setting are: Paths: By Source, Paths: By Destination, Paths: Paths, Paths: Images Loaded, Paths: Where Found, Problems: Bad Links, and Problems: Failed Referrers. Create the Search Phrase by Search Engine reports - The Search Phrases by Search Engine and Search Engines by Search Phrase reports can take alot of memory and are not always of interest. Check this box if you wish to create those reports, uncheck it to save memory. Pre-filter local referrers - Local referring pages are filtered and aliased in the same way as requests. Normally this is done after they are entered into the database, which is faster but takes more memory. If memory is an issue they can be filtered and aliased before being entered into the database. This is slower but can save significant amounts of memory in some situations. Pre-filtering is also required for paths to work correctly when the requests include query strings. Hit threshold for time history of requests - Sets the point at which Summary will start counting hits in the Daily, Weekly, and Monthly reports. Hits up to the threshold are not counted in those reports, hits above the threshold are counted. A higher number will save memory, particuarly if you have a very large number of unique requests. A lower number will show more detail, particuarly for requests that don't have very many hits. Set this to 0 if you are not worried about memory. Number of days to keep daily statistics on - This controls how many days before the most recently processed request, in all of the log files, appear in the Daily Report. Number of hours to keep hourly statistics on - This controls how many hours before the most recently processed request, in all of the log files, appear in the Hourly Report. High memory usage report to calculate - There are several reports which Summary will only calculate if they are enabled here. These reports can require very large amounts of memory to claculate, so they are disabled by default. These settings are only available in Summary Plus, SP Lite, and SP.
Request TypesThe extension of a request is the portion of the request after the last period character in the file name. Or, "(None)" if there is no period in the file name portion or the last character of the request is a period. Or, "/" if the request ends with a "/". Page file name extensions - These are the extensions you wish to have treated as requests for pages. Page requests appear in the Content: Pages report, the Visit: Entry and Visit: Exit Point reports, and are used for tracking paths through your site. Common page file name extensions include: "/", "html", "htm", "shtml", "sht", "txt", "asp", "php", "cfm", and "jsp". Graphics file name extensions - These are the extensions you wish to have treated as requests for graphics. Graphics requests appear in the Content: Graphics report and are ignored for the purpose of path tracking. Common graphics file name extensions include: "gif", "jpeg", "jpg", "jpe", "swf", "css", and "png". Some other files which aren't really graphics but are used as elements of a page should also listed here. For example, cascading stile sheets. Download file name extensions - These are the extensions you wish to be treated as downloads. Downloads appear in the Content: Downloads report and are also treated like pages for the purpose of path tracking. Common download file name extensions include: "exe", "bin", "sit", "hqx", "zip", "gz", "z", "Z", "uu", "uue", "tar","pdf", and "tgz". All other extensions are referred to as Others in Summary.
MiscellaneousNumber of lines on a report page - This is the number of items that can be displayed on a single page of a report. A few reports, such as the Paths: Paths report, use one fifth of this number, and reports which contain an "Over Time" mini-graph use one third of this number. You must enter a number between five and one hundred twenty. More lines on a page make the reports take longer to load and display in the browser, but increases the amount of information that can be viewed without going to the next page. Names that "/" defaults to - When the user makes a request ending in "/", the web server will look for a file with some special name or any of several special names and serve that file instead of doing a directory listing or getting an error. The exact set of file names depends on how you have configured your server, but commonly includes "index.html" or "default.html". Enter the same set of names your server is configured to use here. This allows requests to "/" and to "/index.html" to be counted together as requests to "/". SMTP server name - The full domain name of an outgoing e-mail (SMTP) server. If this field is left blank, on the Macintosh Summary will attempt to get the name of an SMTP server from Internet Config; under Windows Summary will use a MAPI mail server if present; and on Sun and Linux Summary will use the SMTP server on the local machine. Maximum # of static HTML pages to write per report - Sets the maximum number of pages, per report, that can get written as static HTML files. The default is one. Note that setting this to a high number can take very large amounts of disk space, and slow processing and your computer down substantially. This setting is only available in Summary Plus, SP Lite, and SP. Number of levels of directories to display - Specifies how many levels of directory information should be shown in the Content: By Directory Report. Currency Symbol - The symbol that will appear in front of "Value" in the value column heading. The default value is $. The field is limited to 10 characters. Slow down DNS lookups by (0-full speed) - In some situations DNS lookups can happen so quickly that your network connection or DNS server gets overloaded. By entering a non-zero number here you can slow down the DNS lookup process. 0 is full speed, 1 is a very slight slow down, higher numbers are slower. If you are having problems with DNS lookups you might try setting this to 6 to start and adjusting from there. Number for at least N hits/goals filters - The number of hits/goals to use, instead of five, for the "Five or More Hits" and "At Least Five Goals" filters. This feature is only available in Summary SP Lite and SP. Tokens to include in the CGI Arg. Report - Only query string token names that match this pattern will be included in the CGI Arguments report. Use a single "*" to include all CGI arguments. The entire token is used for the match, so to include "name=value" you need to enter "name=*" here. User log format definition - This is a string of tokens that explains to Summary how to parse the log file. Summary will parse most log files automatically, and this field can normally be left blank. See the chapter on log file formats to find out what you should enter here to deal with special log file formats. You can enter up to four custom formats seperated by newline characters.
Log DownloadingThere is one global "Log Downloading" configuration page. In Summary Plus, SP Lite, and SP there is also a Log Downloading configuration page for each sub-report. There is no specific relationship between the sub-report and the log that is downloaded. If you need to download additional log files you can create extra sub-reports, that don't report on anything, just to do the downloading. Summary supports log downloading using the HTTP and FTP protocols. The Linux, Sun, and OSX Command Line versions of Summary also support SFTP (secure FTP). For SFTP downloading to work you must have ssh version 2 or newer installed on your machine and you need to have configured ssh so that you can log into the remote system without manually entering any password information. Log downloading is incrimental when supported by the remote server. That is, Summary attempts to not redownload logs that it already has copies of. Summary can also detect that logs have grown in size and only download the new portions of the log file. Enable log downloading - This check box enables or disables all log downloading. URL to download log from - Enter the URL where your log file is located. This should be in the same format as you would use in a web browser, for example "http://summary.net/download/logfile.log". FTP URLs are normally relative to your home directory. If you want to use an absolute path you should add an extra "/" after the domain name. For example "ftp://summary.net//server/log/access_log". You can enter an FTP URL that includes a "*" character in the file name portion in order to download multiple files. For example "ftp://summary.net/logs/access*". Name required to access download Store downloads in sub-folder named - Enter the name of a folder the downloaded log files should be put in, inside the Logs folder. This field can be left blank to put downloaded logs directly into the Logs folder. Store downloads in sub-sub-folder named - Enter the name of a folder the downloaded log files should be put in, inside the sub-folder configured above, inside the Logs folder. This field can be left blank to put downloaded logs directly into the sub-folder configured above. This field is ignored if "Store downloads in sub-folder named" is blank. Use passive FTP (best for most firewalls) - When checked Summary uses passive mode for all FTP transfers. Passive mode is the default, and is generally more likely to work with firewalls. When not checked Summary uses active mode for all FTP transfers. Active mode is required by a few FTP servers.
AliasesThis feature is only available in Summary Plus, SP Lite, and SP. Aliases allows you to modify requests that appear in the log file before Summary processes them. Aliases are applied after requests are filtered by "Requests/files to ignore" and before "Requests to include in this Sub-report" is checked. This page displays the list of aliases that you currently have defined and allows you to edit or delete an item that is already on the list or add a new item to the list. To define a new alias click on "Add Item". To modify or delete an existing alias click on the "Edit" link next to the item you want to modify. Aliases are most useful when dealing with servers that add coded data into the URL such as WebObjects. You can write an alias that removes the encoded data so that requests don't all appear to be unique. This will save a lot of memory and help in making your reports more meaningful. For example, if you have a request that look something like this: /WebObjects/store.woa/10/wo/U6jOM13TkVKcM5coy4/0.4.15.0.8.0.0 You could use the following alias in the "Request Pattern to Match" field: '/WebObjects/store\.woa/10/wo/[`\/]*/0\.4\.15\.0\.8\.0\.0 Then you would put the following in the "Replace With" field: /WebObjects/store.woa/10/wo/smallsilverwidgit.html Once you have entered the alias You will see: '/WebObjects/store\.woa/10/wo/[`\/]*/0\.4\.15\.0\.8\.0\.0 -> /WebObjects/store.woa/10/wo/smallsilverwidgit.html Which will result in: /WebObjects/store.woa/10/wo/smallsilverwidgit.html Request pattern to match - Requests which match this pattern are replaced with the contents of the next field. Patterns can contain a "*" to match any sequence of characters or a "?" which matches exactly one character. Lower case letters match either upper or lower case but upper case letters only match upper case letters. Alternatively, you can start a pattern with a single quote and the remainder of the pattern is interpreted as a regular expression which is matched against the request. Summary uses Perl style regular expressions. Aliases are applied in the order that they appear, and each alias that matches is applied in turn. This feature is only available in Summary Plus, SP Lite, and SP. Replace with - Requests which match the corresponding pattern are replaced with the contents of this field. You can use a "*" to insert whatever string was matched by the corresponding "*" from the original request. You can also use $1, $2, $3, etc. to insert a string matched by the 1st, 2nd, 3rd, etc. "*" from the original request. This feature is only available in Summary Plus, SP Lite, and SP. Test string - Whatever is entered into this string is used as a test case for the aliases. The result of aliasing this string, using the current alias rules, is shown just below the text entry box. This feature is only available in Summary Plus, SP Lite, and SP.
Groups/ValueThe Groups configuration page only appears in Summary Plus, SP Lite, and SP. It is not available in regular copies of Summary. Content groups are used to produce the Content: By Group report and to calculate the value of visits associated with each time period, referring domain, search phrase and search word. See here for more information about value calculations. Don't value possible robots - When checked, Summary will value all visits that request "/robots.txt" at zero. Most web robots will access the "/robots.txt" file. Since web robots don't generally purchase your products you don't normally want to count values for their visits. Available in Summary Plus, SP Lite, and SP only. Value of each page view - The value to assign to each request for a page. If you want to value long visits higher than short visits you should assign a value here. If a visitor makes 500 hits on a single content group the value of that content group is only added once. This is because content groups only check to see if there were any hits in the content group and ignore how many hits there were over the entire duration of the visit. Available in Summary Plus, SP Lite, and SP only. Group N name - The name of the content group. This name will appear in the Content:by Group report. There are six content groups. Available in Summary Plus, SP Lite, and SP only. Group value - The value to assign to visits that access any request in this content group. Values always have 2 digits to the right of the decimal point. Available in Summary Plus, SP Lite, and SP only. Requests to include - Any request matching a pattern in this list is included in this content group. Available in Summary Plus, SP Lite, and SP only.
Report Filters
Name for filter one
User filter one
Customize HTMLThe Custom HTML configuration page only appears in Summary Plus, SP Lite, and SP. It is not available in regular copies of Summary. Only Summary SP Lite and SP allows you to replace the custom header and footer and the Summary logo. In Summary SP Lite and SP only these fields can be configured globally and on each sub-report. If any of the custom HTML fields are set on the sub-report, the sub-report will use that value but if the sub-report setting is blank it will use the global setting. Page background color - The color to use for the general page background color. This is an HTML color name, typically written with six hexadecimal digits, in the form "#RRGGBB". The default color is white "#FFFFFF". Available in Summary Plus, SP Lite, and SP only. Column heading color - The color to be used as the background of the column headings. This is an HTML color name, typically written with six hexadecimal digits, in the form "#RRGGBB". The default color is light blue "#CCCCFF". Summary Plus, SP Lite, and SP only. Date heading color - The color to be used as the background of the date range heading. This is an HTML color name, typically written with six hexadecimal digits, in the form "#RRGGBB". The default color is medium light green "#DDEEDD". Available in Summary Plus, SP Lite, and SP only. Date heading text color - The color to be used as the text color in the date heading. This is an HTML color name, typically written with six hexadecimal digits, in the form "#RRGGBB". The default color is dark green "#006600". Available in Summary Plus, SP Lite, and SP only. Alternate line color - The color to be used as the background of the even numbered lines of the reports. This is an HTML color name, typically written with six hexadecimal digits, in the form "#RRGGBB". The default color is pale blue "#EEEEFF". Available in Summary Plus, SP Lite, and SP only. Custom HTML title - HTML code that will be inserted below the Summary logo and above the page contents. You can use this, for example, to insert your company logo. There is a limit of 4K of text for the custom title and 6K for the title, logo, header, and footer combined. Available in Summary Plus, SP Lite, and SP only. Custom logo HTML - HTML code to use for the logo at the top left of the page. Whatever you enter here will replace the Summary logo. Leave this field blank to use the default Summary logo. You can get the same effect by supplying a custom HTML header, but it's simpler to use this field if all you want to do is replace the logo. There is a limit of 4K of text for the custom logo HTML and 6K for the title, logo, header, and footer combined. Available in Summary SP Lite and SP only. Custom HTML header - HTML code to use at the top of the page. Leave blank to use the default headings. The HTML code should include <HTML>, <HEAD>, <TITLE>, and <BODY> tags. See below for an example of what to put in this field and for a list of the special commands that can be used to insert program related information. There is a limit of 4K of text for the custom header and 6K for the title, logo, header, and footer combined. Available in Summary SP Lite and SP only. Custom HTML footer - HTML code to use at the bottom of the page. Leave blank to use the default footer. The HTML code should include </BODY> and </HTML> tags. See below for an example of what to put in this field and for a list of the special commands that can be used to insert program related information. There is a limit of 4K of text for the custom footer and 6K for the title, logo, header, and footer combined. Available in Summary SP Lite and SP only. You must take care to enter valid HTML. All Summary pages will use the title, logo, header, and footer that you supply. If your HTML code is sufficiently wrong you may not be able to access the configuration page to set them back. In that case you should edit the URL that appears in the location bar in your browser so that it ends with "/config?:fix". That will allow you to access the configuration pages with the default header and footer so that you can repair the incorrect HTML. If you want to include your own art, it is simplest to use an absolute URL to images on another server. The images that are available through the "%%%art" command are built directly into the program. They can be overridden in Summary SP Lite and SP, see below, but that is more complex to get that working than simply using an absolute URL to art on another server. In Summary SP Lite and SP only, you can override the built-in art. This should only be done if you are expert in HTML and image editing. There are various pieces of art Summary uses on it's pages such as the help icon (big question mark) in the upper right corner of the reports section. Normally, the existing art is very flexible and doesn't need to be replaced, but in some circumstances, particularly if you are changing the background color to a dark color, you may want to replace the art as well. To replace the art you need to create a folder called "userart" in the same location as the Summary application. When Summary starts up it looks at all the files in that folder, reads them into memory, and uses them in preference to the built-in art. Note that Summary only reads the art when it starts up. If you change the contents of the "userart" folder you will need to quit Summary and start it up again for your changes to be registered. Summary assumes that particular pieces of art have specific image heights and widths. When making replacement art, be careful to keep your image the same dimensions as the original. There are several special tokens that you can use in the custom HTML to access various Summary SP Lite and SPecific capabilities. All of the special tokens are prefixed with "%%%".
Here is the default HTML code for the header:
Here is the default HTML code for the footer:
Customize Main PageThe "Custom Main Page" configuration page only appears in Summary Plus, SP Lite, and SP. It is not available in regular copies of Summary. Redirect the main page to the Report Menu - Causes access to the main page to be redirected to the Report Menu. This feature is only available in Summary Plus, SP Lite, and SP. Redirect the main page to the Overview - Causes access to the main page to be redirected to the Overview. This setting has no effect if "Redirect the main page to the Report Menu" is checked. This feature is only available in Summary Plus, SP Lite, and SP. Custom HTML main page prefix - Extra HTML code that gets added to the main page, below the Summary logo and custom HTML title but above the rest of the page. This feature is only available in Summary Plus, SP Lite, and SP. Custom HTML main page - HTML code to be used instead of the regular body contents of the main page. The regular or custom configured header and footer will appear before and after this code respectively. All of the %%% codes available for use in the header and footer are legal here as well. There is a limit of 4k of text for the custom HTML main page. This feature is only available in Summary Plus, SP Lite, and SP. Here is the default HTML code for the main page:
Disable ReportsThe "Disable Reports" configuration page only appears in Summary Plus, SP Lite, and SP. It is not available in regular copies of Summary. In Summary SP Lite and SP there is a Disable Reports configuration for each sub-report, in addition to the global one. Reports disabled on the global page are disabled in all sub-reports. Reports which are checked here will not appear in the Report Menu, and the corresponding section of the Overview will also disappear. In order for this feature to work you must have a configuration name and password defined. When you are using the configuration name and password you can always see all of the reports regardless of what is set here. Since you must have entered the configuration name and password to access the Disable Reports configuration page you will still be able to see the reports so long as you are in the same browser session. You'll need to exit your browser and start a new browser session where you have not entered that name/password, for the reports to disappear.
Customize E-MailThe "Customize E-Mail" configuration page only appears in Summary SP Lite and SP. It is not available in regular copies of Summary or Summary Plus. E-mail subject - What you enter here will be used as the subject of all e-mails sent by Summary. If you leave this field blank the subject will be "Summary Report". This feature is only available in Summary SP Lite and SP. Custom e-mail header - What you enter here will be placed at the beginning of e-mailed reports. Most of the %%% tags defined for custom HTML work here. You can configure this field globally and on each individual sub-report. The value set in global configuration will be added to each sub-report's email. If you configure it in both places, the global one will be used first followed by the sub-report specific text. This feature is only available in Summary SP Lite and SP. You can use this field to add information about your company or for current events announcements or whatever else you would like. In most cases you will want to end with a blank line which will separate the text that you insert from the report. Include Overview in e-mail - Normally Summary includes a text version of the Overview in the e-mail. You can turn that off here if you just want to send the "Custom e-mail header" you have defined above. This feature is only available in Summary SP Lite and SP.
|
 |
Quick Start |
Overview |
Tutorial |
How To |
Configuration
Javascript Code |
Virtual Domains |
Log Formats |
Custom Overviews
Questions |
Reports |
Purchasing |
FAQ |
Glossary
Copyright 1998-2004 by Summary.Net - Updated 12/3/04