---

Class ::nsmcp::AccessSummaryTool

::nsmcp::AccessSummaryTool create ... \
           [ -analytics:required analytics:required ] \
           [ -description (default "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. Windows are rounded outwards to minutes; coverage reports recent-scan progress, historical backfill, completion-order assumptions, and possible rotation gaps. Supports 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 and peerCountsComplete. Top paths omit queries and may be incomplete when cardinality limits are reached.") ] \
           [ -inputSchema (default "{} 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}}
        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 1 maximum number 3600 description string {Rolling peer burst duration, defaults to 600; inclusive endpoints}}
        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 60 maximum number 3600 multipleOf number 60}
    } additionalProperties boolean false}") ] \
           [ -name (default "access_summary") ] \
           [ -outputSchema (default "") ] \
           [ -permission (default "diagnostics.logs.read") ] \
           [ -service:required service:required ]

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

Class Relations

• class: ::nx::Class
• superclass: ::nsmcp::Tool

Methods (to be applied on instances)

• execute (scripted, public)

   <instance of nsmcp::AccessSummaryTool> execute context arguments

  Parameters:

  context (required)

  arguments (required)

  Testcases:

  No testcase defined.

• options (scripted, public)

   <instance of nsmcp::AccessSummaryTool> options arguments

  Parameters:

  arguments (required)

  Testcases:

  No testcase defined.

• validate (scripted, public)

   <instance of nsmcp::AccessSummaryTool> validate arguments

  Parameters:

  arguments (required)

  Testcases:

  No testcase defined.

---