- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables
Class ::nsmcp::LogService
::nsmcp::LogServicecreate ... \
[ -accessScanMaxBytes (default "17179869184") ] \
[ -analytics (default "") ] \
[ -authorizer:required authorizer:required ] \
[ -correlation:required correlation:required ] \
[ -lifetime:integer (default "900") ] \
[ -maxJobs:integer (default "128") ] \
[ -mutex mutex ] \
[ -peerRedactor:required peerRedactor:required ] \
[ -queue:required queue:required ] \
[ -redactor:required redactor:required ] \
[ -store:required store:required ]
Defined in /usr/local/ns/tcl/nsmcp/log-tools.tcl
Class Relations
Methods (to be applied on instances)
accessProgress (scripted, public)
<instance of nsmcp::LogService> accessProgress handle fields
Update retained progress for an access scan. Merge progress fields only while the job handle still exists, under the service mutex.
- Parameters:
- handle (required)
- Retained job or conversation handle; ownership and expiry checks still apply.
- fields (required)
- Dictionary of fields supplied by the callback or progress producer.
- Returns:
- An update result, or an empty result for an expired job.
- Testcases:
- No testcase defined.
poll (scripted, public)
<instance of nsmcp::LogService> poll context handle
Read the status and progress of an owned log job. Check ownership and report explicit coverage and continuation metadata under the service mutex.
- Parameters:
- context (required)
- Authenticated request context carrying the principal, grants and selected server.
- handle (required)
- Retained job or conversation handle; ownership and expiry checks still apply.
- Returns:
- A rooted JSON job-status object.
- Testcases:
- No testcase defined.
resolveWindow (scripted, public)
<instance of nsmcp::LogService> resolveWindow context handle
Resolve a retained job's time bounds for its owner. Validate the caller and locate an owned job under the service mutex rather than accepting browser-supplied bounds.
- Parameters:
- context (required)
- Authenticated request context carrying the principal, grants and selected server.
- handle (required)
- Retained job or conversation handle; ownership and expiry checks still apply.
- Returns:
- The retained window dictionary; unknown or unowned handles raise an error.
- Testcases:
- No testcase defined.
results (scripted, public)
<instance of nsmcp::LogService> results context handle cursor \ limit includePeers
Read an owned log job's bounded result page. Apply pagination and require the additional peer permission when raw peer addresses are requested.
- Parameters:
- context (required)
- Authenticated request context carrying the principal, grants and selected server.
- handle (required)
- Retained job or conversation handle; ownership and expiry checks still apply.
- cursor (required)
- Zero-based cursor into retained results.
- limit (required)
- Maximum number of records or entries to return.
- includePeers (required)
- Whether raw peer addresses are requested; requires the additional peer permission.
- Returns:
- A rooted JSON result-page object.
- Testcases:
- No testcase defined.
run (scripted, public)
<instance of nsmcp::LogService> run handle [ operation ] \ [ identifier ]
Execute a retained diagnostic job slice. Use private job state and preserve its progress or terminal result; compatibility arguments support previously queued callbacks.
- Parameters:
- handle (required)
- Retained job or conversation handle; ownership and expiry checks still apply.
- operation (optional)
- Configured diagnostic operation to run.
- identifier (optional)
- Complete log-thread identifier, or the raw identifier field when parsing access records.
- Returns:
- A worker callback result; published evidence remains in retained job state.
- Testcases:
- No testcase defined.
start (scripted, public)
<instance of nsmcp::LogService> start context operation \ [ identifier ]
Queue an owned diagnostic log operation. Validate the operation and establish its immutable options, limits and job metadata before scheduling work.
- Parameters:
- context (required)
- Authenticated request context carrying the principal, grants and selected server.
- operation (required)
- Configured diagnostic operation to run.
- identifier (optional)
- Complete log-thread identifier, or the raw identifier field when parsing access records.
- Returns:
- A rooted JSON job descriptor.
- Testcases:
- No testcase defined.
- Methods: All Methods Documented Methods Hide Methods
- Source: Display Source Hide Source
- Variables: Show Variables Hide Variables
![[i]](/resources/acs-subsite/ZoomIn16.gif)