---

Class ::nsmcp::LogCorrelation

::nsmcp::LogCorrelation create ... \
           [ -accessSearches (default "") ] \
           [ -parser (default "::nsmcp::logRecordParser") ] \
           [ -systemSearch:required systemSearch:required ]

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

Class Relations

• class: ::nx::Class
• superclass: ::nsmcp::Object

Methods (to be applied on instances)

• accessFileScan (scripted, public)

   <instance of nsmcp::LogCorrelation> accessFileScan paths \
      directory options redactor [ limits ] [ publish ]

  Scan selected access-log sources for a bounded file summary. Use the configured limits and optional progress callback while retaining source coverage information.

  Parameters:

  paths (required)

  Selected access-log source paths.

  directory (required)

  Private cache or source directory used by the operation.

  options (required)

  Tcl dictionary containing the operation options.

  redactor (required)

  Redactor object applied before returning diagnostic evidence.

  limits (optional)

  Scan resource limits; empty selects the configured defaults.

  publish (optional)

  Optional progress-publication callback.

  Returns:

  The file-summary scan result and continuation information when work remains.

  Testcases:

  No testcase defined.

• accessFileSummary (scripted, public)

   <instance of nsmcp::LogCorrelation> accessFileSummary options \
      redactor [ publish ]

  Summarize access-log files using validated options. Select discovered sources and invoke the bounded file scanner with the requested redactor and progress callback.

  Parameters:

  options (required)

  Tcl dictionary containing the operation options.

  redactor (required)

  Redactor object applied before returning diagnostic evidence.

  publish (optional)

  Optional progress-publication callback.

  Returns:

  The access-file summary result.

  Testcases:

  No testcase defined.

• configureAccessAnalytics (scripted, public)

   <instance of nsmcp::LogCorrelation> configureAccessAnalytics \
      section path

  Configure access analytics for the selected log source. Read the module section and attach the available store-backed analytics implementation.

  Parameters:

  section (required)

  NaviServer module configuration section.

  path (required)

  Configured source or database path.

  Returns:

  The configured analytics setup result.

  Testcases:

  No testcase defined.

• entries (scripted, public)

   <instance of nsmcp::LogCorrelation> entries level [ literal ] \
      [ limit ]

  Search system-log entries by severity and optional literal text. Delegate to the configured system search, retaining its bounded-result and cache semantics.

  Parameters:

  level (required)

  System-log severity name to match.

  literal (optional)

  Literal search text; an empty value disables this additional text filter.

  limit (optional, defaults to "0")

  Maximum number of records or entries to return. Defaults to '0'.

  Returns:

  The search result descriptor.

  Testcases:

  No testcase defined.

• errorSummary (scripted, public)

   <instance of nsmcp::LogCorrelation> errorSummary options \
      redactor

  Summarize system-log errors through the configured search. Delegate to the system search with the caller's options and redaction policy.

  Parameters:

  options (required)

  Tcl dictionary containing the operation options.

  redactor (required)

  Redactor object applied before returning diagnostic evidence.

  Returns:

  The error-summary result.

  Testcases:

  No testcase defined.

• errors (scripted, public)

   <instance of nsmcp::LogCorrelation> errors [ severity ] \
      [ literal ] [ limit ]

  Search retained system-log errors at the requested severity. Use entries with the supplied literal and result bound.

  Parameters:

  severity (optional, defaults to "Error")

  System-log severity name to match. Defaults to 'Error'.

  literal (optional)

  Literal search text; an empty value disables this additional text filter.

  limit (optional, defaults to "0")

  Maximum number of records or entries to return. Defaults to '0'.

  Returns:

  The search result descriptor.

  Testcases:

  No testcase defined.

• requestContext (scripted, public)

   <instance of nsmcp::LogCorrelation> requestContext identifier

  Correlate one complete request identifier across configured logs. Validate the identifier before searching system and access records.

  Parameters:

  identifier (required)

  Complete log-thread identifier, or the raw identifier field when parsing access records.

  Returns:

  The request's bounded correlation evidence.

  Testcases:

  No testcase defined.

• requestContexts (scripted, public)

   <instance of nsmcp::LogCorrelation> requestContexts identifiers \
      [ limit ]

  Correlate a bounded batch of complete request identifiers. Scan each configured file in one forward pass rather than running an independent scan for every identifier. Retain each record's own identifier.

  Parameters:

  identifiers (required)

  One to twenty exact dash-delimited NaviServer log-thread identifiers.

  limit (optional, defaults to "100")

  Maximum number of records or entries to return. Defaults to '100'.

  Returns:

  Combined system/access snapshots with coverage and per-record identifiers.

  Testcases:

  No testcase defined.

• results (scripted, public)

   <instance of nsmcp::LogCorrelation> results handle [ cursor ] \
      [ limit ]

  Retrieve a page from a correlation service's cached searches. Try the configured system and access searches; propagate an unknown-handle error when none owns the result.

  Parameters:

  handle (required)

  Retained job or conversation handle; ownership and expiry checks still apply.

  cursor (optional, defaults to "0")

  Zero-based cursor into retained results. Defaults to '0'.

  limit (optional, defaults to "20")

  Maximum number of records or entries to return. Defaults to '20'.

  Returns:

  The matching cached result page.

  Testcases:

  No testcase defined.

---