Class ::nsmcp::UnifiedAccessAnalytics

::nsmcp::UnifiedAccessAnalytics[i] create ... \
           [ -database:required database:required ] \
           [ -evictionLimit:integer (default "64") ] \
           [ -ingestBytes:integer (default "16777216") ] \
           [ -ingestMilliseconds:integer (default "2000") ] \
           [ -legacyDatabase (default "") ] \
           [ -maxLineBytes:integer (default "65536") ] \
           [ -maxReadBytes:integer (default "16777216") ] \
           [ -maxRows:integer (default "2000000") ] \
           [ -maxSeconds:integer (default "2") ] \
           [ -mutex (default "") ] \
           [ -parser (default "::nsmcp::accessRecordParser") ] \
           [ -path:required path:required ] \
           [ -retentionBatchRows:integer (default "1000") ] \
           [ -retentionInterval (default "30") ] \
           [ -retentionMilliseconds:integer (default "1000") ] \
           [ -retentionSeconds:double (default "86400") ] \
           [ -settings:required settings:required ] \
           [ -sourceReady (default "false") ]

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

Class Relations

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

Methods (to be applied on instances)

  • correlateWarnings (scripted, public)

     <instance of nsmcp::UnifiedAccessAnalytics[i]> correlateWarnings \
        samples redactor

    Correlate warnings with unified stored requests. Delegate through bounded store retry while preserving the caller's sample list and redactor.

    Parameters:
    samples (required)
    Bounded warning sample records to correlate with retained access evidence.
    redactor (required)
    Redactor object applied before returning diagnostic evidence.
    Returns:
    The warning correlation evidence.

    Testcases:
    No testcase defined.
  • ingest (scripted, public)

     <instance of nsmcp::UnifiedAccessAnalytics[i]> ingest [ from ] \
        [ allowHistory ]

    Provide the compatibility entry point for an administrative refresh. Legacy range arguments remain accepted; the unified ingestor controls its live and historical work through refresh.

    Parameters:
    from (optional)
    Starting timestamp or byte position, as required by the operation.
    allowHistory (optional, defaults to "true")
    Whether this pass may process historical sources. Defaults to 'true'.
    Returns:
    The bounded refresh result.

    Testcases:
    No testcase defined.
  • ingestionStatus (scripted, public)

     <instance of nsmcp::UnifiedAccessAnalytics[i]> ingestionStatus

    Read current and last-run ingestion progress. Use the retained ingestion status instead of triggering a scan or ingestion pass.

    Returns:
    The ingestion status dictionary.

    Testcases:
    No testcase defined.
  • refresh (scripted, public)

     <instance of nsmcp::UnifiedAccessAnalytics[i]> refresh

    Run a bounded unified ingestion pass under the writer gate. Reject overlapping writers, publish phase and commit statistics, and always finish the run token before releasing the gate.

    Returns:
    The ingestion result, or a busy dictionary when another writer owns the gate.

    Testcases:
    No testcase defined.
  • retain (scripted, public)

     <instance of nsmcp::UnifiedAccessAnalytics[i]> retain

    Perform bounded retention maintenance under the writer gate. Avoid overlapping ingestion while pruning expired store state and retaining maintenance statistics.

    Returns:
    The retention result, including a busy indication when the gate is occupied.

    Testcases:
    No testcase defined.
  • retentionStatus (scripted, public)

     <instance of nsmcp::UnifiedAccessAnalytics[i]> retentionStatus

    Read current retention-maintenance status. Return retained maintenance observations without starting another pruning pass.

    Returns:
    The retention status dictionary.

    Testcases:
    No testcase defined.
  • retentionTick (scripted, public)

     <instance of nsmcp::UnifiedAccessAnalytics[i]> retentionTick

    Run and reschedule one retention-maintenance callback. Use a one-shot scheduling chain so maintenance retries do not phase-lock with the ingestion timer.

    Returns:
    The scheduler callback result.

    Testcases:
    No testcase defined.
  • summary (scripted, public)

     <instance of nsmcp::UnifiedAccessAnalytics[i]> summary options

    Query unified access summaries with bounded lock retry. Delegate to the superclass using the same normalized options after eligible transient store failures.

    Parameters:
    options (required)
    Tcl dictionary containing the operation options.
    Returns:
    The access summary dictionary.

    Testcases:
    No testcase defined.