::nsmcp::CachedLogSearch ::nsmcp::CachedLogSearch encodeEvent errorSummary flush init lineStart physicalLine record recordStart removeQueries results search temporaryFile ::nsmcp::FileLogSource ::nsmcp::FileLogSource appendText consume emptyState init joinLine read ::nsmcp::CachedLogSearch->::nsmcp::FileLogSource ::nsmcp::LogSource ::nsmcp::LogSource read ::nsmcp::FileLogSource->::nsmcp::LogSource ::nsmcp::Object ::nsmcp::Object ::nsmcp::LogSource->::nsmcp::Object

Class ::nsmcp::CachedLogSearch

::nsmcp::CachedLogSearch[i] create ... \
           [ -cacheDirectory:required cacheDirectory:required ] \
           [ -cacheKey cacheKey ] \
           [ -maxCacheBytes:integer (default "67108864") ] \
           [ -maxEvents:integer (default "1000") ] \
           [ -maxMatchesPerCall:integer (default "1000") ] \
           [ -maxMessageBytes:integer (default "65536") ] \
           [ -maxReadBytes:integer (default "1048576") ] \
           [ -maxSearches:integer (default "16") ] \
           [ -mutex (default "") ] \
           [ -path:required path:required ] \
           [ -recordParser (default "::nsmcp::logRecordParser") ] \
           [ -store:required store:required ]
Defined in /usr/local/ns/tcl/nsmcp/log-summary.tcl

Class Relations

  • class: ::nx::Class[i]
  • superclass: ::nsmcp::FileLogSource[i]

Methods (to be applied on instances)

  • errorSummary (scripted, public)

     <instance of nsmcp::CachedLogSearch[i]> errorSummary options \
    redactor

    Aggregate errors from the configured system-log source. Apply bounded scanning and redaction, retaining resumable state when a scan slice cannot finish.

    Parameters:
    options (required)
    Tcl dictionary containing the operation options.
    redactor (required)
    Redactor object applied before returning diagnostic evidence.
    Returns:
    The error-summary result with continuation state when needed.

    Testcases:
    No testcase defined.

  • flush (scripted, public)

     <instance of nsmcp::CachedLogSearch[i]> flush

    Discard cached search state for this log source. Serialize the update and clean up retained result resources owned by the source.

    Returns:
    The cache cleanup result.

    Testcases:
    No testcase defined.

  • results (scripted, public)

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

    Retrieve a bounded page from an unexpired cached search. Validate the handle and page bounds under the mutex and retain coverage and truncation metadata.

    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 cached page dictionary.

    Testcases:
    No testcase defined.

  • search (scripted, public)

     <instance of nsmcp::CachedLogSearch[i]> search literal [ severity ] \
    [ correlationField ] [ maxResults ]

    Search raw records for literal text or exact request identifiers. Use one literal key for ordinary searches or a bounded identifier batch for the systemMany/accessMany correlation modes. Retain partial-scan and result-limit evidence.

    Parameters:
    literal (required)
    Literal search text; an empty value disables this additional text filter.
    severity (optional)
    System-log severity name to match.
    correlationField (optional)
    Exact header-field correlation mode, including systemMany/accessMany batches.
    maxResults (optional, defaults to "0")
    Retained record cap; zero keeps the legacy slice behavior. Defaults to '0'.
    Returns:
    The cached snapshot with explicit partial-scan and result-limit flags.

    Testcases:
    No testcase defined.