Object ::nsmcp::logTools::accessFileSummary (public)

 ::nsmcp::AccessFileSummaryTool ::nsmcp::logTools::accessFileSummary

Defined in /usr/local/ns/tcl/nsmcp/log-traffic-summary.tcl

• ::nsmcp::logTools::accessFileSummary execute /context/ /arguments/
• ::nsmcp::logTools::accessFileSummary validate /arguments/
• ::nsmcp::logTools::accessFileSummary permission
• ::nsmcp::logTools::accessFileSummary name
• ::nsmcp::logTools::accessFileSummary describe

Testcases:

No testcase defined.

Source code:

namespace eval ::nsmcp::logTools {}
::nsf::object::alloc ::nsmcp::AccessFileSummaryTool ::nsmcp::logTools::accessFileSummary {set :adminExample {}
   set :adminSummary {}
   set :description {Scan configured access-log files in a background job, independent of cache retention. Poll log_results with jobHandle until complete; the result is a summary, not record pages. Use pathLiteral ".php" for case-sensitive literal substring matching on the logged queryless path, never query values; no regexp or URL decoding. Defaults to today UTC; set timezone for today/yesterday, or lastMinutes, or explicit from/to. includeRotations defaults true and includes recognized numbered/dated siblings and gzip rotations. ASCII literals use bounded ns_fseekchars candidate searches; Unicode/ANSI cases retain conservative parsing. Stable rotations can be skipped using exhaustive path-filter-specific cached time ranges, never filenames or endpoint samples; unknown/changed/partial ranges are scanned. coverage.rotationsSkippedOutsideWindow and eligibleFilesFullyExamined distinguish verified pruning from missing coverage. Parsing diagnostics in literal mode concern candidates and fallback rows, not every unrelated record. Fixed snapshots, bounded streaming/decompression, file/byte/cardinality limits and changed/unreadable files are reported. Counts use logged request start time, falling back to completion time; end is exclusive. Returns all-match totals before bounded path, method, status, pool, UTC-hour, redacted User-Agent and address-free peer-concentration rankings, authentication states, timing totals and distributed samples including status below 400. maxGroups 1..50 limits rankings, not scanning. Inspect breakdowns capacityOmittedRecords versus rankedOmittedRecords, unknown/truncated User-Agents and distinct-peer lower bounds. Counts are access records, not unique requests/incidents. No user IDs, peer addresses, query strings or caller-supplied filenames are exposed. sourceFullyExamined does not certify full-day retention; windowComplete remains false without verified rotation history.}
   set :inputSchema {{} object {type string object properties object {pathLiteral object {type string string minLength number 1 maxLength number 256 description string {Case-sensitive literal substring in the logged queryless path, at most 256 UTF-8 bytes; no regexp or decoding}} includeRotations object {type string boolean default boolean true} period object {type string string enum array {0 string today 1 string yesterday}} timezone object {type string string} lastMinutes object {type string integer minimum number 1 maximum number 10080} from object {type string integer minimum number 0} to object {type string integer minimum number 1} maxGroups object {type string integer minimum number 1 maximum number 50}} additionalProperties boolean false}}
   set :name access_log_summary
   set :outputSchema {}
   set :permission diagnostics.logs.read
   set :service ::nsmcp::logService}

XQL Not present:

Generic, PostgreSQL, Oracle