The Statistics component returns an XML file of data recorded by the NXT 4 Log service. The Log service provides status and error reporting for components and services.
| Name | Value | Description |
|---|---|---|
| f | Must be "statistics" | |
| fmt | XSL | The type of output. Can be one of the following: XML, XSL. |
| log | * | Comma-delimited list of name-masks describing which logs to include in the output. Each name-mask can include the wildcards * and ?. |
| msg | 0 | If 1, messages are written out with the log. |
| sev | MAX_INT | Severity to use to filter which messages are included in the output |
| ss | statistics.xsl | The name of the XSL stylesheet to use to translate the output. This file must exist in the stylesheets directory specified by the Site Definition File. |
This URL gets the statistics of all builds in the system:
?f=statistics$fmt=XSL$ss=myxsl.xsl$log=build-*
This URL gets statistics on links in XML:
?f=statistics$fmt=XML$log=link*
This URL gets statistics on the build component:
?f=statistics$fmt=XML$log=executive:build
This URL gets statistics on all URL crawlers and ODBC doc-stores:
?f=statistics$fmt=XML$log=build-url:*,build-odbc:*
This URL gets messages for the starwars URL crawl:
?f=statistics$fmt=XML$log=build-url:www.starwars.com$msg=1
The tables below outline the properties that can be requested.
The following table shows the properties for the File Store (Build-FileStore) and URL Crawler (Build-URL):
| Property | Type | Description |
|---|---|---|
| status | hexadecimal number | Status of the last message written to the log service. |
| message-count | integer | Number of messages written to the log. |
| start-time | date-time | Time the last or current build was started. Reported in a date/time format (YYYYMMDDTHHMMSS). |
| stop-time | date-time | Time the last build was completed. Reported in a date/time format (YYYYMMDDTHHMMSS). |
| elapsed-time | integer | Number of seconds the last build took to complete. |
| is-building | integer | Returns a 1 or 0. If a 1 is returned, the build is being processed. If a 0 is returned, no build is in process. |
| error-count | integer | Number of errors in the last build. |
| warning-count | integer | Number of warnings in the last build. |
The following table shows the properties for the ODBC Document Store (Build-ODBC):
| Property | Type | Description |
|---|---|---|
| status | hexadecimal number | Status of the last message written to the log service. |
| message-count | integer | Number of messages written to the log. |
| start-time | date-time | Time the last or current build was started. Reported in a date/time format (YYYYMMDDTHHMMSS). |
| stop-time | date-time | Time the last build was completed. Reported in a date/time format (YYYYMMDDTHHMMSS). |
| elapsed-time | integer | Number of seconds the last build took to complete. |
| is-building | integer | Returns a 1 or 0. If a 1 is returned, the build is being processed. If a 0 is returned, no build is in process. |
| error-count | integer | Number of errors in the last build. |
| warning-count | integer | Number of warnings in the last build. |
| max-connections | integer | Maximum number of connections at any given time. |
| current-connections | integer | Current number of connections. |
| max-build-time | integer | Longest build time. |
| total-builds | integer | Total number of builds. |
| failed-builds | integer | Total number of failed builds. |
| current-builds | integer | Current number of builds in process. |
| doc-request-time | integer | Length of time for the last document request. |
The following table shows the properties for Remote Site View (Link):
| Property | Type | Description |
|---|---|---|
| status | hexadecimal number | Status of the last message written to the log service. If S_OK is returned, the link is active. If anything else is returned, the link is down. |
| message-count | integer | Number of messages written to the log. |
| server | string | Name of the connected server. |
| start-time | date-time | Date and time the link was established. Reported in a date/time format (YYYYMMDDTHHMMSS). |
| timeout-count | integer | Number of times the connection timed out. |
| doc-request | integer | Number of document requests. |
| children-request | integer | Number of times children were requested. |
| query-info-requests | integer | Number of query-info requests. |
| query-requests | integer | Number of query requests. |
| element-requests | integer | Number of element requests. |
| find-node-requests | integer | Number of find-node requests. |
| properties-requests | integer | Number of properties requests. |
| bytes-sent | integer | Total number of bytes sent. |
| bytes-received | integer | Total number of bytes received. |
| doc-request-time | integer | Length of time for the last document request. |
The following table shows the properties for the Executive (Executive):
| Property | Type | Description |
|---|---|---|
| Current Sessions | integer | Current number of allocated concurrent licenses. |
| Max Sessions Reached | integer | Maximum number of concurrent licenses allocated since the server was started. You can use this number to determine whether you are approaching your concurrent user license limit. |
| Total Sessions | integer | Current total of concurrent licenses allocated since the server was started. You can use this number to estimate the total of (not necessarily unique) users that have used the system since it was started. |
| status | hexadecimal number | Status of the last message written to the log service. |
| message-count | integer | Number of messages written to the log. |
| TotalRequests | integer | Total number of requests. |
| CurrentRequests | integer | Current number of requests. |
| TotalTimedOut | integer | Total requests that timed out. |
| TotalFailed | integer | Total requests that failed. |
| MaxTime | integer | Maximum time for a request to process. |
| TotalTime | integer | Total time for requests to process. |
The following table shows the properties for SiteView (SiteView):
| Property | Type | Description |
|---|---|---|
| MaxMemPagesToUse | integer | Maximum number of memory pages the server is configured to use. |
| SaveMaxMemPagesToUse | integer | Maximum number of pages to use when saving changes. (Only applicable to building.) |
| NonCachePageLimit | integer | Maximum number of pages to use for non-cache related material. |
| MaxPagesToCache | integer | Maximum number of pages to cache. |
| SaveMaxPagesToCache | integer | Maximum number of pages for saving to cache. |
| MinPagesToReadCache | integer | Minimum number of pages for the read cache. |
| MaxPagesToWriteCache | integer | Maximum number of pages for the write cache. |
| CurReadCachedPages | integer | Current number of pages in the read cache. |
| CurWriteCachedPages | integer | Current number of pages in the write cache. |
| ReadCacheDiscards | integer | Number of read pages discarded. |
| WriteCacheFlushes | integer | Number of write cache pages flushed. |
| MaxPagesToWriteCache | integer | Maximum number of pages in write cache. |
| CurMemPagesAllocated | integer | Current number of memory pages allocated. |
| CurPagesAllocated | integer | Current total number of pages allocated. |
| PagedPages | integer | Number of pages paged. |
| FCSrvHeapUsageBytes | integer | Number of bytes the server is using. |
| FCSrvHighWaterHeapUsageBytes | integer | Maximum number of bytes the server has used. |
| NfoMgrHeapUsageBytes | integer | Number of bytes the server is using. |
| NfoMgrHighWaterHeapBytes | integer | Maximum number of bytes the server has used. |
Copyright © 2006-2023, Rocket Software, Inc. All rights reserved.