::nsmcp::Object ::nsmcp::Object dict getdef ::nx::Object ::nx::Object __default_accessor __default_method_call_protection __object_configureparameter __resolve_method_path contains copy delete object method delete object property delete object variable destroy_on_cleanup info consts info info info lookup parameters info lookup slots info lookup syntax info lookup variables info object method args info object method body info object method callprotection info object method debug info object method definition info object method definitionhandle info object method deprecated info object method exists info object method handle info object method origin info object method parameters info object method registrationhandle info object method returns info object method submethods info object method syntax info object method type info object slots info object variables info variable definition info variable name info variable parameter move object alias object forward object method object property object variable private protected public qn require namespace require object method require private object method require protected object method require public object method serialize ::nsmcp::Object->::nx::Object ::nsmcp::LogRedactor ::nsmcp::LogRedactor identifiers message page queryValues record sensitive ::nsmcp::LogRedactor->::nsmcp::Object

Class ::nsmcp::LogRedactor

::nsmcp::LogRedactor[i] create ... \
           [ -headerNames (default "authorization proxy-authorization cookie set-cookie x-api-key") ] \
           [ -maskPeerAddresses:boolean (default "true") ] \
           [ -maskUserIdentifiers:boolean (default "true") ] \
           [ -queryParameters (default "__csrf_token csrf_token token access_token refresh_token id_token password passwd secret api_key apikey") ] \
           [ -replacement (default "[REDACTED]") ]
Defined in /usr/local/ns/tcl/nsmcp/log-redaction.tcl

Class Relations

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

Methods (to be applied on instances)

  • message (scripted, public)

     <instance of nsmcp::LogRedactor[i]> message text

    Redact sensitive values in a log message. Apply configured header and token policies line by line before returning diagnostic evidence.

    Parameters:
    text (required)
    Text to inspect or redact.
    Returns:
    The redacted message text.

    Testcases:
    No testcase defined.

  • page (scripted, public)

     <instance of nsmcp::LogRedactor[i]> page page

    Redact every record in a result page. Retain pagination and coverage metadata while replacing its records with redacted copies.

    Parameters:
    page (required)
    Result-page dictionary containing records and coverage metadata.
    Returns:
    The redacted page dictionary.

    Testcases:
    No testcase defined.

  • queryValues (scripted, public)

     <instance of nsmcp::LogRedactor[i]> queryValues text

    Redact sensitive query-parameter values in text. Decode names for policy matching while retaining the original URL spelling and avoiding value decoding.

    Parameters:
    text (required)
    Text to inspect or redact.
    Returns:
    Text with matching query values redacted.

    Testcases:
    No testcase defined.

  • record (scripted, public)

     <instance of nsmcp::LogRedactor[i]> record entry

    Redact one structured log record. Redact supported message and metadata fields and retain the record's redaction indicators.

    Parameters:
    entry (required)
    Structured log-record dictionary.
    Returns:
    The redacted record dictionary.

    Testcases:
    No testcase defined.