Object ::nsmcp::accessSummary (public)

 ::nsmcp::AccessSummaryTool ::nsmcp::accessSummary

Defined in /usr/local/ns/tcl/nsmcp/access-tools.tcl

• ::nsmcp::accessSummary options /arguments/
• ::nsmcp::accessSummary validate /arguments/
• ::nsmcp::accessSummary execute /context/ /arguments/
• ::nsmcp::accessSummary permission
• ::nsmcp::accessSummary name
• ::nsmcp::accessSummary describe

Testcases:

No testcase defined.

Source code:

namespace eval ::nsmcp {}
::nsf::object::alloc ::nsmcp::AccessSummaryTool ::nsmcp::accessSummary {set :adminExample {}
   set :adminSummary {}
   set :analytics ::nsmcp::accessAnalytics
   set :description {Start an incremental access-log summary; poll log_results with jobHandle. Defaults to the last 60 completed minutes. Use lastMinutes or period previous-hour for relative intervals, or reuse windowHandle to freeze bounds across comparisons. Time selectors are mutually exclusive; explicit from/to remain supported. Counts use request start times when available. Sub-minute bucketSeconds (1, 5, 10, 15, 30) supports peak analysis, with at most 3600 buckets. Sub-minute windows round outwards to bucket boundaries; other windows round to minutes. Counts are observed retained-cache traffic, not certified full-log totals; coverage reports recent-scan progress, historical backfill, completion-order assumptions, and possible rotation gaps. Reports authenticationStates aggregates derived from the logged user field (0 or - anonymous, other nonempty identities authenticated; old cache rows unknown). Does not disclose user identities. Supports authenticationState, exact path, status and pool filters and timing breakdowns by status. Coverage separates live-tail lag, historical backfill, cumulative parsing failures and outward bucket rounding; do not treat the rounded future minute as ingestion lag. Optional windowSeconds finds the maximum requests from one logged peer in a rolling inclusive window within the selected period; default 600 seconds. Peer addresses are retained internally; peer filtering and disclosure require diagnostics.logs.peers.read. Existing cache rows may lack peers; inspect unknownPeerCount, observedPeerCountsComplete, peerCountsComplete and peerCountsIncompleteReasons. Observed peer fields can be complete while the requested log window is incomplete; peerCountsIncompleteReasons explains both. Top paths omit queries and may be incomplete when cardinality limits are reached.}
   set :inputSchema {{} object {type string object properties object {lastMinutes object {type string integer minimum number 1 maximum number 1440 description string {Trailing minutes ending at the last completed minute; default 60}} period object {type string string enum array {0 string previous-hour} description string {Previous complete UTC clock hour}} windowHandle object {type string string description string {Reuse bounds returned by an earlier summary; owned by this principal and server}} from object {type string integer description string {Unix epoch seconds; explicit interval start}} to object {type string integer description string {Unix epoch seconds; explicit interval end}} authenticationState object {type string string enum array {0 string anonymous 1 string authenticated 2 string unknown}} path object {type string string description string {Exact queryless path}} peer object {type string string description string {Exact logged IP address; requires peer permission}} windowSeconds object {type string integer minimum number 0 maximum number 3600 description string {Rolling peer burst duration, defaults to 600; inclusive endpoints. Use 0 to skip peer-burst calculation for traffic-only analysis.}} includePeerAddresses object {type string boolean description string {Disclose the burst peer; requires peer permission}} pool object {type string string description string {Exact connection pool}} status object {type string integer minimum number 100 maximum number 599 description string {HTTP status}} bucketSeconds object {type string integer minimum number 1 maximum number 3600 description string {1, 5, 10, 15, 30, or a multiple of 60; at most 3600 buckets}}} additionalProperties boolean false}}
   set :name access_summary
   set :outputSchema {}
   set :permission diagnostics.logs.read
   set :service ::nsmcp::logService}

XQL Not present:

Generic, PostgreSQL, Oracle