::nsmcp::AccessDiagnosticTool![[i]](/resources/acs-subsite/ZoomIn16.gif)
create ... \
[ -adminExample (default "") ] \
[ -adminSummary (default "") ] \
[ -authorizer:required authorizer:required ] \
[ -defaultMode (default "scan") ] \
[ -description:required description:required ] \
[ -inputSchema (default "
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"scan",
"page"
],
"description": "Bot routing: aggregateTraffic true adds address-free source concentration and User-Agent rankings; path selects an exact queryless path. scan aggregates all pages in a background job, polled with log_results. page returns one bounded byte page. Slow requests remain paged."
},
"authenticationState": {
"type": "string",
"enum": [
"anonymous",
"authenticated",
"unknown"
],
"description": "Filter by logged authentication state; no identity is disclosed."
},
"aggregateTraffic": {
"type": "boolean",
"default": false,
"description": "Scan mode only: address-free source concentration and User-Agent rankings over all selected records, independent of evidence limits. No peer-disclosure permission required."
},
"path": {
"type": "string",
"description": "Exact queryless path, e.g. /bugtracker/openacs/"
},
"scanStrategy": {
"type": "string",
"enum": [
"window",
"full"
],
"default": "window",
"description": "Background scans: window seeks by completion timestamps with a 300s margin and explicit ordering assumptions; full examines the entire current file."
},
"lastMinutes": {
"type": "integer",
"minimum": 1,
"maximum": 1440,
"default": 60
},
"from": {
"type": "number"
},
"to": {
"type": "number"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 20
},
"pool": {
"type": "string",
"default": "bots"
},
"module": {
"type": "string",
"default": "nslog"
},
"category": {
"type": "string",
"enum": [
"matching-rule-in-target",
"matching-rule-other-pool-candidate",
"bot-like-unmatched-heuristic",
"no-target-rule-match",
"unknown",
"native-target-in-target",
"native-target-other-pool-candidate",
"bot-like-routed-elsewhere-heuristic",
"native-other-pool"
],
"description": "Bot routing only: retain evidence for this exact category. categoryTotals still covers all matching records; selectedMatches and filteredOutRecords distinguish selection from omitted evidence."
},
"includePeerAddresses": {
"type": "boolean",
"default": false
},
"beforeOffset": {
"type": "integer",
"minimum": 0
},
"sourceBytes": {
"type": "integer",
"minimum": 0
},
"sourceIdentity": {
"type": "string"
},
"mappingIdentity": {
"type": "string"
}
},
"additionalProperties": false
}
") ] \
[ -maxAggregateSources:integer (default "100000") ] \
[ -maxAggregateUserAgents:integer (default "4096") ] \
[ -maxReadBytes:integer (default "4194304") ] \
[ -name:required name:required ] \
[ -operation (default "bot") ] \
[ -outputSchema (default "") ] \
[ -peerRedactor:required peerRedactor:required ] \
[ -permission (default "diagnostics.logs.read") ] \
[ -redactor:required redactor:required ] \
[ -routing:required routing:required ] \
[ -seekMinimumBytes:integer (default "8388608") ] \
[ -service (default "") ]
Defined in /usr/local/ns/tcl/nsmcp/traffic-tools.tclClass Relations
- class: ::nx::Class
- superclass: ::nsmcp::Tool
Methods (to be applied on instances)
classify (scripted, public)
<instance of nsmcp::AccessDiagnosticTool> classify record maps \
target
- Parameters:
- record (required)
- maps (required)
- target (required)
- Testcases:
-
No testcase defined.
<instance of nsmcp::AccessDiagnosticTool> contextComplete record \
snapshot
- Parameters:
- record (required)
- snapshot (required)
- Testcases:
-
No testcase defined.
execute (scripted, public)
<instance of nsmcp::AccessDiagnosticTool> execute context \
arguments
- Parameters:
- context (required)
- arguments (required)
- Testcases:
-
No testcase defined.
<instance of nsmcp::AccessDiagnosticTool> nativeClassify server \
record snapshot target
- Parameters:
- server (required)
- record (required)
- snapshot (required)
- target (required)
- Testcases:
-
No testcase defined.
page (scripted, public)
<instance of nsmcp::AccessDiagnosticTool> page context arguments \
[ floor ] [ aggregationVar ]
- Parameters:
- context (required)
- arguments (required)
- floor (optional, defaults to
"0")
- aggregationVar (optional)
- Testcases:
-
No testcase defined.
scanStep (scripted, public)
<instance of nsmcp::AccessDiagnosticTool> scanStep context state
- Parameters:
- context (required)
- state (required)
- Testcases:
-
No testcase defined.
validate (scripted, public)
<instance of nsmcp::AccessDiagnosticTool> validate arguments
- Parameters:
- arguments (required)
- Testcases:
-
No testcase defined.
